psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor Class Reference

Inheritance diagram for psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor:

Collaboration diagram for psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor:

Public Member Functions
def	__init__ (self, arg_type, operates_on, metadata_index)
def	data_type (self)
def	function_space_to (self)
def	function_space_from (self)
def	function_space (self)
def	function_spaces (self)
def	vector_size (self)
def	__str__ (self)
Public Member Functions inherited from psyclone.parse.kernel.Descriptor
def	__init__ (self, access, space, metadata_index, stencil=None, mesh=None, argument_type=None)
def	access (self)
def	metadata_index (self)
def	stencil (self)
def	mesh (self)
def	argument_type (self)
def	__repr__ (self)

Detailed Description

This class captures the information specified in one of LFRic API argument
descriptors (scalars, fields and operators).

:param arg_type: LFRic API valid argument type (scalar, \
                 field or operator).
:type arg_type: :py:class:`psyclone.expression.FunctionVar` or \
                :py:class:`psyclone.expression.BinaryOperator`
:param str operates_on: value of operates_on from the parsed kernel \
                        metadata (used for validation).
:param int metadata_index: position of this argument in the list of \
                           arguments specified in the metadata.

:raises ParseError: if a 'meta_arg' entry is not of 'arg_type' type.
:raises ParseError: if the first argument of a 'meta_arg' entry is not \
                    one of LFRic API valid argument types.
:raises ParseError: if the second argument of a 'meta_arg' entry is not \
                    one of LFRic API valid data types.
:raises ParseError: if a 'meta_arg' entry has fewer than 3 args.
:raises ParseError: if the third 'meta_arg' entry is not a valid \
                    access descriptor.
:raises InternalError: if the operates_on from the parsed kernel \
                       metadata is not 'cell_column' or 'dof'.
:raises InternalError: if all the metadata checks fail to catch an \
                       invalid argument type.

Definition at line 61 of file lfric_arg_descriptor.py.

Member Function Documentation

__str__()

def psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor.__str__

(

self

)

Creates a string representation of the argument descriptor. This
is type and access for scalars with the addition of function
space(s) for fields and operators.

:returns: string representation of the argument descriptor.
:rtype: str

:raises InternalError: if an invalid argument type is passed in.

Definition at line 716 of file lfric_arg_descriptor.py.

    def __str__(self):
        '''
        Creates a string representation of the argument descriptor. This
        is type and access for scalars with the addition of function
        space(s) for fields and operators.
 
        :returns: string representation of the argument descriptor.
        :rtype: str
 
        :raises InternalError: if an invalid argument type is passed in.
 
        '''
        const = LFRicConstants()
        res = "LFRicArgDescriptor object" + os.linesep
        res += f"  argument_type[0]='{self._argument_type}'"
        if self._vector_size > 1:
            res += "*" + str(self._vector_size)
        res += os.linesep
        res += f"  data_type[1]='{self._data_type}'" + os.linesep
        res += (f"  access_descriptor[2]="
                f"'{self._access_type.api_specific_name()}'"
                + os.linesep)
        if self._argument_type in const.VALID_FIELD_NAMES:
            res += (f"  function_space[3]='{self._function_space1}'"
                    + os.linesep)
        elif self._argument_type in const.VALID_OPERATOR_NAMES:
            res += (f"  function_space_to[3]='{self._function_space1}'"
                    + os.linesep)
            res += (f"  function_space_from[4]='{self._function_space2}'"
                    + os.linesep)
        elif self._argument_type in const.VALID_SCALAR_NAMES:
            pass  # We have nothing to add if we're a scalar
        else:  # We should never get to here
            raise InternalError(f"Expected a valid argument type but got "
                                f"'{self._argument_type}'.")
        return res
 
 
# Documentation utils: The list of module members that we wish AutoAPI to
# generate documentation for (see https://psyclone-ref.readthedocs.io).

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._vector_size, and psyclone.dynamo0p3.DynKernelArgument._vector_size.

data_type()

def psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor.data_type

(

self

)

:returns: intrinsic Fortran (primitive) type of the argument data.
:rtype: str

Definition at line 606 of file lfric_arg_descriptor.py.

    def data_type(self):
        '''
        :returns: intrinsic Fortran (primitive) type of the argument data.
        :rtype: str
 
        '''
        return self._data_type
 

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._data_type, psyclone.dynamo0p3.DynKernelArgument._data_type, and psyclone.psyGen.Argument._data_type.

function_space()

def psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor.function_space

(

self

)

Returns the function space name related to this kernel argument
depending on the argument type: a single function space for a field,
function_space_from for an operator and nothing for a scalar.

:returns: function space relating to this kernel argument or \
          None (for a scalar).
:rtype: str or NoneType

:raises InternalError: if an invalid argument type is passed in.

Reimplemented from psyclone.parse.kernel.Descriptor.

Definition at line 655 of file lfric_arg_descriptor.py.

    def function_space(self):
        '''
        Returns the function space name related to this kernel argument
        depending on the argument type: a single function space for a field,
        function_space_from for an operator and nothing for a scalar.
 
        :returns: function space relating to this kernel argument or \
                  None (for a scalar).
        :rtype: str or NoneType
 
        :raises InternalError: if an invalid argument type is passed in.
 
        '''
        const = LFRicConstants()
        if self._argument_type in const.VALID_FIELD_NAMES:
            return self._function_space1
        if self._argument_type in const.VALID_OPERATOR_NAMES:
            return self._function_space2
        if self._argument_type in const.VALID_SCALAR_NAMES:
            return None
        raise InternalError(f"Expected a valid argument type but got "
                            f"'{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, psyclone.parse.kernel.Descriptor._argument_type, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._function_space1, and psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._function_space2.

Here is the caller graph for this function:

function_space_from()

def psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor.function_space_from

(

self

)

Returns the "from" function space for an operator. This is
the second function space specified in the metadata.

:returns: "from" function space for an operator.
:rtype: str

:raises InternalError: if this is not an operator.

Definition at line 635 of file lfric_arg_descriptor.py.

    def function_space_from(self):
        '''
        Returns the "from" function space for an operator. This is
        the second function space specified in the metadata.
 
        :returns: "from" function space for an operator.
        :rtype: str
 
        :raises InternalError: if this is not an operator.
 
        '''
        const = LFRicConstants()
        if self._argument_type in const.VALID_OPERATOR_NAMES:
            return self._function_space2
        raise InternalError(
            f"In the LFRic API 'function_space_from' only makes sense for one "
            f"of {const.VALID_OPERATOR_NAMES}, but this is a "
            f"'{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, psyclone.parse.kernel.Descriptor._argument_type, and psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._function_space2.

Here is the caller graph for this function:

function_space_to()

def psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor.function_space_to

(

self

)

Returns the "to" function space for an operator. This is
the first function space specified in the metadata.

:returns: "to" function space for an operator.
:rtype: str

:raises InternalError: if this is not an operator.

Definition at line 615 of file lfric_arg_descriptor.py.

    def function_space_to(self):
        '''
        Returns the "to" function space for an operator. This is
        the first function space specified in the metadata.
 
        :returns: "to" function space for an operator.
        :rtype: str
 
        :raises InternalError: if this is not an operator.
 
        '''
        const = LFRicConstants()
        if self._argument_type in const.VALID_OPERATOR_NAMES:
            return self._function_space1
        raise InternalError(
            f"In the LFRic API 'function_space_to' only makes sense for one "
            f"of {const.VALID_OPERATOR_NAMES}, but this is a "
            f"'{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, psyclone.parse.kernel.Descriptor._argument_type, and psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._function_space1.

Here is the caller graph for this function:

function_spaces()

def psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor.function_spaces

(

self

)

Returns the function space names related to this kernel argument
as a list depending on the argument type: one function space for
a field, both function spaces ("to"- and then "from"-) for an
operator and an empty list for a scalar.

:returns: function space names related to this kernel argument.
:rtype: list of str

:raises InternalError: if an invalid argument type is passed in.

Definition at line 679 of file lfric_arg_descriptor.py.

    def function_spaces(self):
        '''
        Returns the function space names related to this kernel argument
        as a list depending on the argument type: one function space for
        a field, both function spaces ("to"- and then "from"-) for an
        operator and an empty list for a scalar.
 
        :returns: function space names related to this kernel argument.
        :rtype: list of str
 
        :raises InternalError: if an invalid argument type is passed in.
 
        '''
        const = LFRicConstants()
        if self._argument_type in const.VALID_FIELD_NAMES:
            return [self.function_space]
        if self._argument_type in const.VALID_OPERATOR_NAMES:
            # Return to before from to maintain expected ordering
            return [self.function_space_to, self.function_space_from]
        if self._argument_type in const.VALID_SCALAR_NAMES:
            return []
        raise InternalError(f"Expected a valid argument type but got "
                            f"'{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, psyclone.parse.kernel.Descriptor._argument_type, 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(), psyclone.parse.kernel.Descriptor.function_space(), psyclone.domain.lfric.kernel.operator_arg_metadata.OperatorArgMetadata.function_space_from, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor.function_space_from(), psyclone.dynamo0p3.DynKernelArgument.function_space_from(), psyclone.domain.lfric.kernel.operator_arg_metadata.OperatorArgMetadata.function_space_to, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor.function_space_to(), and psyclone.dynamo0p3.DynKernelArgument.function_space_to().

Here is the call graph for this function:

Here is the caller graph for this function:

vector_size()

def psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor.vector_size

(

self

)

Returns the vector size of the argument. This will be 1 if ``*n``
has not been specified for all argument types except scalars
(their vector size is set to 0).

:returns: vector size of the argument.
:rtype: int

Definition at line 704 of file lfric_arg_descriptor.py.

    def vector_size(self):
        '''
        Returns the vector size of the argument. This will be 1 if ``*n``
        has not been specified for all argument types except scalars
        (their vector size is set to 0).
 
        :returns: vector size of the argument.
        :rtype: int
 
        '''
        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/domain/lfric/lfric_arg_descriptor.py