Inheritance diagram for psyclone.gocean1p0.GOKern:

[legend]

Collaboration diagram for psyclone.gocean1p0.GOKern:

[legend]

Public Member Functions
def	__init__ (self, call, parent=None)

def	reference_accesses (self, var_accesses)

def	local_vars (self)

def	index_offset (self)

def	get_kernel_schedule (self)

Public Member Functions inherited from psyclone.psyGen.CodedKern
def	__init__ (self, KernelArguments, call, parent=None, check=True)

def	opencl_options (self)

def	set_opencl_options (self, options)

def	__str__ (self)

def	module_name (self)

def	dag_name (self)

def	module_inline (self)

def	module_inline (self, value)

def	node_str (self, colour=True)

def	lower_to_language_level (self)

def	incremented_arg (self)

def	ast (self)

def	rename_and_write (self)

def	modified (self)

def	modified (self, value)

Public Member Functions inherited from psyclone.psyGen.Kern
def	__init__ (self, parent, call, name, ArgumentsClass, check=True)

def	args (self)

def	is_reduction (self)

def	reduction_arg (self)

def	reprod_reduction (self)

def	local_reduction_name (self)

def	zero_reduction_variable (self, parent, position=None)

def	reduction_sum_loop (self, parent)

def	arg_descriptors (self)

def	arg_descriptors (self, obj)

def	arguments (self)

def	name (self)

def	name (self, value)

def	is_coloured (self)

def	iterates_over (self)

def	gen_code (self, parent)

Additional Inherited Members
Public Attributes inherited from psyclone.psyGen.CodedKern
	arg_descriptors

	modified

	name

Detailed Description

Stores information about GOcean Kernels as specified by the Kernel
metadata. Uses this information to generate appropriate PSy layer
code for the Kernel instance. Specialises the gen_code method to
create the appropriate GOcean specific kernel call.

:param call: information on the way in which this kernel is called \
             from the Algorithm layer.
:type call: :py:class:`psyclone.parse.algorithm.KernelCall`
:param parent: optional node where the kernel call will be inserted.
:type parent: :py:class:`psyclone.psyir.nodes.Node`

Definition at line 1071 of file gocean1p0.py.

Member Function Documentation

◆ get_kernel_schedule()

def psyclone.gocean1p0.GOKern.get_kernel_schedule ( self )

:returns: a schedule representing the GOcean kernel code.
:rtype: :py:class:`psyclone.gocean1p0.GOKernelSchedule`

:raises GenerationError: if there is a problem raising the language- \
                         level PSyIR of this kernel to GOcean PSyIR.

Reimplemented from psyclone.psyGen.CodedKern.

Definition at line 1228 of file gocean1p0.py.

     def get_kernel_schedule(self):
         '''
         :returns: a schedule representing the GOcean kernel code.
         :rtype: :py:class:`psyclone.gocean1p0.GOKernelSchedule`
  
         :raises GenerationError: if there is a problem raising the language- \
                                  level PSyIR of this kernel to GOcean PSyIR.
         '''
         if self._kern_schedule:
             return self._kern_schedule
  
         # Construct the PSyIR of the Fortran parse tree.
         astp = Fparser2Reader()
         psyir = astp.generate_psyir(self.ast)
         # pylint: disable=import-outside-toplevel
         from psyclone.domain.gocean.transformations import (
             RaisePSyIR2GOceanKernTrans)
         raise_trans = RaisePSyIR2GOceanKernTrans(self._metadata_name)
         try:
             raise_trans.apply(psyir)
         except Exception as err:
             raise GenerationError(
                 f"Failed to raise the PSyIR for kernel '{self.name}' "
                 f"to GOcean PSyIR. Error was:\n{err}") from err
         for routine in psyir.walk(Routine):
             if routine.name == self.name:
                 break
         # We know the above loop will find the named routine because the
         # previous raising transformation would have failed otherwise.
         # pylint: disable=undefined-loop-variable
         self._kern_schedule = routine
  
         return self._kern_schedule
  
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index_offset()

def psyclone.gocean1p0.GOKern.index_offset ( self )

 The grid index-offset convention that this kernel expects

Definition at line 1224 of file gocean1p0.py.

     def index_offset(self):
         ''' The grid index-offset convention that this kernel expects '''
         return self._index_offset
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._index_offset, psyclone.gocean1p0.GOKern._index_offset, and psyclone.gocean1p0.GOKernelType1p0._index_offset.

Here is the caller graph for this function:

◆ local_vars()

def psyclone.gocean1p0.GOKern.local_vars ( self )

Return a list of the variable (names) that are local to this loop
(and must therefore be e.g. threadprivate if doing OpenMP)

Reimplemented from psyclone.psyGen.Kern.

Definition at line 1216 of file gocean1p0.py.

     def local_vars(self):
         '''Return a list of the variable (names) that are local to this loop
         (and must therefore be e.g. threadprivate if doing OpenMP)
  
         '''
         return []
  

◆ reference_accesses()

def psyclone.gocean1p0.GOKern.reference_accesses	(	self,
		var_accesses
	)

Get all variable access information. All accesses are marked
according to the kernel metadata.

:param var_accesses: VariablesAccessInfo instance that stores the\
    information about variable accesses.
:type var_accesses: \
    :py:class:`psyclone.core.VariablesAccessInfo`

Reimplemented from psyclone.psyGen.Kern.

Definition at line 1170 of file gocean1p0.py.

     def reference_accesses(self, var_accesses):
         '''Get all variable access information. All accesses are marked
         according to the kernel metadata.
  
         :param var_accesses: VariablesAccessInfo instance that stores the\
             information about variable accesses.
         :type var_accesses: \
             :py:class:`psyclone.core.VariablesAccessInfo`
  
         '''
         # Grid properties are accessed using one of the fields. This stores
         # the field used to avoid repeatedly determining the best field:
         field_for_grid_property = None
         for arg in self.arguments.args:
             if arg.argument_type == "grid_property":
                 if not field_for_grid_property:
                     field_for_grid_property = \
                         self._arguments.find_grid_access()
                 var_name = arg.dereference(field_for_grid_property.name)
             else:
                 var_name = arg.name
  
             signature = Signature(var_name.split("%"))
             if arg.is_scalar:
                 # The argument is only a variable if it is not a constant:
                 if not arg.is_literal:
                     var_accesses.add_access(signature, arg.access, self)
             else:
                 if arg.argument_type == "field":
                     # Now add 'artificial' accesses to this field depending
                     # on meta-data (access-mode and stencil information):
                     self._record_stencil_accesses(signature, arg,
                                                   var_accesses)
                 else:
                     # In case of an array for now add an arbitrary array
                     # reference to (i,j) so it is properly recognised as
                     # an array access.
                     sym_tab = self.ancestor(GOInvokeSchedule).symbol_table
                     symbol_i = sym_tab.lookup_with_tag("contiguous_kidx")
                     symbol_j = sym_tab.lookup_with_tag("noncontiguous_kidx")
                     var_accesses.add_access(signature, arg.access,
                                             self, [Reference(symbol_i),
                                                    Reference(symbol_j)])
         super().reference_accesses(var_accesses)
         var_accesses.next_location()
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._arguments, psyclone.psyGen.Kern._arguments, psyclone.psyGen.InlinedKern._arguments, psyclone.gocean1p0.GOKern._record_stencil_accesses(), psyclone.psyir.nodes.node.Node.ancestor(), psyclone.psyGen.Kern.arguments(), and psyclone.psyir.nodes.call.Call.arguments().

Here is the call graph for this function:

Here is the caller graph for this function:

The documentation for this class was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/gocean1p0.py

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_kernel_schedule()

◆ index_offset()

◆ local_vars()

◆ reference_accesses()