psyclone.domain.lfric.kernel.meta_args_metadata.MetaArgsMetadata Class Reference

Inheritance diagram for psyclone.domain.lfric.kernel.meta_args_metadata.MetaArgsMetadata:

Collaboration diagram for psyclone.domain.lfric.kernel.meta_args_metadata.MetaArgsMetadata:

Public Member Functions
def	__init__ (self, meta_args_args)
def	fortran_string (self)
def	meta_args_args (self)
def	meta_args_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_args_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_args metadata. This class supports the creation,
modification and Fortran output of this metadata.

meta_args metadata specifies information about data that the
kernel code expects to be passed to it via its argument list.

:param meta_args_args: a list of meta_args arguments.
:type meta_args_args: List[:py:class:`psyclone.domain.lfric.kernel.\
    CommonMetaArgMetadata`]

Definition at line 62 of file meta_args_metadata.py.

Member Function Documentation

create_from_fparser2()

def psyclone.domain.lfric.kernel.meta_args_metadata.MetaArgsMetadata.create_from_fparser2 (   fparser2_tree )

static

Create an instance of MetaArgsMetadata from an fparser2
tree.

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

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

:raises ParseError: if an unknown MetaArgsArgMetadata argument \
    is found.

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

Definition at line 88 of file meta_args_metadata.py.

    def create_from_fparser2(fparser2_tree):
        '''Create an instance of MetaArgsMetadata from an fparser2
        tree.
 
        :param fparser2_tree: fparser2 tree capturing the meta \
            args metadata.
        :type fparser2_tree: :py:class:`fparser.two.Fortran2003.\
            Data_Component_Def_Stmt`
 
        :returns: an instance of MetaArgsMetadata.
        :rtype: :py:class:`psyclone.domain.lfric.kernel.\
            MetaArgsMetadata`
 
        :raises ParseError: if an unknown MetaArgsArgMetadata argument \
            is found.
 
        '''
        MetaArgsMetadata.get_derived_array_declaration(
            fparser2_tree, "ARG_TYPE", "META_ARGS")
        args = walk(fparser2_tree, Fortran2003.Ac_Value_List)
        meta_args_args = []
        for meta_arg in args[0].children:
            form = meta_arg.children[1].children[0].tostr()
            form = form.lower()
            if form == "gh_scalar":
                arg = ScalarArgMetadata.create_from_fparser2(meta_arg)
            elif form == "gh_operator":
                arg = OperatorArgMetadata.create_from_fparser2(meta_arg)
            elif form == "gh_columnwise_operator":
                arg = ColumnwiseOperatorArgMetadata.create_from_fparser2(
                    meta_arg)
            elif "gh_field" in form:
                vector_arg = "*" in form
                nargs = len(meta_arg.children[1].children)
                intergrid_arg = False
                if nargs == 5:
                    fifth_arg = meta_arg.children[1].children[4]
                    intergrid_arg = (
                        fifth_arg.children and
                        fifth_arg.children[0].string.lower() == "mesh_arg")
 
                if intergrid_arg and vector_arg:
                    arg = InterGridVectorArgMetadata.create_from_fparser2(
                        meta_arg)
                elif intergrid_arg and not vector_arg:
                    arg = InterGridArgMetadata.create_from_fparser2(meta_arg)
                elif vector_arg and not intergrid_arg:
                    arg = FieldVectorArgMetadata.create_from_fparser2(meta_arg)
                else:
                    arg = FieldArgMetadata.create_from_fparser2(meta_arg)
            else:
                raise ParseError(
                    f"Expected a 'meta_arg' entry to be a "
                    f"field, a scalar or an operator, but found "
                    f"'{meta_arg}'.")
            meta_args_args.append(arg)
        return MetaArgsMetadata(meta_args_args)
 

Here is the caller graph for this function:

fortran_string()

def psyclone.domain.lfric.kernel.meta_args_metadata.MetaArgsMetadata.fortran_string

(

self

)

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

Definition at line 79 of file meta_args_metadata.py.

    def fortran_string(self):
        '''
        :returns: the meta_args metadata as Fortran.
        :rtype: str
        '''
        return self.type_declaration_string(
            "ARG_TYPE", "META_ARGS", self._meta_args_args)
 

References psyclone.domain.lfric.kernel.meta_args_metadata.MetaArgsMetadata._meta_args_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_args_args() [1/2]

def psyclone.domain.lfric.kernel.meta_args_metadata.MetaArgsMetadata.meta_args_args

(

self

)

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

Definition at line 147 of file meta_args_metadata.py.

    def meta_args_args(self):
        '''
        :returns: a list of meta args argument objects.
        :rtype: List[:py:class:`psyclone.domain.lfric.kernel.\
            CommonArg`]
        '''
        return self._meta_args_args[:]
 

References psyclone.domain.lfric.kernel.meta_args_metadata.MetaArgsMetadata._meta_args_args.

meta_args_args() [2/2]

def psyclone.domain.lfric.kernel.meta_args_metadata.MetaArgsMetadata.meta_args_args	(		self,
			values
	)

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

Definition at line 156 of file meta_args_metadata.py.

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

References psyclone.domain.lfric.kernel.meta_args_metadata.MetaArgsMetadata._meta_args_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_args_metadata.py