psyclone.domain.lfric.kernel.meta_ref_element_metadata.MetaRefElementMetadata Class Reference

Inheritance diagram for psyclone.domain.lfric.kernel.meta_ref_element_metadata.MetaRefElementMetadata:

Collaboration diagram for psyclone.domain.lfric.kernel.meta_ref_element_metadata.MetaRefElementMetadata:

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

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

meta_ref_element metadata specifies properties of the reference
element.

:param meta_ref_element_args: a list of meta_ref_element arguments.
:type meta_ref_element_args: List[:py:class:`psyclone.domain.lfric.kernel.\
    MetaRefElementArgMetadata`]

Definition at line 46 of file meta_ref_element_metadata.py.

Member Function Documentation

create_from_fparser2()

def psyclone.domain.lfric.kernel.meta_ref_element_metadata.MetaRefElementMetadata.create_from_fparser2 (   fparser2_tree )

static

Create an instance of MetaRefElementMetadata from an fparser2
tree.

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

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

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

Definition at line 73 of file meta_ref_element_metadata.py.

    def create_from_fparser2(fparser2_tree):
        '''Create an instance of MetaRefElementMetadata from an fparser2
        tree.
 
        :param fparser2_tree: fparser2 tree capturing the meta \
            reference element metadata.
        :type fparser2_tree: :py:class:`fparser.two.Fortran2003.\
            Data_Component_Def_Stmt`
 
        :returns: an instance of MetaRefElementMetadata.
        :rtype: :py:class:`psyclone.domain.lfric.kernel.\
            MetaRefElementMetadata`
 
        '''
        values_list = MetaRefElementMetadata.\
            get_derived_array_declaration(
                fparser2_tree, "REFERENCE_ELEMENT_DATA_TYPE",
                "META_REFERENCE_ELEMENT")
        meta_obj_list = []
        for value in values_list:
            meta_obj_list.append(
                MetaRefElementArgMetadata.create_from_fortran_string(value))
        return MetaRefElementMetadata(meta_obj_list)
 

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

Here is the call graph for this function:

Here is the caller graph for this function:

fortran_string()

def psyclone.domain.lfric.kernel.meta_ref_element_metadata.MetaRefElementMetadata.fortran_string

(

self

)

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

Definition at line 63 of file meta_ref_element_metadata.py.

    def fortran_string(self):
        '''
        :returns: the meta_ref_element metadata as Fortran.
        :rtype: str
        '''
        return self.type_declaration_string(
            "REFERENCE_ELEMENT_DATA_TYPE", "META_REFERENCE_ELEMENT",
            self._meta_ref_element_args)
 

References psyclone.domain.lfric.kernel.meta_ref_element_metadata.MetaRefElementMetadata._meta_ref_element_args, and psyclone.domain.lfric.kernel.common_declaration_metadata.CommonDeclarationMetadata.type_declaration_string().

Here is the call graph for this function:

Here is the caller graph for this function:

meta_ref_element_args() [1/2]

def psyclone.domain.lfric.kernel.meta_ref_element_metadata.MetaRefElementMetadata.meta_ref_element_args

(

self

)

:returns: a list of meta reference element argument objects.
:rtype: List[:py:class:`psyclone.domain.lfric.kernel.\
    MetaRefElementArgMetadata`]

Definition at line 98 of file meta_ref_element_metadata.py.

    def meta_ref_element_args(self):
        '''
        :returns: a list of meta reference element argument objects.
        :rtype: List[:py:class:`psyclone.domain.lfric.kernel.\
            MetaRefElementArgMetadata`]
        '''
        return self._meta_ref_element_args[:]
 

References psyclone.domain.lfric.kernel.meta_ref_element_metadata.MetaRefElementMetadata._meta_ref_element_args.

meta_ref_element_args() [2/2]

def psyclone.domain.lfric.kernel.meta_ref_element_metadata.MetaRefElementMetadata.meta_ref_element_args	(		self,
			values
	)

:param values: set the meta_ref_element metadata to the \
    supplied list of values.
:type values: List[:py:class:`psyclone.domain.lfric.kernel.\
    MetaRefElementArgMetadata`]

Definition at line 107 of file meta_ref_element_metadata.py.

    def meta_ref_element_args(self, values):
        '''
        :param values: set the meta_ref_element metadata to the \
            supplied list of values.
        :type values: List[:py:class:`psyclone.domain.lfric.kernel.\
            MetaRefElementArgMetadata`]
 
        '''
        self.validate_list(values, MetaRefElementArgMetadata)
        # Take a copy of the list so that it can't be modified
        # externally.
        self._meta_ref_element_args = values[:]
 
 

References psyclone.domain.lfric.kernel.meta_ref_element_metadata.MetaRefElementMetadata._meta_ref_element_args, and psyclone.domain.lfric.kernel.common_declaration_metadata.CommonDeclarationMetadata.validate_list().

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/kernel/meta_ref_element_metadata.py