psyclone.domain.lfric.kernel.evaluator_targets_metadata.EvaluatorTargetsMetadata Class Reference

Inheritance diagram for psyclone.domain.lfric.kernel.evaluator_targets_metadata.EvaluatorTargetsMetadata:

Collaboration diagram for psyclone.domain.lfric.kernel.evaluator_targets_metadata.EvaluatorTargetsMetadata:

Public Member Functions
def	__init__ (self, evaluator_targets)
def	fortran_string (self)
def	evaluator_targets (self)
def	evaluator_targets (self, values)
Public Member Functions inherited from psyclone.domain.lfric.kernel.common_declaration_metadata.CommonDeclarationMetadata
def	validate_list (cls, values, expected_type)
Public Member Functions inherited from psyclone.domain.lfric.kernel.common_metadata.CommonMetadata
def	create_from_fortran_string (cls, fortran_string)

Static Public Member Functions
def	create_from_fparser2 (fparser2_tree)
Static Public Member Functions inherited from psyclone.domain.lfric.kernel.common_declaration_metadata.CommonDeclarationMetadata
def	scalar_declaration_string (datatype, name, value)
def	array_declaration_string (datatype, name, values)
def	type_declaration_string (datatype, name, values)
def	validate_node (fparser2_node, encoding)
def	validate_name_value (fparser2_tree, name)
def	get_intrinsic_scalar_declaration (fparser2_tree, datatype, name, valid_values)
def	get_intrinsic_array_declaration (fparser2_tree, datatype, name, valid_values)
def	get_derived_array_declaration (fparser2_tree, type_name, name, valid_values=None)
Static Public Member Functions inherited from psyclone.domain.lfric.kernel.common_metadata.CommonMetadata
def	check_fparser2 (fparser2_tree, encoding)
def	validate_scalar_value (value, valid_values, name)
def	create_fparser2 (fortran_string, encoding)

Public Attributes
	evaluator_targets

Additional Inherited Members
Static Public Attributes inherited from psyclone.domain.lfric.kernel.common_declaration_metadata.CommonDeclarationMetadata
	fparser2_class = Fortran2003.Data_Component_Def_Stmt
Static Public Attributes inherited from psyclone.domain.lfric.kernel.common_metadata.CommonMetadata
	fparser2_class = None

Detailed Description

Class to capture the values of the LFRic kernel
GH_EVALUATOR_TARGETS metadata.  This class supports the creation,
modification and Fortran output of this metadata.

if an evaluator is required for multiple function spaces then
this is specified using the gh_evaluator_targets
metadata.

:param evaluator_targets: a list of function-space names.
:type evaluator_targets: List[str]

Definition at line 45 of file evaluator_targets_metadata.py.

Member Function Documentation

create_from_fparser2()

def psyclone.domain.lfric.kernel.evaluator_targets_metadata.EvaluatorTargetsMetadata.create_from_fparser2 (   fparser2_tree )

static

Create an instance of EvaluatorTargetsMetadata from an fparser2
tree.

LFRic evaluator targets metadata is in array form. Two
versions of the array form are supported:

integer :: gh_evaluator_targets(2) = (/ w0, w1 /)
integer, dimension(2) :: gh_shape = (/ w0, w1 /)

:param fparser2_tree: fparser2 tree capturing the evaluator \
    targets metadata.
:type fparser2_tree: :py:class:`fparser.two.Fortran2003.\
    Data_Component_Def_Stmt`

:returns: an instance of EvaluatorTargetsMetadata.
:rtype: :py:class:`psyclone.domain.lfric.kernel.\
    EvaluatorTargetsMetadata`

Reimplemented from psyclone.domain.lfric.kernel.common_metadata.CommonMetadata.

Definition at line 71 of file evaluator_targets_metadata.py.

    def create_from_fparser2(fparser2_tree):
        '''Create an instance of EvaluatorTargetsMetadata from an fparser2
        tree.
 
        LFRic evaluator targets metadata is in array form. Two
        versions of the array form are supported:
 
        integer :: gh_evaluator_targets(2) = (/ w0, w1 /)
        integer, dimension(2) :: gh_shape = (/ w0, w1 /)
 
        :param fparser2_tree: fparser2 tree capturing the evaluator \
            targets metadata.
        :type fparser2_tree: :py:class:`fparser.two.Fortran2003.\
            Data_Component_Def_Stmt`
 
        :returns: an instance of EvaluatorTargetsMetadata.
        :rtype: :py:class:`psyclone.domain.lfric.kernel.\
            EvaluatorTargetsMetadata`
 
        '''
        const = LFRicConstants()
        valid_values = const.VALID_FUNCTION_SPACES
        values_list = EvaluatorTargetsMetadata.\
            get_intrinsic_array_declaration(
                fparser2_tree, "INTEGER", "GH_EVALUATOR_TARGETS", valid_values)
        return EvaluatorTargetsMetadata(values_list)
 

References psyclone.domain.lfric.kernel.common_declaration_metadata.CommonDeclarationMetadata.get_intrinsic_array_declaration().

Here is the call graph for this function:

Here is the caller graph for this function:

evaluator_targets() [1/2]

def psyclone.domain.lfric.kernel.evaluator_targets_metadata.EvaluatorTargetsMetadata.evaluator_targets

(

self

)

:returns: a list of evaluator targets values (names of \
    function spaces).
:rtype: List[str]

Definition at line 99 of file evaluator_targets_metadata.py.

    def evaluator_targets(self):
        '''
        :returns: a list of evaluator targets values (names of \
            function spaces).
        :rtype: List[str]
        '''
        return self._evaluator_targets[:]
 

References psyclone.domain.lfric.kernel.evaluator_targets_metadata.EvaluatorTargetsMetadata._evaluator_targets, and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._evaluator_targets.

evaluator_targets() [2/2]

def psyclone.domain.lfric.kernel.evaluator_targets_metadata.EvaluatorTargetsMetadata.evaluator_targets	(		self,
			values
	)

:param values: set the evaluator_targets metadata to the \
    supplied list of values.
:type values: List[str]

Definition at line 108 of file evaluator_targets_metadata.py.

    def evaluator_targets(self, values):
        '''
        :param values: set the evaluator_targets metadata to the \
            supplied list of values.
        :type values: List[str]
        '''
        const = LFRicConstants()
        EvaluatorTargetsMetadata.validate_list(values, str)
        for value in values:
            EvaluatorTargetsMetadata.validate_scalar_value(
                value, const.VALID_FUNCTION_SPACES, "evaluator_targets")
        # Take a copy of the list so that it can't be modified
        # externally. Also make all values lower case.
        self._evaluator_targets = [value.lower() for value in values]
 
 

References psyclone.domain.lfric.kernel.evaluator_targets_metadata.EvaluatorTargetsMetadata._evaluator_targets, and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._evaluator_targets.

fortran_string()

def psyclone.domain.lfric.kernel.evaluator_targets_metadata.EvaluatorTargetsMetadata.fortran_string

(

self

)

 :returns: the evaluator_targets metadata as Fortran.
 :rtype: str

Definition at line 62 of file evaluator_targets_metadata.py.

    def fortran_string(self):
        '''
         :returns: the evaluator_targets metadata as Fortran.
         :rtype: str
        '''
        return EvaluatorTargetsMetadata.array_declaration_string(
            "INTEGER", "GH_EVALUATOR_TARGETS", self._evaluator_targets)
 

References psyclone.domain.lfric.kernel.evaluator_targets_metadata.EvaluatorTargetsMetadata._evaluator_targets, and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._evaluator_targets.

Here is the caller 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/kernel/evaluator_targets_metadata.py