psyclone.domain.gocean

Module for the GOcean domain.

Submodules

• psyclone.domain.gocean.go_symbol_table
• psyclone.domain.gocean.gocean_constants
  • Classes
    • GOceanConstants
      • GOceanConstants.get_valid_access_types()
• psyclone.domain.gocean.gocean_driver_creator
• psyclone.domain.gocean.kernel
  • Submodules
    • psyclone.domain.gocean.kernel.psyir
      • Classes
        • GOceanContainer
          • GOceanContainer.create()
          • GOceanContainer.lower_to_language_level()
          • GOceanContainer.metadata
        • GOceanKernelMetadata
          • GOceanKernelMetadata.FieldArg
            • GOceanKernelMetadata.FieldArg.access
            • GOceanKernelMetadata.FieldArg.form
            • GOceanKernelMetadata.FieldArg.fortran_string()
            • GOceanKernelMetadata.FieldArg.grid_point_type
            • GOceanKernelMetadata.FieldArg.stencil
          • GOceanKernelMetadata.GridArg
            • GOceanKernelMetadata.GridArg.access
            • GOceanKernelMetadata.GridArg.fortran_string()
            • GOceanKernelMetadata.GridArg.name
          • GOceanKernelMetadata.ScalarArg
            • GOceanKernelMetadata.ScalarArg.access
            • GOceanKernelMetadata.ScalarArg.datatype
            • GOceanKernelMetadata.ScalarArg.form
            • GOceanKernelMetadata.ScalarArg.fortran_string()
          • GOceanKernelMetadata.create_from_fortran_string()
          • GOceanKernelMetadata.create_from_psyir()
          • GOceanKernelMetadata.fortran_string()
          • GOceanKernelMetadata.index_offset
          • GOceanKernelMetadata.iterates_over
          • GOceanKernelMetadata.lower_to_psyir()
          • GOceanKernelMetadata.meta_args
          • GOceanKernelMetadata.name
          • GOceanKernelMetadata.procedure_name
  • Classes
    • GOceanKernelMetadata
      • GOceanKernelMetadata.FieldArg
        • GOceanKernelMetadata.FieldArg.access
        • GOceanKernelMetadata.FieldArg.form
        • GOceanKernelMetadata.FieldArg.fortran_string()
        • GOceanKernelMetadata.FieldArg.grid_point_type
        • GOceanKernelMetadata.FieldArg.stencil
      • GOceanKernelMetadata.GridArg
        • GOceanKernelMetadata.GridArg.access
        • GOceanKernelMetadata.GridArg.fortran_string()
        • GOceanKernelMetadata.GridArg.name
      • GOceanKernelMetadata.ScalarArg
        • GOceanKernelMetadata.ScalarArg.access
        • GOceanKernelMetadata.ScalarArg.datatype
        • GOceanKernelMetadata.ScalarArg.form
        • GOceanKernelMetadata.ScalarArg.fortran_string()
      • GOceanKernelMetadata.create_from_fortran_string()
      • GOceanKernelMetadata.create_from_psyir()
      • GOceanKernelMetadata.fortran_string()
      • GOceanKernelMetadata.index_offset
      • GOceanKernelMetadata.iterates_over
      • GOceanKernelMetadata.lower_to_psyir()
      • GOceanKernelMetadata.meta_args
      • GOceanKernelMetadata.name
      • GOceanKernelMetadata.procedure_name
• psyclone.domain.gocean.transformations
  • Submodules
    • psyclone.domain.gocean.transformations.gocean_alg_invoke_2_psy_call_trans
    • psyclone.domain.gocean.transformations.gocean_const_loop_bounds_trans
    • psyclone.domain.gocean.transformations.gocean_extract_trans
    • psyclone.domain.gocean.transformations.gocean_loop_fuse_trans
      • Classes
        • GOceanLoopFuseTrans
          • GOceanLoopFuseTrans.validate()
    • psyclone.domain.gocean.transformations.gocean_move_iteration_boundaries_inside_kernel_trans
      • Classes
        • GOMoveIterationBoundariesInsideKernelTrans
          • GOMoveIterationBoundariesInsideKernelTrans.apply()
          • GOMoveIterationBoundariesInsideKernelTrans.name
          • GOMoveIterationBoundariesInsideKernelTrans.validate()
    • psyclone.domain.gocean.transformations.gocean_opencl_trans
      • Classes
        • GOOpenCLTrans
          • GOOpenCLTrans.apply()
          • GOOpenCLTrans.name
          • GOOpenCLTrans.validate()
    • psyclone.domain.gocean.transformations.raise_psyir_2_gocean_kern_trans
      • Functions
        • find_symbol()
      • Classes
        • RaisePSyIR2GOceanKernTrans
          • RaisePSyIR2GOceanKernTrans.apply()
          • RaisePSyIR2GOceanKernTrans.validate()

Classes

• GOceanConstants: This class stores all GOcean constants. It stores all values in

• GOceanDriverCreator: This class provides the functionality to create a driver that

• GOSymbolTable: Sub-classes SymbolTable to provide a GOcean-specific implementation.

class psyclone.domain.gocean.GOceanConstants

This class stores all GOcean constants. It stores all values in class variables (to avoid re-evaluating them).

Inheritance

static get_valid_access_types()

Return the valid access types for the GOcean API. Reads the values from the config file the first time the method is called.

Returns:

valid access types for the GOcean API.

Return type:

list[str]

class psyclone.domain.gocean.GOceanDriverCreator(integer_type=<psyclone.psyir.symbols.datatypes.ScalarType object>, real_type=<psyclone.psyir.symbols.datatypes.ScalarType object>, region_name=None)

This class provides the functionality to create a driver that reads in extracted data produced by using the PSyData kernel-extraction functionality.

Parameters:

• integer_type (ScalarType) – default scalar integer type to be used for integer variables. Defaults to INTEGER_TYPE.

• real_type (ScalarType) – default scalar real type to be used for real variables. Defaults to REAL8_TYPE.

• region_name (Optional[tuple[str, str]]) – Suggested region name.

Inheritance

handle_precision_symbols(symbol_table)

Replaces the precisions with the values given in the _default_types in order to avoid imported precision symbols.

Parameters:

program – the PSyIR Routine in which to replace the symbols.

Return type:

None

class psyclone.domain.gocean.GOSymbolTable(node=None, default_visibility=Visibility.PUBLIC)

Sub-classes SymbolTable to provide a GOcean-specific implementation.

Inheritance

static create_from_table(old_table)

Create a GOSymbolTable instance from the supplied SymbolTable.

Parameters:

old_table (psyclone.psyir.symbols.SymbolTable) – the generic SymbolTable from which to create a new GOSymbolTable.

Returns:

a new GOSymbolTable containing all of the symbols in the supplied table.

Return type:

psyclone.gocean1p0.GOSymbolTable

Raises:

TypeError – if the supplied argument is not a SymbolTable.

property data_arguments

In the GOcean API the data arguments start from the third item in the argument list.

Returns:

the symbols representing the data arguments.

Return type:

List[psyclone.psyir.symbols.DataSymbol]

property iteration_indices

In the GOcean API the two first kernel arguments are the iteration indices.

Returns:

the symbols representing the iteration indices.

Return type:

List[psyclone.psyir.symbols.DataSymbol]