psyclone.domain.lfric.lfric_constants.LFRicConstants Class Reference

Public Member Functions
def	__init__ (self)
def	precision_for_type (self, data_type)

Static Public Member Functions
def	specific_function_space (name)

Static Public Attributes
bool	HAS_BEEN_INITIALISED = False

Detailed Description

This class stores all LFRic constants. Note that some constants
depend on values in the config file, so this class can only be
used after the config file has been read.
It stores all values in class variables (to avoid re-evaluating them).

Definition at line 50 of file lfric_constants.py.

Member Function Documentation

precision_for_type()

def psyclone.domain.lfric.lfric_constants.LFRicConstants.precision_for_type	(		self,
			data_type
	)

This function returns the precision required for the various
LFRic types.

:param str data_type: the name of the data type.

:returns: the precision as defined in domain.lfric.lfric_types
    (one of R_SOLVER, R_TRAN, R_DEF).
:rtype: :py:class:`psyclone.psyir.symbols.DataSymbol`

:raises InternalError: if an unknown data_type is specified.

Definition at line 503 of file lfric_constants.py.

    def precision_for_type(self, data_type):
        '''This function returns the precision required for the various
        LFRic types.
 
        :param str data_type: the name of the data type.
 
        :returns: the precision as defined in domain.lfric.lfric_types
            (one of R_SOLVER, R_TRAN, R_DEF).
        :rtype: :py:class:`psyclone.psyir.symbols.DataSymbol`
 
        :raises InternalError: if an unknown data_type is specified.
 
        '''
        for module_info in self.DATA_TYPE_MAP.values():
            if module_info["type"] == data_type:
                # pylint: disable=import-outside-toplevel
                from psyclone.domain.lfric.lfric_types import LFRicTypes
                return LFRicTypes(module_info["kind"].upper())
 
        valid = [module_info["type"]
                 for module_info in self.DATA_TYPE_MAP.values()]
        raise InternalError(f"Unknown data type '{data_type}', expected one "
                            f"of {valid}.")
 
 
# =============================================================================
# Documentation utils: The list of module members that we wish AutoAPI to
# generate documentation for (see https://psyclone-ref.readthedocs.io).

specific_function_space()

def psyclone.domain.lfric.lfric_constants.LFRicConstants.specific_function_space (   name )

static

Maps from a valid kernel metadata function-space name to one
that exists within the LFRic infrastructure. This is necessary
because meta-data can contain 'generic' names such as 'any_w2' but,
when generating code, we need the name of a specific function space
that is recognised by the LFRic infrastructure.

:param str name: the name of the function space in metadata.

:returns: the name of a specific function space.
:rtype: str

:raises ValueError: if the supplied name is not a valid LFRic \
                    function-space name.
:raises InternalError: if an unrecognised wildcard function-space \
                       name is supplied.

Definition at line 465 of file lfric_constants.py.

    def specific_function_space(name):
        '''
        Maps from a valid kernel metadata function-space name to one
        that exists within the LFRic infrastructure. This is necessary
        because meta-data can contain 'generic' names such as 'any_w2' but,
        when generating code, we need the name of a specific function space
        that is recognised by the LFRic infrastructure.
 
        :param str name: the name of the function space in metadata.
 
        :returns: the name of a specific function space.
        :rtype: str
 
        :raises ValueError: if the supplied name is not a valid LFRic \
                            function-space name.
        :raises InternalError: if an unrecognised wildcard function-space \
                               name is supplied.
        '''
        space = name.lower()
        if space not in LFRicConstants.VALID_FUNCTION_SPACE_NAMES:
            raise ValueError(
                f"'{space}' is not a recognised LFRic function space (one of "
                f"{LFRicConstants.VALID_FUNCTION_SPACE_NAMES}).")
 
        # TODO #1709 - make this mapping configurable rather than
        # hardwiring it here.
        if not space.startswith("any_"):
            return space
        if space == "any_w2":
            return "w2"
        if space.startswith("any_space_"):
            return LFRicConstants.CONTINUOUS_FUNCTION_SPACES[0]
        if space.startswith("any_discontinuous_space_"):
            return LFRicConstants.DISCONTINUOUS_FUNCTION_SPACES[0]
 
        raise InternalError(f"Error mapping from meta-data function space "
                            f"to actual space: cannot handle '{space}'")
 

---

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_constants.py