Inheritance diagram for psyclone.dynamo0p3.DynKernelArguments:

Collaboration diagram for psyclone.dynamo0p3.DynKernelArguments:

Public Member Functions
def	__init__ (self, call, parent_call, check=True)

def	get_arg_on_space_name (self, func_space_name)

def	get_arg_on_space (self, func_space)

def	has_operator (self, op_type=None)

def	unique_fss (self)

def	unique_fs_names (self)

def	iteration_space_arg (self)

def	dofs (self)

def	psyir_expressions (self)

def	acc_args (self)

def	scalars (self)

Public Member Functions inherited from psyclone.psyGen.Arguments
def	__init__ (self, parent_call)

def	names (self)

def	args (self)

def	append (self, name, argument_type)

Detailed Description

Provides information about Dynamo kernel call arguments
collectively, as specified by the kernel argument metadata.

:param call: the kernel metadata for which to extract argument info.
:type call: :py:class:`psyclone.parse.KernelCall`
:param parent_call: the kernel-call object.
:type parent_call: :py:class:`psyclone.domain.lfric.LFRicKern`
:param bool check: whether to check for consistency between the \
    kernel metadata and the algorithm layer. Defaults to True.

:raises GenerationError: if the kernel metadata specifies stencil extent.

Definition at line 5035 of file dynamo0p3.py.

Member Function Documentation

◆ acc_args()

def psyclone.dynamo0p3.DynKernelArguments.acc_args ( self )

:returns: the list of quantities that must be available on an \
          OpenACC device before the associated kernel can be launched.
:rtype: list of str

Reimplemented from psyclone.psyGen.Arguments.

Definition at line 5324 of file dynamo0p3.py.

     def acc_args(self):
         '''
         :returns: the list of quantities that must be available on an \
                   OpenACC device before the associated kernel can be launched.
         :rtype: list of str
  
         '''
         create_acc_arg_list = KernCallAccArgList(self._parent_call)
         create_acc_arg_list.generate()
         return create_acc_arg_list.arglist
  

References psyclone.psyGen.Arguments._parent_call.

◆ dofs()

def psyclone.dynamo0p3.DynKernelArguments.dofs ( self )

 Currently required for Invoke base class although this
makes no sense for Dynamo. Need to refactor the Invoke base class
and remove the need for this property (#279).

Definition at line 5307 of file dynamo0p3.py.

     def dofs(self):
         ''' Currently required for Invoke base class although this
         makes no sense for Dynamo. Need to refactor the Invoke base class
         and remove the need for this property (#279). '''
         return self._dofs
  

References psyclone.dynamo0p3.DynKernelArguments._dofs, psyclone.gocean1p0.GOKernelArguments._dofs, and psyclone.psyGen.Invoke._dofs.

◆ get_arg_on_space()

def psyclone.dynamo0p3.DynKernelArguments.get_arg_on_space	(	self,
		func_space
	)

Returns the first argument (field or operator) found that is on
the specified function space. The mangled name of the supplied
function space is used for comparison.

:param func_space: The function space for which to find an argument.
:type func_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
:return: the first kernel argument that is on the supplied function
         space
:rtype: :py:class:`psyclone.dynamo0p3.DynKernelArgument`
:raises: FieldNotFoundError if no field or operator argument is found
         for the specified function space.

Definition at line 5178 of file dynamo0p3.py.

     def get_arg_on_space(self, func_space):
         '''
         Returns the first argument (field or operator) found that is on
         the specified function space. The mangled name of the supplied
         function space is used for comparison.
  
         :param func_space: The function space for which to find an argument.
         :type func_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
         :return: the first kernel argument that is on the supplied function
                  space
         :rtype: :py:class:`psyclone.dynamo0p3.DynKernelArgument`
         :raises: FieldNotFoundError if no field or operator argument is found
                  for the specified function space.
         '''
         for arg in self._args:
             for function_space in arg.function_spaces:
                 if function_space:
                     if func_space.mangled_name == function_space.mangled_name:
                         return arg
  
         raise FieldNotFoundError(f"DynKernelArguments:get_arg_on_space: there "
                                  f"is no field or operator with function space"
                                  f" {func_space.orig_name} (mangled name = "
                                  f"'{func_space.mangled_name}')")
  

References psyclone.dynamo0p3.DynKernelArguments._args, psyclone.gocean1p0.GOKernelArguments._args, psyclone.parse.algorithm.ParsedCall._args, and psyclone.psyGen.Arguments._args.

◆ get_arg_on_space_name()

def psyclone.dynamo0p3.DynKernelArguments.get_arg_on_space_name	(	self,
		func_space_name
	)

Returns the first argument (field or operator) found that is on
the named function space, as specified in the kernel metadata. Also
returns the associated FunctionSpace object.

:param str func_space_name: Name of the function space (as specified \
                            in kernel metadata) for which to \
                            find an argument.
:return: the first kernel argument that is on the named function \
         space and the associated FunctionSpace object.
:rtype: (:py:class:`psyclone.dynamo0p3.DynKernelArgument`,
         :py:class:`psyclone.domain.lfric.FunctionSpace`)
:raises: FieldNotFoundError if no field or operator argument is found \
         for the named function space.

Definition at line 5153 of file dynamo0p3.py.

     def get_arg_on_space_name(self, func_space_name):
         '''
         Returns the first argument (field or operator) found that is on
         the named function space, as specified in the kernel metadata. Also
         returns the associated FunctionSpace object.
  
         :param str func_space_name: Name of the function space (as specified \
                                     in kernel metadata) for which to \
                                     find an argument.
         :return: the first kernel argument that is on the named function \
                  space and the associated FunctionSpace object.
         :rtype: (:py:class:`psyclone.dynamo0p3.DynKernelArgument`,
                  :py:class:`psyclone.domain.lfric.FunctionSpace`)
         :raises: FieldNotFoundError if no field or operator argument is found \
                  for the named function space.
         '''
         for arg in self._args:
             for function_space in arg.function_spaces:
                 if function_space:
                     if func_space_name == function_space.orig_name:
                         return arg, function_space
         raise FieldNotFoundError(f"DynKernelArguments:get_arg_on_space_name: "
                                  f"there is no field or operator with "
                                  f"function space {func_space_name}")
  

References psyclone.dynamo0p3.DynKernelArguments._args, psyclone.gocean1p0.GOKernelArguments._args, psyclone.parse.algorithm.ParsedCall._args, and psyclone.psyGen.Arguments._args.

◆ has_operator()

def psyclone.dynamo0p3.DynKernelArguments.has_operator	(	self,
		op_type = `None`
	)

 Returns true if at least one of the arguments is an operator
of type op_type (either gh_operator [LMA] or gh_columnwise_operator
[CMA]). If op_type is None then searches for *any* valid operator
type.

Definition at line 5203 of file dynamo0p3.py.

     def has_operator(self, op_type=None):
         ''' Returns true if at least one of the arguments is an operator
         of type op_type (either gh_operator [LMA] or gh_columnwise_operator
         [CMA]). If op_type is None then searches for *any* valid operator
         type. '''
         const = LFRicConstants()
         if op_type and op_type not in const.VALID_OPERATOR_NAMES:
             raise GenerationError(
                 f"If supplied, 'op_type' must be a valid operator type (one "
                 f"of {const.VALID_OPERATOR_NAMES}) but got '{op_type}'")
         if not op_type:
             # If no operator type is specified then we match any type
             op_list = const.VALID_OPERATOR_NAMES
         else:
             op_list = [op_type]
         for arg in self._args:
             if arg.argument_type in op_list:
                 return True
         return False
  

References psyclone.dynamo0p3.DynKernelArguments._args, psyclone.gocean1p0.GOKernelArguments._args, psyclone.parse.algorithm.ParsedCall._args, and psyclone.psyGen.Arguments._args.

◆ iteration_space_arg()

def psyclone.dynamo0p3.DynKernelArguments.iteration_space_arg ( self )

Returns an argument we can use to dereference the iteration
space. This can be a field or operator that is modified or
alternatively a field that is read if one or more scalars
are modified. If a kernel writes to more than one argument then
that requiring the largest iteration space is selected.

:return: Kernel argument from which to obtain iteration space
:rtype: :py:class:`psyclone.dynamo0p3.DynKernelArgument`

Reimplemented from psyclone.psyGen.Arguments.

Definition at line 5236 of file dynamo0p3.py.

     def iteration_space_arg(self):
         '''
         Returns an argument we can use to dereference the iteration
         space. This can be a field or operator that is modified or
         alternatively a field that is read if one or more scalars
         are modified. If a kernel writes to more than one argument then
         that requiring the largest iteration space is selected.
  
         :return: Kernel argument from which to obtain iteration space
         :rtype: :py:class:`psyclone.dynamo0p3.DynKernelArgument`
         '''
  
         # Since we always compute operators out to the L1 halo we first
         # check whether this kernel writes to an operator
         write_accesses = AccessType.all_write_accesses()
         const = LFRicConstants()
         op_args = psyGen.args_filter(
             self._args,
             arg_types=const.VALID_OPERATOR_NAMES,
             arg_accesses=write_accesses)
         if op_args:
             return op_args[0]
  
         # Is this an inter-grid kernel? If so, then the iteration space
         # is determined by the coarse mesh, irrespective of whether
         # we are prolonging (and thus writing to a field on the fine mesh)
         # or restricting.
         if self._parent_call.is_intergrid:
             fld_args = psyGen.args_filter(
                 self._args,
                 arg_types=const.VALID_FIELD_NAMES,
                 arg_meshes=["gh_coarse"])
             return fld_args[0]
  
         # This is not an inter-grid kernel and it does not write to an
         # operator. We now check for fields that are written to. We
         # check first for any modified field on a continuous function
         # space, failing that we try any_space function spaces
         # (because we must assume such a space is continuous) and
         # finally we try all discontinuous function spaces including
         # any_discontinuous_space. We do this because if a quantity on
         # a continuous FS is modified then our iteration space must be
         # larger (include L1-halo cells)
         const = LFRicConstants()
         write_accesses = AccessType.all_write_accesses()
         fld_args = psyGen.args_filter(
             self._args,
             arg_types=const.VALID_FIELD_NAMES,
             arg_accesses=write_accesses)
         if fld_args:
             for spaces in [const.CONTINUOUS_FUNCTION_SPACES,
                            const.VALID_ANY_SPACE_NAMES,
                            const.VALID_DISCONTINUOUS_NAMES]:
                 for arg in fld_args:
                     if arg.function_space.orig_name in spaces:
                         return arg
  
         # No modified fields or operators. Check for unmodified fields...
         fld_args = psyGen.args_filter(
             self._args,
             arg_types=const.VALID_FIELD_NAMES)
         if fld_args:
             return fld_args[0]
  
         # it is an error if we get to here
         raise GenerationError(
             "iteration_space_arg(). The dynamo0.3 api must have a modified "
             "field, a modified operator, or an unmodified field (in the case "
             "of a modified scalar). None of these were found.")
  

References psyclone.dynamo0p3.DynKernelArguments._args, psyclone.gocean1p0.GOKernelArguments._args, psyclone.parse.algorithm.ParsedCall._args, psyclone.psyGen.Arguments._args, and psyclone.psyGen.Arguments._parent_call.

◆ psyir_expressions()

def psyclone.dynamo0p3.DynKernelArguments.psyir_expressions ( self )

:returns: the PSyIR expressions representing this Argument list.
:rtype: list of :py:class:`psyclone.psyir.nodes.Node`

Reimplemented from psyclone.psyGen.Arguments.

Definition at line 5313 of file dynamo0p3.py.

     def psyir_expressions(self):
         '''
         :returns: the PSyIR expressions representing this Argument list.
         :rtype: list of :py:class:`psyclone.psyir.nodes.Node`
  
         '''
         create_arg_list = KernCallArgList(self._parent_call)
         create_arg_list.generate()
         return create_arg_list.psyir_arglist
  

References psyclone.psyGen.Arguments._parent_call.

◆ scalars()

def psyclone.dynamo0p3.DynKernelArguments.scalars ( self )

Provides the list of names of scalar arguments required by the
kernel associated with this Arguments object. If there are none
then the returned list is empty.

:returns: A list of the names of scalar arguments in this object.
:rtype: list of str

Reimplemented from psyclone.psyGen.Arguments.

Definition at line 5336 of file dynamo0p3.py.

     def scalars(self):
         '''
         Provides the list of names of scalar arguments required by the
         kernel associated with this Arguments object. If there are none
         then the returned list is empty.
  
         :returns: A list of the names of scalar arguments in this object.
         :rtype: list of str
         '''
         # Return nothing for the moment as it is unclear whether
         # scalars need to be explicitly dealt with (for OpenACC) in
         # the dynamo api.
         return []
  
  

◆ unique_fs_names()

def psyclone.dynamo0p3.DynKernelArguments.unique_fs_names ( self )

 Return the list of unique function space names used by the
arguments of this kernel. The names are unmangled (i.e. as
specified in the kernel metadata)

Definition at line 5230 of file dynamo0p3.py.

     def unique_fs_names(self):
         ''' Return the list of unique function space names used by the
         arguments of this kernel. The names are unmangled (i.e. as
         specified in the kernel metadata) '''
         return self._unique_fs_names
  

References psyclone.dynamo0p3.DynKernelArguments._unique_fs_names.

◆ unique_fss()

def psyclone.dynamo0p3.DynKernelArguments.unique_fss ( self )

 Returns a unique list of function space objects used by the
arguments of this kernel

Definition at line 5224 of file dynamo0p3.py.

     def unique_fss(self):
         ''' Returns a unique list of function space objects used by the
         arguments of this kernel '''
         return self._unique_fss
  

References psyclone.dynamo0p3.DynKernelArguments._unique_fss.

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ acc_args()

◆ dofs()

◆ get_arg_on_space()

◆ get_arg_on_space_name()

◆ has_operator()

◆ iteration_space_arg()

◆ psyir_expressions()

◆ scalars()

◆ unique_fs_names()

◆ unique_fss()