psyclone.domain.lfric.kernel.operates_on_metadata.OperatesOnMetadata Class Reference

Inheritance diagram for psyclone.domain.lfric.kernel.operates_on_metadata.OperatesOnMetadata:

Collaboration diagram for psyclone.domain.lfric.kernel.operates_on_metadata.OperatesOnMetadata:

Public Member Functions
def	__init__ (self, operates_on)
def	fortran_string (self)
def	operates_on (self)
def	operates_on (self, value)
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
	operates_on

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
OPERATES_ON metadata. This class supports the creation,
modification and Fortran output of this metadata.

OPERATES_ON metadata specifies that the Kernel has been written to
expect data in the specified form, i.e. 'cell_column' means a column
of cells and 'domain' means all cells.

:param str operates_on: the value of operates_on.

Definition at line 45 of file operates_on_metadata.py.

Member Function Documentation

create_from_fparser2()

def psyclone.domain.lfric.kernel.operates_on_metadata.OperatesOnMetadata.create_from_fparser2 (   fparser2_tree )

static

Create an instance of OperatesOnMetadata from an fparser2
tree.

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

LFRic operates_on metadata is in scalar form:

integer :: operates_on = cell_column

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

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

Definition at line 70 of file operates_on_metadata.py.

    def create_from_fparser2(fparser2_tree):
        '''Create an instance of OperatesOnMetadata from an fparser2
        tree.
 
        :param fparser2_tree: fparser2 tree capturing the operates_on \
            metadata.
        :type fparser2_tree: :py:class:`fparser.two.Fortran2003.\
            Data_Component_Def_Stmt`
 
        LFRic operates_on metadata is in scalar form:
 
        integer :: operates_on = cell_column
 
        :returns: an instance of OperatesOnMetadata.
        :rtype: :py:class:`psyclone.domain.lfric.kernel.\
            OperatesOnMetadata`
 
        '''
        const = LFRicConstants()
        valid_values = const.USER_KERNEL_ITERATION_SPACES
        value = OperatesOnMetadata.get_intrinsic_scalar_declaration(
            fparser2_tree, "INTEGER", "OPERATES_ON", valid_values)
        return OperatesOnMetadata(value)
 

Here is the caller graph for this function:

fortran_string()

def psyclone.domain.lfric.kernel.operates_on_metadata.OperatesOnMetadata.fortran_string

(

self

)

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

Definition at line 61 of file operates_on_metadata.py.

    def fortran_string(self):
        '''
         :returns: the operates_on metadata as Fortran.
         :rtype: str
        '''
        return OperatesOnMetadata.scalar_declaration_string(
            "INTEGER", "OPERATES_ON", self._operates_on)
 

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._operates_on, and psyclone.domain.lfric.kernel.operates_on_metadata.OperatesOnMetadata._operates_on.

Here is the caller graph for this function:

operates_on() [1/2]

def psyclone.domain.lfric.kernel.operates_on_metadata.OperatesOnMetadata.operates_on

(

self

)

:returns: the operates_on value.
:rtype: str

Definition at line 95 of file operates_on_metadata.py.

    def operates_on(self):
        '''
        :returns: the operates_on value.
        :rtype: str
        '''
        return self._operates_on
 

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._operates_on, and psyclone.domain.lfric.kernel.operates_on_metadata.OperatesOnMetadata._operates_on.

Here is the caller graph for this function:

operates_on() [2/2]

def psyclone.domain.lfric.kernel.operates_on_metadata.OperatesOnMetadata.operates_on	(		self,
			value
	)

:param str value: sets the operates_on metadata to the \
    supplied value.

Definition at line 103 of file operates_on_metadata.py.

    def operates_on(self, value):
        '''
        :param str value: sets the operates_on metadata to the \
            supplied value.
        '''
        const = LFRicConstants()
        OperatesOnMetadata.validate_scalar_value(
            value, const.VALID_ITERATION_SPACES, "OPERATES_ON")
        self._operates_on = value.lower()
 
 

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._operates_on, and psyclone.domain.lfric.kernel.operates_on_metadata.OperatesOnMetadata._operates_on.

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