psyclone.domain.lfric.kernel.shapes_metadata.ShapesMetadata Class Reference

Inheritance diagram for psyclone.domain.lfric.kernel.shapes_metadata.ShapesMetadata:

Collaboration diagram for psyclone.domain.lfric.kernel.shapes_metadata.ShapesMetadata:

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

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

If an LFRic kernel requires basis or differential-basis functions
then the metadata must also specify the set of points on which
these functions are required. This information is provided by the
GH_SHAPE component of the metadata.

:param shapes: a list of shape values
:type shapes: List[str]

Definition at line 47 of file shapes_metadata.py.

Member Function Documentation

create_from_fparser2()

def psyclone.domain.lfric.kernel.shapes_metadata.ShapesMetadata.create_from_fparser2 (   fparser2_tree )

static

Create an instance of ShapesMetadata from an fparser2 tree.

LFRic shape metadata can have a scalar and array form. Two
versions of the array form are supported:
::

    integer :: gh_shape = gh_quadrature_face
    integer :: gh_shape(2) = (/ gh_quadrature_face, gh_evaluator /)
    integer, dimension(2) :: gh_shape = &
             (/ gh_quadrature_face, gh_evaluator /)

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

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

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

Definition at line 77 of file shapes_metadata.py.

    def create_from_fparser2(fparser2_tree):
        '''Create an instance of ShapesMetadata from an fparser2 tree.
 
        LFRic shape metadata can have a scalar and array form. Two
        versions of the array form are supported:
        ::
 
            integer :: gh_shape = gh_quadrature_face
            integer :: gh_shape(2) = (/ gh_quadrature_face, gh_evaluator /)
            integer, dimension(2) :: gh_shape = &
                     (/ gh_quadrature_face, gh_evaluator /)
 
        :param fparser2_tree: fparser2 tree capturing the shapes metadata
        :type fparser2_tree: :py:class:`fparser.two.Fortran2003.\
            Data_Component_Def_Stmt`
 
        :returns: an instance of ShapesMetadata.
        :rtype: :py:class:`psyclone.domain.lfric.kernel.ShapesMetadata`
 
        '''
        # As both scalar and array forms are supported we need the
        # validation from both get_intrinsic_array_declaration and
        # get_intrinsic_scalar_declaration. However, we can't call
        # these functions separately as both might raise an exception
        # and we won't know which exception to return. Instead we call
        # the validation that is common to both first and then test
        # for an array declaration to determine whether to call the
        # array or scalar validation.
        ShapesMetadata.validate_node(
            fparser2_tree, Fortran2003.Data_Component_Def_Stmt)
        ShapesMetadata.validate_name_value(
            fparser2_tree, "GH_SHAPE")
 
        const = LFRicConstants()
        valid_values = const.VALID_EVALUATOR_SHAPES
 
        component_decl_list = fparser2_tree.children[2]
        gh_shape_declaration = component_decl_list.children[0]
        if fparser2_tree.children[1] or gh_shape_declaration.children[1]:
            # This is not the scalar form so check for the array form.
            shapes_list = ShapesMetadata.get_intrinsic_array_declaration(
                fparser2_tree, "INTEGER", "GH_SHAPE", valid_values)
        else:
            # Check for the scalar form.
            shapes_value = ShapesMetadata.\
                get_intrinsic_scalar_declaration(
                    fparser2_tree, "INTEGER", "GH_SHAPE", valid_values)
            shapes_list = [shapes_value]
 
        return ShapesMetadata(shapes_list)
 

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

Here is the call graph for this function:

Here is the caller graph for this function:

fortran_string()

def psyclone.domain.lfric.kernel.shapes_metadata.ShapesMetadata.fortran_string

(

self

)

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

Definition at line 65 of file shapes_metadata.py.

    def fortran_string(self):
        '''
        :returns: the shapes metadata as Fortran.
        :rtype: str
        '''
        if len(self.shapes) == 1:
            return ShapesMetadata.scalar_declaration_string(
                "INTEGER", "GH_SHAPE", self.shapes[0])
        return ShapesMetadata.array_declaration_string(
            "INTEGER", "GH_SHAPE", self.shapes)
 

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.shapes(), and psyclone.domain.lfric.kernel.shapes_metadata.ShapesMetadata.shapes.

Here is the call graph for this function:

Here is the caller graph for this function:

shapes() [1/2]

def psyclone.domain.lfric.kernel.shapes_metadata.ShapesMetadata.shapes

(

self

)

:returns: a list of shape values
:rtype: List[str]

Definition at line 129 of file shapes_metadata.py.

    def shapes(self):
        '''
        :returns: a list of shape values
        :rtype: List[str]
        '''
        # Return a copy of the list so it can't be modified
        # externally.
        return self._shapes[:]
 

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._shapes, and psyclone.domain.lfric.kernel.shapes_metadata.ShapesMetadata._shapes.

Here is the caller graph for this function:

shapes() [2/2]

def psyclone.domain.lfric.kernel.shapes_metadata.ShapesMetadata.shapes	(		self,
			values
	)

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

Definition at line 139 of file shapes_metadata.py.

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

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._shapes, and psyclone.domain.lfric.kernel.shapes_metadata.ShapesMetadata._shapes.

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