psyclone.domain.lfric.lfric_types.LFRicTypes Class Reference

Public Member Functions
def	__new__ (cls, name)
def	__call__ (self)

Static Public Member Functions
def	init ()

Detailed Description

This class implements a singleton that manages LFRic types.
Using the 'call' interface, you can query the data type for
LFRic types, e.g.:

>>> from psyclone.configuration import Config
>>> from psyclone.domain.lfric import LFRicTypes
>>> config = Config.get()
>>> num_dofs_class = LFRicTypes("NumberOfUniqueDofsDataSymbol")
>>> my_var = num_dofs_class("my_num_dofs")
>>> print(my_var.name)
my_num_dofs

It uses the __new__ function to implement the access to the internal
dictionary. This is done to minimise the required code for getting a
value, e. g. compared with ``LFRicTypes.get()("something")``, or
``LFRicType.get("something")``.

Definition at line 52 of file lfric_types.py.

Member Function Documentation

__call__()

def psyclone.domain.lfric.lfric_types.LFRicTypes.__call__

(

self

)

This function is only here to trick pylint into thinking that
the object returned from __new__ is callable, meaning that code like:
``LFRicTypes("LFRicIntegerScalarDataType")()`` does not trigger
a pylint warning about not being callable.

Definition at line 109 of file lfric_types.py.

    def __call__(self):
        '''This function is only here to trick pylint into thinking that
        the object returned from __new__ is callable, meaning that code like:
        ``LFRicTypes("LFRicIntegerScalarDataType")()`` does not trigger
        a pylint warning about not being callable.
        '''
 

__new__()

def psyclone.domain.lfric.lfric_types.LFRicTypes.__new__	(		cls,
			name
	)

The class creation function __new__ is used to actually provide
the object the user is querying. It is well documented that __new__
can return a different instance. This function will first make sure
that the static internal dictionary is initialised (so it acts like
a singleton in that regard). Then it will return the value the user
asked for.

:param str name: the name to query for.

:returns: the corresponding object, which can be a class or an \
    instance.
:rtype: object (various types)

:raises InternalError: if there specified name is not a name for \
    an object managed here.

Definition at line 80 of file lfric_types.py.

    def __new__(cls, name):
        '''The class creation function __new__ is used to actually provide
        the object the user is querying. It is well documented that __new__
        can return a different instance. This function will first make sure
        that the static internal dictionary is initialised (so it acts like
        a singleton in that regard). Then it will return the value the user
        asked for.
 
        :param str name: the name to query for.
 
        :returns: the corresponding object, which can be a class or an \
            instance.
        :rtype: object (various types)
 
        :raises InternalError: if there specified name is not a name for \
            an object managed here.
 
        '''
        if not LFRicTypes._name_to_class:
            LFRicTypes.init()
 
        try:
            return LFRicTypes._name_to_class[name]
        except KeyError as err:
            raise InternalError(f"Unknown LFRic type '{name}'. Valid values "
                                f"are {LFRicTypes._name_to_class.keys()}") \
                  from err
 

init()

def psyclone.domain.lfric.lfric_types.LFRicTypes.init ( )

static

This method constructs the required classes and instances, and
puts them into the dictionary.

Definition at line 118 of file lfric_types.py.

    def init():
        '''This method constructs the required classes and instances, and
        puts them into the dictionary.
        '''
 
        # The global mapping of names to the corresponding classes or instances
        LFRicTypes._name_to_class = {}
 
        LFRicTypes._create_precision_from_const_module()
        LFRicTypes._create_generic_scalars()
        LFRicTypes._create_lfric_dimension()
        LFRicTypes._create_specific_scalars()
        LFRicTypes._create_fields()
 
        # Generate LFRic vector-field-data symbols as subclasses of
        # field-data symbols
        const = LFRicConstants()
        for intrinsic in const.VALID_FIELD_INTRINSIC_TYPES:
            name = f"{intrinsic.title()}VectorFieldDataSymbol"
            baseclass = LFRicTypes(f"{intrinsic.title()}FieldDataSymbol")
            LFRicTypes._name_to_class[name] = type(name, (baseclass, ), {})
 

References psyclone.psyir.nodes.intrinsic_call.IntrinsicCall.intrinsic(), psyclone.psyir.symbols.datatypes.ScalarType.intrinsic, psyclone.psyir.symbols.datatypes.ArrayType.intrinsic(), and psyclone.psyir.symbols.intrinsic_symbol.IntrinsicSymbol.intrinsic().

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/lfric_types.py