psyclone.domain.lfric.function_space.FunctionSpace Class Reference

Public Member Functions
def	__init__ (self, name, kernel_args)
def	orig_name (self)
def	short_name (self)
def	mangled_name (self)
def	map_name (self)
def	cbanded_map_name (self)
def	cma_indirection_map_name (self)
def	ndf_name (self)
def	undf_name (self)
def	get_basis_name (self, qr_var=None, on_space=None)
def	get_diff_basis_name (self, qr_var=None, on_space=None)
def	get_operator_name (self, operator_name, qr_var=None, on_space=None)
def	field_on_space (self, arguments)
def	cma_on_space (self, arguments)
def	has_scalar_basis (self)
def	has_vector_basis (self)
def	has_scalar_diff_basis (self)
def	has_vector_diff_basis (self)

Detailed Description

Manages the name of a function space. If it is an any_space or
any_discontinuous_space then its name is mangled such that it is unique
within the scope of an Invoke.

:param str name: original name of function space to create a \
                 mangled name for.
:param kernel_args: object encapsulating all arguments to the kernel, \
                    one or more of which are on this function space.
:type kernel_args: :py:class:`psyclone.dynamo0p3.DynKernelArguments`

:raises InternalError: if an unrecognised function space is encountered.

Definition at line 45 of file function_space.py.

Member Function Documentation

cbanded_map_name()

def psyclone.domain.lfric.function_space.FunctionSpace.cbanded_map_name

(

self

)

:returns: the name of a column-banded dofmap for this FunctionSpace.
:rtype: str

Definition at line 213 of file function_space.py.

    def cbanded_map_name(self):
        ''':returns: the name of a column-banded dofmap for this FunctionSpace.
        :rtype: str
        '''
        return "cbanded_map_" + self.mangled_name
 

References psyclone.domain.lfric.function_space.FunctionSpace.mangled_name().

Here is the call graph for this function:

cma_indirection_map_name()

def psyclone.domain.lfric.function_space.FunctionSpace.cma_indirection_map_name

(

self

)

:returns: the name of a CMA indirection dofmap for the supplied \
    FunctionSpace.
:rtype: str

Definition at line 220 of file function_space.py.

    def cma_indirection_map_name(self):
        ''':returns: the name of a CMA indirection dofmap for the supplied \
            FunctionSpace.
        :rtype: str
        '''
        return "cma_indirection_map_" + self.mangled_name
 

References psyclone.domain.lfric.function_space.FunctionSpace.mangled_name().

Here is the call graph for this function:

cma_on_space()

def psyclone.domain.lfric.function_space.FunctionSpace.cma_on_space	(		self,
			arguments
	)

Returns the corresponding argument if the supplied list of
arguments contains a cma operator that maps to/from this FunctionSpace.
Otherwise this function returns None.

:param arguments: list of arguments to be tested.
:type arguments: :py:class:`psyclone.dynamo0p3.DynKernelArguments`

:returns: the argument from the supplied list of arguments that \
          contains a field that exists on this space or None.
:rtype: :py:class:`psyclone.dynamo0p3.DynKernelArgument` or None

Definition at line 339 of file function_space.py.

    def cma_on_space(self, arguments):
        '''Returns the corresponding argument if the supplied list of
        arguments contains a cma operator that maps to/from this FunctionSpace.
        Otherwise this function returns None.
 
        :param arguments: list of arguments to be tested.
        :type arguments: :py:class:`psyclone.dynamo0p3.DynKernelArguments`
 
        :returns: the argument from the supplied list of arguments that \
                  contains a field that exists on this space or None.
        :rtype: :py:class:`psyclone.dynamo0p3.DynKernelArgument` or None
 
        '''
        if self.mangled_name in arguments.unique_fs_names:
            for arg in arguments.args:
                # First, test that arg is a CMA op as some argument objects
                # won't have function spaces, e.g. scalars
                if arg.argument_type == "gh_columnwise_operator" and \
                   self.orig_name in [arg.function_space_to.orig_name,
                                      arg.function_space_from.orig_name]:
                    return arg
        return None
 

References psyclone.domain.lfric.function_space.FunctionSpace.mangled_name(), psyclone.domain.lfric.function_space.FunctionSpace.orig_name(), psyclone.dynamo0p3.DynamoPSy.orig_name(), and psyclone.psyir.symbols.interfaces.ImportInterface.orig_name().

Here is the call graph for this function:

field_on_space()

def psyclone.domain.lfric.function_space.FunctionSpace.field_on_space	(		self,
			arguments
	)

Returns the corresponding argument if the supplied list of
arguments contains a field that exists on this space. Otherwise this
function returns None.

:param arguments: list of arguments to be tested.
:type arguments: :py:class:`psyclone.dynamo0p3.DynKernelArguments`

:returns: the argument from the supplied list of arguments that \
          contains a field that exists on this space or None.
:rtype: :py:class:`psyclone.dynamo0p3.DynKernelArgument` or None

Definition at line 317 of file function_space.py.

    def field_on_space(self, arguments):
        '''Returns the corresponding argument if the supplied list of
        arguments contains a field that exists on this space. Otherwise this
        function returns None.
 
        :param arguments: list of arguments to be tested.
        :type arguments: :py:class:`psyclone.dynamo0p3.DynKernelArguments`
 
        :returns: the argument from the supplied list of arguments that \
                  contains a field that exists on this space or None.
        :rtype: :py:class:`psyclone.dynamo0p3.DynKernelArgument` or None
 
        '''
        if self.mangled_name in arguments.unique_fs_names:
            for arg in arguments.args:
                # First, test that argument is a field as some argument
                # objects won't have function spaces, e.g. scalars
                if arg.is_field and \
                   arg.function_space.orig_name == self.orig_name:
                    return arg
        return None
 

References psyclone.domain.lfric.function_space.FunctionSpace.mangled_name(), psyclone.domain.lfric.function_space.FunctionSpace.orig_name(), psyclone.dynamo0p3.DynamoPSy.orig_name(), and psyclone.psyir.symbols.interfaces.ImportInterface.orig_name().

Here is the call graph for this function:

get_basis_name()

def psyclone.domain.lfric.function_space.FunctionSpace.get_basis_name	(		self,
			qr_var = None,
			on_space = None
	)

Returns a name for the basis function on this FunctionSpace. If
the name of an associated quadrature object is supplied then this
is appended to the returned name. Similarly, if the function space
at which the basis is to be evaluated is supplied then this is
also appended to the name.

:param string qr_var: the name of the Quadrature Object for which the \
                      basis functions are required
:param on_space: the function space at which the basis functions \
                 will be evaluated
:type on_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
:returns: name for the Fortran array holding the basis function
:rtype: str

Definition at line 241 of file function_space.py.

    def get_basis_name(self, qr_var=None, on_space=None):
        '''
        Returns a name for the basis function on this FunctionSpace. If
        the name of an associated quadrature object is supplied then this
        is appended to the returned name. Similarly, if the function space
        at which the basis is to be evaluated is supplied then this is
        also appended to the name.
 
        :param string qr_var: the name of the Quadrature Object for which the \
                              basis functions are required
        :param on_space: the function space at which the basis functions \
                         will be evaluated
        :type on_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
        :returns: name for the Fortran array holding the basis function
        :rtype: str
 
        '''
        name = "_".join(["basis", self.mangled_name])
        if qr_var:
            name += "_" + qr_var
        if on_space:
            name += "_on_" + on_space.mangled_name
        return name
 

References psyclone.domain.lfric.function_space.FunctionSpace.mangled_name().

Here is the call graph for this function:

Here is the caller graph for this function:

get_diff_basis_name()

def psyclone.domain.lfric.function_space.FunctionSpace.get_diff_basis_name	(		self,
			qr_var = None,
			on_space = None
	)

Returns a name for the differential basis function on this
FunctionSpace.  If the name of an associated quadrature object is
supplied then this is appended to the returned name. Similarly, if the
function space at which the basis is to be evaluated is supplied then
this is also appended to the name.

:param str qr_var: the name of the Quadrature Object for which the \
                   differential basis functions are required.
:param on_space: the function space at which the differential basis \
                 functions will be evaluated
:type on_space: :py:class:`psyclone.dynamo0p3.domain.lfric.\
                FunctionSpace`
:returns: name for the Fortran array holding the differential basis \
          function
:rtype: str

Definition at line 265 of file function_space.py.

    def get_diff_basis_name(self, qr_var=None, on_space=None):
        '''
        Returns a name for the differential basis function on this
        FunctionSpace.  If the name of an associated quadrature object is
        supplied then this is appended to the returned name. Similarly, if the
        function space at which the basis is to be evaluated is supplied then
        this is also appended to the name.
 
        :param str qr_var: the name of the Quadrature Object for which the \
                           differential basis functions are required.
        :param on_space: the function space at which the differential basis \
                         functions will be evaluated
        :type on_space: :py:class:`psyclone.dynamo0p3.domain.lfric.\
                        FunctionSpace`
        :returns: name for the Fortran array holding the differential basis \
                  function
        :rtype: str
 
        '''
        name = "diff_basis_" + self.mangled_name
        if qr_var:
            name += "_" + qr_var
        if on_space:
            name += "_on_" + on_space.mangled_name
        return name
 

References psyclone.domain.lfric.function_space.FunctionSpace.mangled_name().

Here is the call graph for this function:

Here is the caller graph for this function:

get_operator_name()

def psyclone.domain.lfric.function_space.FunctionSpace.get_operator_name	(		self,
			operator_name,
			qr_var = None,
			on_space = None
	)

Returns the name of the specified operator (basis or differential
basis) for this FunctionSpace.

:param str operator_name: name (type) of the operator.
:param str qr_var: the name of the Quadrature Object for which the \
                   operator is required.
:param on_space: the function space at which the operator is required.
:type on_space: :py:class:`psyclone.domain.lfric.FunctionSpace`

:returns: name for the Fortran arry holding the named operator \
          for the specified function space.
:rtype: str

Definition at line 291 of file function_space.py.

    def get_operator_name(self, operator_name, qr_var=None, on_space=None):
        '''
        Returns the name of the specified operator (basis or differential
        basis) for this FunctionSpace.
 
        :param str operator_name: name (type) of the operator.
        :param str qr_var: the name of the Quadrature Object for which the \
                           operator is required.
        :param on_space: the function space at which the operator is required.
        :type on_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
 
        :returns: name for the Fortran arry holding the named operator \
                  for the specified function space.
        :rtype: str
 
        '''
        if operator_name == "gh_basis":
            return self.get_basis_name(qr_var=qr_var, on_space=on_space)
        if operator_name == "gh_diff_basis":
            return self.get_diff_basis_name(qr_var=qr_var, on_space=on_space)
 
        const = LFRicConstants()
        raise GenerationError(
            f"Unsupported name '{operator_name}' found. Expected one of "
            f"{const.VALID_METAFUNC_NAMES}")
 

References psyclone.domain.lfric.function_space.FunctionSpace.get_basis_name(), and psyclone.domain.lfric.function_space.FunctionSpace.get_diff_basis_name().

Here is the call graph for this function:

has_scalar_basis()

def psyclone.domain.lfric.function_space.FunctionSpace.has_scalar_basis

(

self

)

:returns: True if this function space has scalar basis functions.
:rtype: bool

Definition at line 363 of file function_space.py.

    def has_scalar_basis(self):
        ''':returns: True if this function space has scalar basis functions.
        :rtype: bool
        '''
        const = LFRicConstants()
        return self.orig_name.lower() in const.SCALAR_BASIS_SPACE_NAMES
 

References psyclone.domain.lfric.function_space.FunctionSpace.orig_name(), psyclone.dynamo0p3.DynamoPSy.orig_name(), and psyclone.psyir.symbols.interfaces.ImportInterface.orig_name().

Here is the call graph for this function:

has_scalar_diff_basis()

def psyclone.domain.lfric.function_space.FunctionSpace.has_scalar_diff_basis

(

self

)

:returns: True if this function space has scalar differential
    basis functions.
:rtype: bool

Definition at line 379 of file function_space.py.

    def has_scalar_diff_basis(self):
        ''':returns: True if this function space has scalar differential
            basis functions.
        :rtype: bool
        '''
        const = LFRicConstants()
        return self.orig_name.lower() in const.SCALAR_DIFF_BASIS_SPACE_NAMES
 

References psyclone.domain.lfric.function_space.FunctionSpace.orig_name(), psyclone.dynamo0p3.DynamoPSy.orig_name(), and psyclone.psyir.symbols.interfaces.ImportInterface.orig_name().

Here is the call graph for this function:

has_vector_basis()

def psyclone.domain.lfric.function_space.FunctionSpace.has_vector_basis

(

self

)

:returns: True if this function space has vector basis functions.
:rtype: bool

Definition at line 371 of file function_space.py.

    def has_vector_basis(self):
        ''':returns: True if this function space has vector basis functions.
        :rtype: bool
        '''
        const = LFRicConstants()
        return self.orig_name.lower() in const.VECTOR_BASIS_SPACE_NAMES
 

References psyclone.domain.lfric.function_space.FunctionSpace.orig_name(), psyclone.dynamo0p3.DynamoPSy.orig_name(), and psyclone.psyir.symbols.interfaces.ImportInterface.orig_name().

Here is the call graph for this function:

has_vector_diff_basis()

def psyclone.domain.lfric.function_space.FunctionSpace.has_vector_diff_basis

(

self

)

:returns: True if this function space has vector differential
    basis functions.
:rtype: bool

Definition at line 388 of file function_space.py.

    def has_vector_diff_basis(self):
        ''':returns: True if this function space has vector differential
            basis functions.
        :rtype: bool
        '''
        const = LFRicConstants()
        return self.orig_name.lower() in const.VECTOR_DIFF_BASIS_SPACE_NAMES

References psyclone.domain.lfric.function_space.FunctionSpace.orig_name(), psyclone.dynamo0p3.DynamoPSy.orig_name(), and psyclone.psyir.symbols.interfaces.ImportInterface.orig_name().

Here is the call graph for this function:

mangled_name()

def psyclone.domain.lfric.function_space.FunctionSpace.mangled_name

(

self

)

Returns the mangled name of this function space such that it is
unique within the scope of an invoke. If the mangled name has not
been generated then we do that the first time we are called.

:returns: mangled name of this function space.
:rtype: str

Definition at line 112 of file function_space.py.

    def mangled_name(self):
        '''
        Returns the mangled name of this function space such that it is
        unique within the scope of an invoke. If the mangled name has not
        been generated then we do that the first time we are called.
 
        :returns: mangled name of this function space.
        :rtype: str
 
        '''
        if self._mangled_name:
            return self._mangled_name
        # Cannot use kernel_args.field_on_space(x) here because that
        # routine itself requires the mangled name in order to identify
        # whether the space is present in the kernel call.
        self._mangled_name = self._mangle_fs_name()
        return self._mangled_name
 

References psyclone.domain.lfric.function_space.FunctionSpace._kernel_args, psyclone.dynamo0p3.DynKernelArgument._kernel_args, psyclone.domain.lfric.function_space.FunctionSpace._mangle_fs_name(), psyclone.domain.lfric.function_space.FunctionSpace._mangled_name, psyclone.domain.lfric.function_space.FunctionSpace._orig_name, psyclone.psyGen.Argument._orig_name, psyclone.psyir.symbols.interfaces.ImportInterface._orig_name, and psyclone.domain.lfric.function_space.FunctionSpace._short_name.

Here is the call graph for this function:

Here is the caller graph for this function:

map_name()

def psyclone.domain.lfric.function_space.FunctionSpace.map_name

(

self

)

:returns: a dofmap name for the supplied FunctionSpace.
:rtype: str

Definition at line 206 of file function_space.py.

    def map_name(self):
        ''':returns: a dofmap name for the supplied FunctionSpace.
        :rtype: str
        '''
        return "map_" + self.mangled_name
 

References psyclone.domain.lfric.function_space.FunctionSpace.mangled_name().

Here is the call graph for this function:

Here is the caller graph for this function:

ndf_name()

def psyclone.domain.lfric.function_space.FunctionSpace.ndf_name

(

self

)

:returns: a ndf name for this FunctionSpace object.
:rtype: str

Definition at line 228 of file function_space.py.

    def ndf_name(self):
        ''':returns: a ndf name for this FunctionSpace object.
        :rtype: str
        '''
        return "ndf_" + self.mangled_name
 

References psyclone.domain.lfric.function_space.FunctionSpace.mangled_name().

Here is the call graph for this function:

orig_name()

def psyclone.domain.lfric.function_space.FunctionSpace.orig_name

(

self

)

Returns the name of this function space as declared in the
kernel meta-data.

:returns: original name of this function space.
:rtype: str

Definition at line 88 of file function_space.py.

    def orig_name(self):
        '''
        Returns the name of this function space as declared in the
        kernel meta-data.
 
        :returns: original name of this function space.
        :rtype: str
 
        '''
        return self._orig_name
 

References psyclone.domain.lfric.function_space.FunctionSpace._orig_name, psyclone.psyGen.Argument._orig_name, and psyclone.psyir.symbols.interfaces.ImportInterface._orig_name.

Here is the caller graph for this function:

short_name()

def psyclone.domain.lfric.function_space.FunctionSpace.short_name

(

self

)

Returns the short name of this function space (original name for a
valid LFRic function space and condensed name for any_*_spaces).

:returns: short name of this function space.
:rtype: str

Definition at line 100 of file function_space.py.

    def short_name(self):
        '''
        Returns the short name of this function space (original name for a
        valid LFRic function space and condensed name for any_*_spaces).
 
        :returns: short name of this function space.
        :rtype: str
 
        '''
        return self._short_name
 

References psyclone.domain.lfric.function_space.FunctionSpace._short_name.

undf_name()

def psyclone.domain.lfric.function_space.FunctionSpace.undf_name

(

self

)

:returns: a undf name for this FunctionSpace object.
:rtype: str

Definition at line 235 of file function_space.py.

    def undf_name(self):
        ''':returns: a undf name for this FunctionSpace object.
        :rtype: str
        '''
        return "undf_" + self.mangled_name
 

References psyclone.domain.lfric.function_space.FunctionSpace.mangled_name().

Here is the call 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/domain/lfric/function_space.py