Inheritance diagram for psyclone.gocean1p0.GOInvoke:

Collaboration diagram for psyclone.gocean1p0.GOInvoke:

Public Member Functions
def	__init__ (self, alg_invocation, idx, invokes)

def	unique_args_arrays (self)

def	unique_args_iscalars (self)

def	gen_code (self, parent)

Public Member Functions inherited from psyclone.psyGen.Invoke
def	__init__ (self, alg_invocation, idx, schedule_class, invokes, reserved_names=None)

def	__str__ (self)

def	invokes (self)

def	name (self)

def	alg_unique_args (self)

def	psy_unique_vars (self)

def	psy_unique_var_names (self)

def	schedule (self)

def	schedule (self, obj)

def	unique_declarations (self, argument_types, access=None, intrinsic_type=None)

def	first_access (self, arg_name)

def	unique_declns_by_intent (self, argument_types, intrinsic_type=None)

def	gen (self)

Detailed Description

The GOcean specific invoke class. This passes the GOcean specific
schedule class to the base class so it creates the one we require.
A set of GOcean infrastructure reserved names are also passed to
ensure that there are no name clashes. Also overrides the gen_code
method so that we generate GOcean specific invocation code and
provides three methods which separate arguments that are arrays from
arguments that are {integer, real} scalars.

:param alg_invocation: Node in the AST describing the invoke call.
:type alg_invocation: :py:class:`psyclone.parse.InvokeCall`
:param int idx: The position of the invoke in the list of invokes \
    contained in the Algorithm.
:param invokes: the Invokes object containing this GOInvoke \
    object.
:type invokes: :py:class:`psyclone.gocean1p0.GOInvokes`

Definition at line 199 of file gocean1p0.py.

Member Function Documentation

◆ gen_code()

def psyclone.gocean1p0.GOInvoke.gen_code	(	self,
		parent
	)

Generates GOcean specific invocation code (the subroutine called
by the associated invoke call in the algorithm layer). This
consists of the PSy invocation subroutine and the declaration of
its arguments.

:param parent: the node in the generated AST to which to add content.
:type parent: :py:class:`psyclone.f2pygen.ModuleGen`

Reimplemented from psyclone.psyGen.Invoke.

Definition at line 255 of file gocean1p0.py.

     def gen_code(self, parent):
         # pylint: disable=too-many-locals
         '''
         Generates GOcean specific invocation code (the subroutine called
         by the associated invoke call in the algorithm layer). This
         consists of the PSy invocation subroutine and the declaration of
         its arguments.
  
         :param parent: the node in the generated AST to which to add content.
         :type parent: :py:class:`psyclone.f2pygen.ModuleGen`
  
         '''
         # TODO 1010: GOcean doesn't use this method anymore and it can be
         # deleted, but some tests still call it directly.
  
         # Create the subroutine
         invoke_sub = SubroutineGen(parent, name=self.name,
                                    args=self.psy_unique_var_names)
         parent.add(invoke_sub)
  
         # Generate the code body of this subroutine
         self.schedule.gen_code(invoke_sub)
  
         # Add the subroutine argument declarations for fields
         if self.unique_args_arrays:
             my_decl_arrays = TypeDeclGen(invoke_sub, datatype="r2d_field",
                                          intent="inout",
                                          entity_decls=self.unique_args_arrays)
             invoke_sub.add(my_decl_arrays)
  
         # Add the subroutine argument declarations for integer and real scalars
         i_args = []
         for argument in self.schedule.symbol_table.argument_datasymbols:
             if argument.name in self.unique_args_iscalars:
                 i_args.append(argument.name)
  
         if i_args:
             my_decl_iscalars = DeclGen(invoke_sub, datatype="INTEGER",
                                        intent="inout",
                                        entity_decls=i_args)
             invoke_sub.add(my_decl_iscalars)
  
         # Add remaining local scalar symbols using the symbol table
         for symbol in self.schedule.symbol_table.automatic_datasymbols:
             if isinstance(symbol.datatype, ScalarType):
                 invoke_sub.add(DeclGen(
                     invoke_sub,
                     datatype=symbol.datatype.intrinsic.name,
                     entity_decls=[symbol.name]))
  
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unique_args_arrays()

def psyclone.gocean1p0.GOInvoke.unique_args_arrays ( self )

 find unique arguments that are arrays (defined as those that are
    field objects as opposed to scalars or properties of the grid).

Definition at line 228 of file gocean1p0.py.

     def unique_args_arrays(self):
         ''' find unique arguments that are arrays (defined as those that are
             field objects as opposed to scalars or properties of the grid). '''
         result = []
         for call in self._schedule.kernels():
             for arg in call.arguments.args:
                 if arg.argument_type == 'field' and arg.name not in result:
                     result.append(arg.name)
         return result
  

References psyclone.domain.lfric.lfric_invoke.LFRicInvoke._schedule, psyclone.dynamo0p3.DynMeshes._schedule, psyclone.gocean1p0.GOInvoke._schedule, psyclone.nemo.NemoInvoke._schedule, psyclone.psyGen.Invoke._schedule, and psyclone.psyir.nodes.omp_clauses.OMPScheduleClause._schedule.

Here is the caller graph for this function:

◆ unique_args_iscalars()

def psyclone.gocean1p0.GOInvoke.unique_args_iscalars ( self )

:returns: the unique arguments that are scalars of type integer \
          (defined as those that are i_scalar 'space').
:rtype: list of str.

Definition at line 239 of file gocean1p0.py.

     def unique_args_iscalars(self):
         '''
         :returns: the unique arguments that are scalars of type integer \
                   (defined as those that are i_scalar 'space').
         :rtype: list of str.
  
         '''
         result = []
         for call in self._schedule.kernels():
             for arg in args_filter(call.arguments.args, arg_types=["scalar"],
                                    include_literals=False):
                 if arg.space.lower() == "go_i_scalar" and \
                    arg.name not in result:
                     result.append(arg.name)
         return result
  

References psyclone.domain.lfric.lfric_invoke.LFRicInvoke._schedule, psyclone.dynamo0p3.DynMeshes._schedule, psyclone.gocean1p0.GOInvoke._schedule, psyclone.nemo.NemoInvoke._schedule, psyclone.psyGen.Invoke._schedule, and psyclone.psyir.nodes.omp_clauses.OMPScheduleClause._schedule.

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

Detailed Description

Member Function Documentation

◆ gen_code()

◆ unique_args_arrays()

◆ unique_args_iscalars()