Inheritance diagram for psyclone.dynamo0p3.DynKernelArgument:

Collaboration diagram for psyclone.dynamo0p3.DynKernelArgument:

Public Member Functions
def	__init__ (self, kernel_args, arg_meta_data, arg_info, call, check=True)

def	ref_name (self, function_space=None)

def	is_scalar (self)

def	is_field (self)

def	is_operator (self)

def	descriptor (self)

def	argument_type (self)

def	intrinsic_type (self)

def	mesh (self)

def	vector_size (self)

def	name_indexed (self)

def	psyir_expression (self)

def	declaration_name (self)

def	proxy_name (self)

def	proxy_name_indexed (self)

def	proxy_declaration_name (self)

def	proxy_data_type (self)

def	function_space (self)

def	function_space_to (self)

def	function_space_from (self)

def	function_spaces (self)

def	function_space_names (self)

def	intent (self)

def	discontinuous (self)

def	stencil (self)

def	stencil (self, value)

def	infer_datatype (self, proxy=False)

Public Member Functions inherited from psyclone.psyGen.KernelArgument
def	__init__ (self, arg, arg_info, call)

def	space (self)

def	metadata_index (self)

Public Member Functions inherited from psyclone.psyGen.Argument
def	infer_datatype (self)

def	__str__ (self)

def	name (self)

def	text (self)

def	form (self)

def	is_literal (self)

def	access (self)

def	access (self, value)

def	precision (self)

def	data_type (self)

def	module_name (self)

def	call (self)

def	call (self, value)

def	backward_dependence (self)

def	forward_write_dependencies (self, ignore_halos=False)

def	backward_write_dependencies (self, ignore_halos=False)

def	forward_dependence (self)

def	forward_read_dependencies (self)

Public Attributes
	intrinsic_type

	argument_type

	access

Detailed Description

This class provides information about individual LFRic kernel call
arguments as specified by the kernel argument metadata and the
kernel invocation in the Algorithm layer.

:param kernel_args: object encapsulating all arguments to the \
                    kernel call.
:type kernel_args: :py:class:`psyclone.dynamo0p3.DynKernelArguments`
:param arg_meta_data: information obtained from the metadata for \
                      this kernel argument.
:type arg_meta_data: :py:class:`psyclone.domain.lfric.LFRicArgDescriptor`
:param arg_info: information on how this argument is specified in \
                 the Algorithm layer.
:type arg_info: :py:class:`psyclone.parse.algorithm.Arg`
:param call: the kernel object with which this argument is associated.
:type 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 InternalError: for an unsupported metadata in the argument \
                       descriptor data type.

Definition at line 5351 of file dynamo0p3.py.

Member Function Documentation

◆ argument_type()

def psyclone.dynamo0p3.DynKernelArgument.argument_type ( self )

:returns: the API type of this argument, as specified in \
          the metadata.
:rtype: str

Reimplemented from psyclone.psyGen.Argument.

Definition at line 5816 of file dynamo0p3.py.

     def argument_type(self):
         '''
         :returns: the API type of this argument, as specified in \
                   the metadata.
         :rtype: str
         '''
         return self._argument_type
  

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._argument_type, psyclone.dynamo0p3.DynKernelArgument._argument_type, psyclone.gocean1p0.GOKernelGridArgument._argument_type, psyclone.gocean1p0.GO1p0Descriptor._argument_type, and psyclone.parse.kernel.Descriptor._argument_type.

Here is the caller graph for this function:

◆ declaration_name()

def psyclone.dynamo0p3.DynKernelArgument.declaration_name ( self )

:returns: the name for this argument with the array dimensions \
          added if required.
:rtype: str

Definition at line 5919 of file dynamo0p3.py.

     def declaration_name(self):
         '''
         :returns: the name for this argument with the array dimensions \
                   added if required.
         :rtype: str
         '''
         if self._vector_size > 1:
             return self._name+"("+str(self._vector_size)+")"
         return self._name
  

References psyclone.domain.common.algorithm.psyir.AlgorithmInvokeCall._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._name, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._name, psyclone.dynamo0p3.DynFuncDescriptor03._name, psyclone.expression.NamedArg._name, psyclone.gocean1p0.GOKernelGridArgument._name, psyclone.gocean1p0.GOStencil._name, psyclone.nemo.NemoInvoke._name, psyclone.nemo.NemoPSy._name, psyclone.parse.algorithm.FileInfo._name, psyclone.parse.algorithm.InvokeCall._name, psyclone.parse.kernel.KernelProcedure._name, psyclone.parse.kernel.KernelType._name, psyclone.parse.module_info.ModuleInfo._name, psyclone.psyGen.PSy._name, psyclone.psyGen.Invoke._name, psyclone.psyGen.Kern._name, psyclone.psyGen.Argument._name, psyclone.psyir.nodes.container.Container._name, psyclone.psyir.nodes.routine.Routine._name, psyclone.psyir.symbols.symbol.Symbol._name, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._vector_size, and psyclone.dynamo0p3.DynKernelArgument._vector_size.

◆ descriptor()

def psyclone.dynamo0p3.DynKernelArgument.descriptor ( self )

:returns: a descriptor object which contains Kernel metadata \
          about this argument.
:rtype: :py:class:`psyclone.domain.lfric.LFRicArgDescriptor`

Definition at line 5807 of file dynamo0p3.py.

     def descriptor(self):
         '''
         :returns: a descriptor object which contains Kernel metadata \
                   about this argument.
         :rtype: :py:class:`psyclone.domain.lfric.LFRicArgDescriptor`
         '''
         return self._arg
  

References psyclone.gocean1p0.GOKernelArgument._arg, psyclone.psyGen.DataAccess._arg, and psyclone.psyGen.KernelArgument._arg.

Here is the caller graph for this function:

◆ discontinuous()

def psyclone.dynamo0p3.DynKernelArgument.discontinuous ( self )

Returns True if this argument is known to be on a discontinuous
function space including any_discontinuous_space, otherwise
returns False.

:returns: whether the argument is discontinuous.
:rtype: bool

Definition at line 6057 of file dynamo0p3.py.

     def discontinuous(self):
         '''
         Returns True if this argument is known to be on a discontinuous
         function space including any_discontinuous_space, otherwise
         returns False.
  
         :returns: whether the argument is discontinuous.
         :rtype: bool
  
         '''
         const = LFRicConstants()
         if self.function_space.orig_name in \
            const.VALID_DISCONTINUOUS_NAMES:
             return True
         if self.function_space.orig_name in \
            const.VALID_ANY_SPACE_NAMES:
             # We will eventually look this up based on our dependence
             # analysis but for the moment we assume the worst
             return False
         return False
  

References psyclone.domain.lfric.kernel.field_arg_metadata.FieldArgMetadata.function_space, psyclone.domain.lfric.kernel.meta_funcs_arg_metadata.MetaFuncsArgMetadata.function_space, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor.function_space(), psyclone.dynamo0p3.DynKernelArgument.function_space(), psyclone.gocean1p0.GOKernelArgument.function_space(), and psyclone.parse.kernel.Descriptor.function_space().

Here is the call graph for this function:

◆ function_space()

def psyclone.dynamo0p3.DynKernelArgument.function_space ( self )

Returns the expected finite element function space for a kernel
argument as specified by the kernel argument metadata: a single
function space for a field and function_space_from for an operator.

:returns: function space for this argument.
:rtype: :py:class:`psyclone.domain.lfric.FunctionSpace`

Definition at line 5971 of file dynamo0p3.py.

     def function_space(self):
         '''
         Returns the expected finite element function space for a kernel
         argument as specified by the kernel argument metadata: a single
         function space for a field and function_space_from for an operator.
  
         :returns: function space for this argument.
         :rtype: :py:class:`psyclone.domain.lfric.FunctionSpace`
         '''
         if self._argument_type == "gh_operator":
             # We return the 'from' space for an operator argument
             return self.function_space_from
         return self._function_spaces[0]
  

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._argument_type, psyclone.dynamo0p3.DynKernelArgument._argument_type, psyclone.gocean1p0.GOKernelGridArgument._argument_type, psyclone.gocean1p0.GO1p0Descriptor._argument_type, psyclone.parse.kernel.Descriptor._argument_type, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._function_spaces, psyclone.dynamo0p3.DynFunctionSpaces._function_spaces, psyclone.dynamo0p3.DynKernelArgument._function_spaces, psyclone.domain.lfric.kernel.operator_arg_metadata.OperatorArgMetadata.function_space_from, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor.function_space_from(), and psyclone.dynamo0p3.DynKernelArgument.function_space_from().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ function_space_from()

def psyclone.dynamo0p3.DynKernelArgument.function_space_from ( self )

:returns:  the 'from' function space of an operator.
:rtype: str

Definition at line 5994 of file dynamo0p3.py.

     def function_space_from(self):
         '''
         :returns:  the 'from' function space of an operator.
         :rtype: str
         '''
         return self._function_spaces[1]
  

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._function_spaces, psyclone.dynamo0p3.DynFunctionSpaces._function_spaces, and psyclone.dynamo0p3.DynKernelArgument._function_spaces.

Here is the caller graph for this function:

◆ function_space_names()

def psyclone.dynamo0p3.DynKernelArgument.function_space_names ( self )

Returns a list of the names of the function spaces associated
with this argument. We have more than one function space when
dealing with operators.

:returns: list of function space names for this argument.
:rtype: list of str

Definition at line 6016 of file dynamo0p3.py.

     def function_space_names(self):
         '''
         Returns a list of the names of the function spaces associated
         with this argument. We have more than one function space when
         dealing with operators.
  
         :returns: list of function space names for this argument.
         :rtype: list of str
  
         '''
         fs_names = []
         for fspace in self._function_spaces:
             if fspace:
                 fs_names.append(fspace.orig_name)
         return fs_names
  

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._function_spaces, psyclone.dynamo0p3.DynFunctionSpaces._function_spaces, and psyclone.dynamo0p3.DynKernelArgument._function_spaces.

◆ function_space_to()

def psyclone.dynamo0p3.DynKernelArgument.function_space_to ( self )

:returns: the 'to' function space of an operator.
:rtype: str

Definition at line 5986 of file dynamo0p3.py.

     def function_space_to(self):
         '''
         :returns: the 'to' function space of an operator.
         :rtype: str
         '''
         return self._function_spaces[0]
  

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._function_spaces, psyclone.dynamo0p3.DynFunctionSpaces._function_spaces, and psyclone.dynamo0p3.DynKernelArgument._function_spaces.

Here is the caller graph for this function:

◆ function_spaces()

def psyclone.dynamo0p3.DynKernelArgument.function_spaces ( self )

Returns the expected finite element function space for a kernel
argument as specified by the kernel argument metadata: a single
function space for a field and a list containing
function_space_to and function_space_from for an operator.

:returns: function space(s) for this argument.
:rtype: list of :py:class:`psyclone.domain.lfric.FunctionSpace`

Definition at line 6002 of file dynamo0p3.py.

     def function_spaces(self):
         '''
         Returns the expected finite element function space for a kernel
         argument as specified by the kernel argument metadata: a single
         function space for a field and a list containing
         function_space_to and function_space_from for an operator.
  
         :returns: function space(s) for this argument.
         :rtype: list of :py:class:`psyclone.domain.lfric.FunctionSpace`
  
         '''
         return self._function_spaces
  

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._function_spaces, psyclone.dynamo0p3.DynFunctionSpaces._function_spaces, and psyclone.dynamo0p3.DynKernelArgument._function_spaces.

Here is the caller graph for this function:

◆ infer_datatype()

def psyclone.dynamo0p3.DynKernelArgument.infer_datatype	(	self,
		proxy = `False`
	)

Infer the datatype of this kernel argument in the PSy layer using
the LFRic API rules. If any LFRic infrastructure modules are required
but are not already present then suitable ContainerSymbols are added
to the outermost symbol table. Similarly, DataTypeSymbols are added for
any required LFRic derived types that are not already in the symbol
table.

TODO #1258 - ultimately this routine should not have to create any
DataTypeSymbols as that should already have been done.

:param bool proxy: whether or not we want the type of the proxy \
    object for this kernel argument. Defaults to False (i.e.
    return the type rather than the proxy type).

:returns: the datatype of this argument.
:rtype: :py:class:`psyclone.psyir.symbols.DataType`

:raises NotImplementedError: if an unsupported argument type is found.

Definition at line 6097 of file dynamo0p3.py.

     def infer_datatype(self, proxy=False):
         '''
         Infer the datatype of this kernel argument in the PSy layer using
         the LFRic API rules. If any LFRic infrastructure modules are required
         but are not already present then suitable ContainerSymbols are added
         to the outermost symbol table. Similarly, DataTypeSymbols are added for
         any required LFRic derived types that are not already in the symbol
         table.
  
         TODO #1258 - ultimately this routine should not have to create any
         DataTypeSymbols as that should already have been done.
  
         :param bool proxy: whether or not we want the type of the proxy \
             object for this kernel argument. Defaults to False (i.e.
             return the type rather than the proxy type).
  
         :returns: the datatype of this argument.
         :rtype: :py:class:`psyclone.psyir.symbols.DataType`
  
         :raises NotImplementedError: if an unsupported argument type is found.
  
         '''
         # We want to put any Container symbols in the outermost scope so find
         # the corresponding symbol table.
         symbol_table = self._call.scope.symbol_table
         root_table = symbol_table
         while root_table.parent_symbol_table():
             root_table = root_table.parent_symbol_table()
  
         def _find_or_create_type(mod_name, type_name):
             '''
             Utility to find or create a DataTypeSymbol with the supplied name,
             imported from the named module.
  
             :param str mod_name: the name of the module from which the \
                                  DataTypeSymbol should be imported.
             :param str type_name: the name of the derived type for which to \
                                   create a DataTypeSymbol.
  
             :returns: the symbol for the requested type.
             :rtype: :py:class:`psyclone.psyir.symbols.DataTypeSymbol`
  
             '''
             return root_table.find_or_create(
                     type_name,
                     symbol_type=DataTypeSymbol,
                     datatype=UnresolvedType(),
                     interface=ImportInterface(root_table.find_or_create(
                         mod_name,
                         symbol_type=ContainerSymbol)
                         ))
  
         if self.is_scalar:
             # Find or create the DataType for the appropriate scalar type.
             if self.intrinsic_type == "real":
                 prim_type = ScalarType.Intrinsic.REAL
             elif self.intrinsic_type == "integer":
                 prim_type = ScalarType.Intrinsic.INTEGER
             elif self.intrinsic_type == "logical":
                 prim_type = ScalarType.Intrinsic.BOOLEAN
             else:
                 raise NotImplementedError(
                     f"Unsupported scalar type '{self.intrinsic_type}'")
  
             kind_name = self.precision
             try:
                 kind_symbol = symbol_table.lookup(kind_name)
             except KeyError:
                 mod_map = LFRicConstants().UTILITIES_MOD_MAP
                 const_mod = mod_map["constants"]["module"]
                 try:
                     constants_container = symbol_table.lookup(const_mod)
                 except KeyError:
                     # TODO Once #696 is done, we should *always* have a
                     # symbol for this container at this point so should
                     # raise an exception if we haven't.
                     constants_container = LFRicTypes(const_mod)
                     root_table.add(constants_container)
                 kind_symbol = DataSymbol(
                     kind_name, INTEGER_TYPE,
                     interface=ImportInterface(constants_container))
                 root_table.add(kind_symbol)
             return ScalarType(prim_type, kind_symbol)
  
         if self.is_field or self.is_operator:
             # Find or create the DataTypeSymbol for the appropriate
             # field or operator type.
             mod_name = self._module_name
             if proxy:
                 type_name = self._proxy_data_type
             else:
                 type_name = self._data_type
             return _find_or_create_type(mod_name, type_name)
  
         raise NotImplementedError(
             f"'{str(self)}' is not a scalar, field or operator argument")
  
  

References psyclone.f2pygen.CallGen._call, psyclone.gocean1p0.GOKernelGridArgument._call, psyclone.psyGen.DataAccess._call, psyclone.psyGen.Argument._call, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._data_type, psyclone.dynamo0p3.DynKernelArgument._data_type, psyclone.psyGen.Argument._data_type, psyclone.dynamo0p3.DynKernelArgument._module_name, psyclone.parse.algorithm.ParsedCall._module_name, psyclone.parse.algorithm.KernelCall._module_name, psyclone.psyGen.CodedKern._module_name, psyclone.psyGen.Argument._module_name, psyclone.psyir.nodes.psy_data_node.PSyDataNode._module_name, psyclone.dynamo0p3.DynKernelArgument._proxy_data_type, psyclone.dynamo0p3.DynKernelArgument.intrinsic_type, psyclone.gocean1p0.GOKernelArgument.intrinsic_type(), psyclone.gocean1p0.GOKernelGridArgument.intrinsic_type(), psyclone.psyGen.Argument.intrinsic_type(), psyclone.dynamo0p3.DynKernelArgument.is_field(), psyclone.dynamo0p3.DynKernelArgument.is_operator(), psyclone.dynamo0p3.DynKernelArgument.is_scalar(), psyclone.gocean1p0.GOKernelArgument.is_scalar(), psyclone.gocean1p0.GOKernelGridArgument.is_scalar(), psyclone.psyGen.KernelArgument.is_scalar(), psyclone.psyir.symbols.typed_symbol.TypedSymbol.is_scalar(), psyclone.psyGen.Argument.precision(), psyclone.psyir.symbols.datatypes.ScalarType.precision, and psyclone.psyir.symbols.datatypes.ArrayType.precision().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ intent()

def psyclone.dynamo0p3.DynKernelArgument.intent ( self )

Returns the Fortran intent of this argument as defined by the
valid access types for this API

:returns: the expected Fortran intent for this argument as \
          specified by the kernel argument metadata
:rtype: str

Definition at line 6033 of file dynamo0p3.py.

     def intent(self):
         '''
         Returns the Fortran intent of this argument as defined by the
         valid access types for this API
  
         :returns: the expected Fortran intent for this argument as \
                   specified by the kernel argument metadata
         :rtype: str
  
         '''
         write_accesses = AccessType.all_write_accesses()
         if self.access == AccessType.READ:
             return "in"
         if self.access in write_accesses:
             return "inout"
         # An argument access other than the pure "read" or one of
         # the "write" accesses is invalid
         valid_accesses = [AccessType.READ.api_specific_name()] + \
             [access.api_specific_name() for access in write_accesses]
         raise GenerationError(
             f"In the LFRic API the argument access must be one of "
             f"{valid_accesses}, but found '{self.access}'.")
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg.access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg.access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.ScalarArg.access(), psyclone.domain.lfric.kernel.common_meta_arg_metadata.CommonMetaArgMetadata.access, psyclone.dynamo0p3.DynKernelArgument.access, psyclone.parse.kernel.Descriptor.access(), psyclone.psyGen.Argument.access(), and psyclone.psyir.symbols.interfaces.ArgumentInterface.access.

Here is the call graph for this function:

◆ intrinsic_type()

def psyclone.dynamo0p3.DynKernelArgument.intrinsic_type ( self )

:returns: the intrinsic Fortran type of this argument for scalars \
          or of the argument's data for fields and operators.
:rtype: str

Reimplemented from psyclone.psyGen.Argument.

Definition at line 5825 of file dynamo0p3.py.

     def intrinsic_type(self):
         '''
         :returns: the intrinsic Fortran type of this argument for scalars \
                   or of the argument's data for fields and operators.
         :rtype: str
         '''
         return self._intrinsic_type
  

References psyclone.dynamo0p3.DynKernelArgument._intrinsic_type.

Here is the caller graph for this function:

◆ is_field()

def psyclone.dynamo0p3.DynKernelArgument.is_field ( self )

:returns: True if this kernel argument represents a field, \
          False otherwise.
:rtype: bool

Definition at line 5787 of file dynamo0p3.py.

     def is_field(self):
         '''
         :returns: True if this kernel argument represents a field, \
                   False otherwise.
         :rtype: bool
         '''
         const = LFRicConstants()
         return self._argument_type in const.VALID_FIELD_NAMES
  

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._argument_type, psyclone.dynamo0p3.DynKernelArgument._argument_type, psyclone.gocean1p0.GOKernelGridArgument._argument_type, psyclone.gocean1p0.GO1p0Descriptor._argument_type, and psyclone.parse.kernel.Descriptor._argument_type.

Here is the caller graph for this function:

◆ is_operator()

def psyclone.dynamo0p3.DynKernelArgument.is_operator ( self )

:returns: True if this kernel argument represents an operator, \
          False otherwise.
:rtype: bool

Definition at line 5797 of file dynamo0p3.py.

     def is_operator(self):
         '''
         :returns: True if this kernel argument represents an operator, \
                   False otherwise.
         :rtype: bool
         '''
         const = LFRicConstants()
         return self._argument_type in const.VALID_OPERATOR_NAMES
  

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._argument_type, psyclone.dynamo0p3.DynKernelArgument._argument_type, psyclone.gocean1p0.GOKernelGridArgument._argument_type, psyclone.gocean1p0.GO1p0Descriptor._argument_type, and psyclone.parse.kernel.Descriptor._argument_type.

Here is the caller graph for this function:

◆ is_scalar()

def psyclone.dynamo0p3.DynKernelArgument.is_scalar ( self )

:returns: True if this kernel argument represents a scalar, \
          False otherwise.
:rtype: bool

Reimplemented from psyclone.psyGen.KernelArgument.

Definition at line 5777 of file dynamo0p3.py.

     def is_scalar(self):
         '''
         :returns: True if this kernel argument represents a scalar, \
                   False otherwise.
         :rtype: bool
         '''
         const = LFRicConstants()
         return self._argument_type in const.VALID_SCALAR_NAMES
  

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._argument_type, psyclone.dynamo0p3.DynKernelArgument._argument_type, psyclone.gocean1p0.GOKernelGridArgument._argument_type, psyclone.gocean1p0.GO1p0Descriptor._argument_type, and psyclone.parse.kernel.Descriptor._argument_type.

Here is the caller graph for this function:

◆ mesh()

def psyclone.dynamo0p3.DynKernelArgument.mesh ( self )

:returns: mesh associated with argument ('GH_FINE' or 'GH_COARSE').
:rtype: str

Definition at line 5834 of file dynamo0p3.py.

     def mesh(self):
         '''
         :returns: mesh associated with argument ('GH_FINE' or 'GH_COARSE').
         :rtype: str
         '''
         return self._mesh
  

References psyclone.domain.lfric.kernel.meta_mesh_arg_metadata.MetaMeshArgMetadata._mesh, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._mesh, psyclone.dynamo0p3.DynKernelArgument._mesh, and psyclone.parse.kernel.Descriptor._mesh.

◆ name_indexed()

def psyclone.dynamo0p3.DynKernelArgument.name_indexed ( self )

:returns: the name for this argument with an additional index \
          which accesses the first element for a vector argument.
:rtype: str

Definition at line 5851 of file dynamo0p3.py.

     def name_indexed(self):
         '''
         :returns: the name for this argument with an additional index \
                   which accesses the first element for a vector argument.
         :rtype: str
         '''
         if self._vector_size > 1:
             return self._name+"(1)"
         return self._name
  

References psyclone.domain.common.algorithm.psyir.AlgorithmInvokeCall._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._name, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._name, psyclone.dynamo0p3.DynFuncDescriptor03._name, psyclone.expression.NamedArg._name, psyclone.gocean1p0.GOKernelGridArgument._name, psyclone.gocean1p0.GOStencil._name, psyclone.nemo.NemoInvoke._name, psyclone.nemo.NemoPSy._name, psyclone.parse.algorithm.FileInfo._name, psyclone.parse.algorithm.InvokeCall._name, psyclone.parse.kernel.KernelProcedure._name, psyclone.parse.kernel.KernelType._name, psyclone.parse.module_info.ModuleInfo._name, psyclone.psyGen.PSy._name, psyclone.psyGen.Invoke._name, psyclone.psyGen.Kern._name, psyclone.psyGen.Argument._name, psyclone.psyir.nodes.container.Container._name, psyclone.psyir.nodes.routine.Routine._name, psyclone.psyir.symbols.symbol.Symbol._name, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._vector_size, and psyclone.dynamo0p3.DynKernelArgument._vector_size.

◆ proxy_data_type()

def psyclone.dynamo0p3.DynKernelArgument.proxy_data_type ( self )

:returns: the type of this argument's proxy (if it exists) as \
          defined in LFRic infrastructure.
:rtype: str or NoneType

Definition at line 5961 of file dynamo0p3.py.

     def proxy_data_type(self):
         '''
         :returns: the type of this argument's proxy (if it exists) as \
                   defined in LFRic infrastructure.
         :rtype: str or NoneType
  
         '''
         return self._proxy_data_type
  

References psyclone.dynamo0p3.DynKernelArgument._proxy_data_type.

◆ proxy_declaration_name()

def psyclone.dynamo0p3.DynKernelArgument.proxy_declaration_name ( self )

:returns: the proxy name for this argument with the array \
          dimensions added if required.
:rtype: str

Definition at line 5950 of file dynamo0p3.py.

     def proxy_declaration_name(self):
         '''
         :returns: the proxy name for this argument with the array \
                   dimensions added if required.
         :rtype: str
         '''
         if self._vector_size > 1:
             return self.proxy_name+"("+str(self._vector_size)+")"
         return self.proxy_name
  

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._vector_size, psyclone.dynamo0p3.DynKernelArgument._vector_size, and psyclone.dynamo0p3.DynKernelArgument.proxy_name().

Here is the call graph for this function:

◆ proxy_name()

def psyclone.dynamo0p3.DynKernelArgument.proxy_name ( self )

:returns: the proxy name for this argument.
:rtype: str

Definition at line 5930 of file dynamo0p3.py.

     def proxy_name(self):
         '''
         :returns: the proxy name for this argument.
         :rtype: str
         '''
         return self._name+"_proxy"
  

References psyclone.domain.common.algorithm.psyir.AlgorithmInvokeCall._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._name, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._name, psyclone.dynamo0p3.DynFuncDescriptor03._name, psyclone.expression.NamedArg._name, psyclone.gocean1p0.GOKernelGridArgument._name, psyclone.gocean1p0.GOStencil._name, psyclone.nemo.NemoInvoke._name, psyclone.nemo.NemoPSy._name, psyclone.parse.algorithm.FileInfo._name, psyclone.parse.algorithm.InvokeCall._name, psyclone.parse.kernel.KernelProcedure._name, psyclone.parse.kernel.KernelType._name, psyclone.parse.module_info.ModuleInfo._name, psyclone.psyGen.PSy._name, psyclone.psyGen.Invoke._name, psyclone.psyGen.Kern._name, psyclone.psyGen.Argument._name, psyclone.psyir.nodes.container.Container._name, psyclone.psyir.nodes.routine.Routine._name, and psyclone.psyir.symbols.symbol.Symbol._name.

Here is the caller graph for this function:

◆ proxy_name_indexed()

def psyclone.dynamo0p3.DynKernelArgument.proxy_name_indexed ( self )

:returns: the proxy name for this argument with an additional \
          index which accesses the first element for a vector \
          argument.
:rtype: str

Definition at line 5938 of file dynamo0p3.py.

     def proxy_name_indexed(self):
         '''
         :returns: the proxy name for this argument with an additional \
                   index which accesses the first element for a vector \
                   argument.
         :rtype: str
         '''
         if self._vector_size > 1:
             return self._name+"_proxy(1)"
         return self._name+"_proxy"
  

References psyclone.domain.common.algorithm.psyir.AlgorithmInvokeCall._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._name, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._name, psyclone.dynamo0p3.DynFuncDescriptor03._name, psyclone.expression.NamedArg._name, psyclone.gocean1p0.GOKernelGridArgument._name, psyclone.gocean1p0.GOStencil._name, psyclone.nemo.NemoInvoke._name, psyclone.nemo.NemoPSy._name, psyclone.parse.algorithm.FileInfo._name, psyclone.parse.algorithm.InvokeCall._name, psyclone.parse.kernel.KernelProcedure._name, psyclone.parse.kernel.KernelType._name, psyclone.parse.module_info.ModuleInfo._name, psyclone.psyGen.PSy._name, psyclone.psyGen.Invoke._name, psyclone.psyGen.Kern._name, psyclone.psyGen.Argument._name, psyclone.psyir.nodes.container.Container._name, psyclone.psyir.nodes.routine.Routine._name, psyclone.psyir.symbols.symbol.Symbol._name, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._vector_size, and psyclone.dynamo0p3.DynKernelArgument._vector_size.

◆ psyir_expression()

def psyclone.dynamo0p3.DynKernelArgument.psyir_expression ( self )

Looks up or creates a reference to a suitable Symbol for this kernel
argument. If the argument is a scalar that has been provided as a
literal (in the Algorithm layer) then the PSyIR of the expression
is returned.

:returns: the PSyIR for this kernel argument.
:rtype: :py:class:`psyclone.psyir.nodes.Node`

:raises InternalError: if this argument is a literal but we fail to \
                       construct PSyIR that is consistent with this.
:raises NotImplementedError: if this argument is not a literal, scalar
                             or field.

Reimplemented from psyclone.psyGen.Argument.

Definition at line 5861 of file dynamo0p3.py.

     def psyir_expression(self):
         '''
         Looks up or creates a reference to a suitable Symbol for this kernel
         argument. If the argument is a scalar that has been provided as a
         literal (in the Algorithm layer) then the PSyIR of the expression
         is returned.
  
         :returns: the PSyIR for this kernel argument.
         :rtype: :py:class:`psyclone.psyir.nodes.Node`
  
         :raises InternalError: if this argument is a literal but we fail to \
                                construct PSyIR that is consistent with this.
         :raises NotImplementedError: if this argument is not a literal, scalar
                                      or field.
  
         '''
         symbol_table = self._call.scope.symbol_table
  
         if self.is_literal:
             reader = FortranReader()
             if self.precision:
                 # Ensure any associated precision symbol is in the table.
                 symbol_table.add_lfric_precision_symbol(self.precision)
             lit = reader.psyir_from_expression(self.name, symbol_table)
  
             # Sanity check that the resulting expression is a literal.
             if lit.walk(Reference):
                 raise InternalError(
                     f"Expected argument '{self.name}' to kernel "
                     f"'{self.call.name}' to be a literal but the created "
                     f"PSyIR contains one or more References.")
             return lit
  
         if self.is_scalar:
             try:
                 scalar_sym = symbol_table.lookup(self.name)
             except KeyError:
                 # TODO once #1258 is done the symbols should already exist
                 # and therefore we should raise an exception if not.
                 scalar_sym = symbol_table.new_symbol(
                     self.name, symbol_type=DataSymbol,
                     datatype=self.infer_datatype())
             return Reference(scalar_sym)
  
         const = LFRicConstants()
         try:
             suffix = const.ARG_TYPE_SUFFIX_MAPPING[self.argument_type]
             tag_name = f"{self.name}:{suffix}"
             sym = symbol_table.lookup_with_tag(tag_name)
             return Reference(sym)
  
         except KeyError as err:
             raise NotImplementedError(
                 f"Unsupported kernel argument type: '{self.name}' is of type "
                 f"'{self.argument_type}' which is not recognised as being a "
                 f"literal, scalar or field.") from err
  

Here is the call graph for this function:

◆ ref_name()

def psyclone.dynamo0p3.DynKernelArgument.ref_name	(	self,
		function_space = `None`
	)

Returns the name used to dereference this type of argument (depends
on whether it is a field or operator and, if the latter, whether it
is the to- or from-space that is specified).

:param function_space: the function space of this argument
:type function_space: :py:class:`psyclone.domain.lfric.FunctionSpace`

:returns: the name used to dereference this argument.
:rtype: str

:raises GenerationError: if the supplied function space is not one \
                         of the function spaces associated with \
                         this argument.
:raises GenerationError: if the supplied function space is not being \
                         returned by either 'function_space_from' or \
                         'function_space_to'.
:raises GenerationError: if the argument type is not supported.

Definition at line 5438 of file dynamo0p3.py.

     def ref_name(self, function_space=None):
         '''
         Returns the name used to dereference this type of argument (depends
         on whether it is a field or operator and, if the latter, whether it
         is the to- or from-space that is specified).
  
         :param function_space: the function space of this argument
         :type function_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
  
         :returns: the name used to dereference this argument.
         :rtype: str
  
         :raises GenerationError: if the supplied function space is not one \
                                  of the function spaces associated with \
                                  this argument.
         :raises GenerationError: if the supplied function space is not being \
                                  returned by either 'function_space_from' or \
                                  'function_space_to'.
         :raises GenerationError: if the argument type is not supported.
  
         '''
         # pylint: disable=too-many-branches
         if not function_space:
             if self.is_operator:
                 # For an operator we use the 'from' FS
                 function_space = self._function_spaces[1]
             else:
                 function_space = self._function_spaces[0]
         else:
             # Check that the supplied function space is valid for this
             # argument
             found = False
             for fspace in self.function_spaces:
                 if fspace and fspace.orig_name == function_space.orig_name:
                     found = True
                     break
             if not found:
                 raise GenerationError(
                     f"DynKernelArgument.ref_name(fs): The supplied function "
                     f"space (fs='{function_space.orig_name}') is not one of "
                     f"the function spaces associated with this argument "
                     f"(fss={self.function_space_names}).")
         if self.is_field:
             return "vspace"
         if self.is_operator:
             if function_space.orig_name == self.descriptor.function_space_from:
                 return "fs_from"
             if function_space.orig_name == self.descriptor.function_space_to:
                 return "fs_to"
             raise GenerationError(
                 f"DynKernelArgument.ref_name(fs): Function space "
                 f"'{function_space.orig_name}' is one of the 'gh_operator' "
                 f"function spaces '{self.function_spaces}' but is not being "
                 f"returned by either function_space_from "
                 f"'{self.descriptor.function_space_from}' or "
                 f"function_space_to '{self.descriptor.function_space_to}'.")
         raise GenerationError(
             f"DynKernelArgument.ref_name(fs): Found unsupported argument "
             f"type '{self._argument_type}'.")
  

Here is the call graph for this function:

◆ stencil() [1/2]

def psyclone.dynamo0p3.DynKernelArgument.stencil ( self )

:returns: stencil information for this argument if it exists.
:rtype: :py:class:`psyclone.dynamo0p3.LFRicArgStencil`

Reimplemented from psyclone.psyGen.KernelArgument.

Definition at line 6079 of file dynamo0p3.py.

     def stencil(self):
         '''
         :returns: stencil information for this argument if it exists.
         :rtype: :py:class:`psyclone.dynamo0p3.LFRicArgStencil`
         '''
         return self._stencil
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._stencil, psyclone.domain.lfric.arg_index_to_metadata_index.ArgIndexToMetadataIndex._stencil(), psyclone.domain.lfric.kernel.field_arg_metadata.FieldArgMetadata._stencil, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._stencil, psyclone.domain.lfric.metadata_to_arguments_rules.MetadataToArgumentsRules._stencil(), psyclone.dynamo0p3.DynKernelArgument._stencil, psyclone.gocean1p0.GOStencil._stencil, and psyclone.parse.kernel.Descriptor._stencil.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stencil() [2/2]

def psyclone.dynamo0p3.DynKernelArgument.stencil	(	self,
		value
	)

Sets stencil information for this kernel argument.

:param value: stencil information for this argument.
:type value: :py:class:`psyclone.dynamo0p3.LFRicArgStencil`

Definition at line 6087 of file dynamo0p3.py.

     def stencil(self, value):
         '''
         Sets stencil information for this kernel argument.
  
         :param value: stencil information for this argument.
         :type value: :py:class:`psyclone.dynamo0p3.LFRicArgStencil`
  
         '''
         self._stencil = value
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._stencil, psyclone.domain.lfric.arg_index_to_metadata_index.ArgIndexToMetadataIndex._stencil(), psyclone.domain.lfric.kernel.field_arg_metadata.FieldArgMetadata._stencil, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._stencil, psyclone.domain.lfric.metadata_to_arguments_rules.MetadataToArgumentsRules._stencil(), psyclone.dynamo0p3.DynKernelArgument._stencil, psyclone.gocean1p0.GOStencil._stencil, psyclone.parse.kernel.Descriptor._stencil, and psyclone.dynamo0p3.DynKernelArgument.stencil().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vector_size()

def psyclone.dynamo0p3.DynKernelArgument.vector_size ( self )

:returns: the vector size of this argument as specified in \
          the Kernel metadata.
:rtype: str

Definition at line 5842 of file dynamo0p3.py.

     def vector_size(self):
         '''
         :returns: the vector size of this argument as specified in \
                   the Kernel metadata.
         :rtype: str
         '''
         return self._vector_size
  

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._vector_size, and psyclone.dynamo0p3.DynKernelArgument._vector_size.

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

Public Attributes

Detailed Description

Member Function Documentation

◆ argument_type()

◆ declaration_name()

◆ descriptor()

◆ discontinuous()

◆ function_space()

◆ function_space_from()

◆ function_space_names()

◆ function_space_to()

◆ function_spaces()

◆ infer_datatype()

◆ intent()

◆ intrinsic_type()

◆ is_field()

◆ is_operator()

◆ is_scalar()

◆ mesh()

◆ name_indexed()

◆ proxy_data_type()

◆ proxy_declaration_name()

◆ proxy_name()

◆ proxy_name_indexed()

◆ psyir_expression()

◆ ref_name()

◆ stencil() [1/2]

◆ stencil() [2/2]

◆ vector_size()