Inheritance diagram for psyclone.domain.lfric.kernel.meta_mesh_metadata.MetaMeshMetadata:

[legend]

Collaboration diagram for psyclone.domain.lfric.kernel.meta_mesh_metadata.MetaMeshMetadata:

[legend]

Public Member Functions
def	__init__ (self, meta_mesh_args)

def	fortran_string (self)

def	meta_mesh_args (self)

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

meta_mesh metadata specifies properties of the LFRic mesh object
that are required by a kernel.

:param meta_mesh_args: a list of meta_mesh arguments.
:type meta_mesh_args: List[:py:class:`psyclone.domain.lfric.kernel.\
    MetaMeshArgMetadata`]

Definition at line 46 of file meta_mesh_metadata.py.

Member Function Documentation

◆ create_from_fparser2()

def psyclone.domain.lfric.kernel.meta_mesh_metadata.MetaMeshMetadata.create_from_fparser2 ( fparser2_tree )

static

Create an instance of MetaMeshMetadata from an fparser2
tree.

LFRic meta mesh metadata is in array form. Two
versions of the array form are supported:

type(mesh_data_type) :: meta_mesh(1) = (/ ... /)
type(mesh_data_type), dimension(1) :: meta_mesh = (/ ... /)

:param fparser2_tree: fparser2 tree capturing the meta \
    mesh metadata.

:type fparser2_tree: :py:class:`fparser.two.Fortran2003.\
    Data_Component_Def_Stmt`

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

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

Definition at line 72 of file meta_mesh_metadata.py.

     def create_from_fparser2(fparser2_tree):
         '''Create an instance of MetaMeshMetadata from an fparser2
         tree.
  
         LFRic meta mesh metadata is in array form. Two
         versions of the array form are supported:
  
         type(mesh_data_type) :: meta_mesh(1) = (/ ... /)
         type(mesh_data_type), dimension(1) :: meta_mesh = (/ ... /)
  
         :param fparser2_tree: fparser2 tree capturing the meta \
             mesh metadata.
  
         :type fparser2_tree: :py:class:`fparser.two.Fortran2003.\
             Data_Component_Def_Stmt`
  
         :returns: an instance of MetaMeshMetadata.
         :rtype: :py:class:`psyclone.domain.lfric.kernel.\
             MetaMeshMetadata`
  
         '''
         values_list = MetaMeshMetadata.get_derived_array_declaration(
             fparser2_tree, "MESH_DATA_TYPE", "META_MESH")
         meta_obj_list = []
         for value in values_list:
             meta_obj_list.append(
                 MetaMeshArgMetadata.create_from_fortran_string(value))
         return MetaMeshMetadata(meta_obj_list)
  

Here is the caller graph for this function:

◆ fortran_string()

def psyclone.domain.lfric.kernel.meta_mesh_metadata.MetaMeshMetadata.fortran_string ( self )

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

Definition at line 63 of file meta_mesh_metadata.py.

     def fortran_string(self):
         '''
         :returns: the meta_mesh metadata as Fortran.
         :rtype: str
         '''
         return self.type_declaration_string(
             "MESH_DATA_TYPE", "META_MESH", self._meta_mesh_args)
  

References psyclone.domain.lfric.kernel.meta_mesh_metadata.MetaMeshMetadata._meta_mesh_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_mesh_args() [1/2]

def psyclone.domain.lfric.kernel.meta_mesh_metadata.MetaMeshMetadata.meta_mesh_args ( self )

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

Definition at line 102 of file meta_mesh_metadata.py.

     def meta_mesh_args(self):
         '''
         :returns: a list of meta mesh argument objects.
         :rtype: List[:py:class:`psyclone.domain.lfric.kernel.\
             MetaMeshArgMetadata`]
         '''
         return self._meta_mesh_args[:]
  

References psyclone.domain.lfric.kernel.meta_mesh_metadata.MetaMeshMetadata._meta_mesh_args.

◆ meta_mesh_args() [2/2]

def psyclone.domain.lfric.kernel.meta_mesh_metadata.MetaMeshMetadata.meta_mesh_args	(	self,
		values
	)

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

Definition at line 111 of file meta_mesh_metadata.py.

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

References psyclone.domain.lfric.kernel.meta_mesh_metadata.MetaMeshMetadata._meta_mesh_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_mesh_metadata.py

Public Member Functions

Static Public Member Functions