Inheritance diagram for psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata:

Collaboration diagram for psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata:

Public Member Functions
def	__init__ (self, operates_on=None, shapes=None, evaluator_targets=None, meta_args=None, meta_funcs=None, meta_ref_element=None, meta_mesh=None, procedure_name=None, name=None)

def	validate (self)

def	lower_to_psyir (self)

def	fortran_string (self)

def	kernel_type (self)

def	operates_on (self)

def	operates_on (self, value)

def	shapes (self)

def	shapes (self, values)

def	evaluator_targets (self)

def	evaluator_targets (self, values)

def	meta_args (self)

def	meta_args (self, values)

def	meta_funcs (self)

def	meta_funcs (self, values)

def	meta_ref_element (self)

def	meta_ref_element (self, values)

def	meta_mesh (self)

def	meta_mesh (self, values)

def	procedure_name (self)

def	procedure_name (self, value)

def	name (self)

def	name (self, value)

def	meta_args_get (self, types)

def	field_meta_args_on_fs (self, arg_types, function_space)

def	operator_meta_args_on_fs (self, arg_types, function_space)

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_psyir (symbol)

def	create_from_fparser2 (fparser2_tree)

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
	procedure_name

	name

	operates_on

Static Public Attributes
	fparser2_class = Fortran2003.Derived_Type_Def

Static Public Attributes inherited from psyclone.domain.lfric.kernel.common_metadata.CommonMetadata
	fparser2_class = None

Detailed Description

Contains LFRic kernel metadata. This class supports kernel
metadata creation, modification, loading from a fortran string,
writing to a fortran string, raising from existing language-level
PSyIR and lowering to language-level PSyIR.

:param operates_on: the name of the quantity that this kernel is \
    intended to iterate over.
:type operates_on: Optional[str]
:param shapes: if a 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.
:type shapes: Optional[List[str]]
:param evaluator_targets: the function spaces on which an \
    evaluator is required.
:type evaluator_targets: Optional[List[str]]
:param meta_args: a list of 'meta_arg' objects which capture the \
    metadata values of the kernel arguments.
:type meta_args: Optional[List[:py:class:`psyclone.domain.lfric.kernel.\
    CommonArgMetadata`]]
:param meta_funcs: a list of 'meta_func' objects which capture whether \
    quadrature or evaluator data is required for a given function space.
:type meta_funcs: Optional[List[:py:class:`psyclone.domain.lfric.kernel.\
    MetaFuncsArgMetadata`]]
:param meta_ref_element: a kernel that requires properties \
    of the reference element in LFRic specifies those properties \
    through the meta_reference_element metadata entry.
:type meta_ref_element: Optional[:py:class:`psyclone.domain.lfric.kernel.\
    RefElementArgMetadata`]
:param meta_mesh: a kernel that requires properties of the LFRic \
    mesh object specifies those properties through the meta_mesh \
    metadata entry.
:type meta_mesh: Optional[:py:class:`psyclone.domain.lfric.kernel.\
    MetaMeshArgMetadata`]
:param procedure_name: the name of the kernel procedure to call.
:type procedure_name: Optional[str]
:param name: the name of the symbol to use for the metadata in \
    language-level PSyIR.
:type name: Optional[str]

Definition at line 84 of file lfric_kernel_metadata.py.

Member Function Documentation

◆ create_from_fparser2()

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.create_from_fparser2 ( fparser2_tree )

static

Create an instance of this class from an fparser2 tree.

:param fparser2_tree: fparser2 tree containing the metadata \
    for an LFRic Kernel.
:type fparser2_tree: \
    :py:class:`fparser.two.Fortran2003.Derived_Type_Ref`

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

:raises ParseError: if one of the meta_args entries is an \
    unexpected type.
:raises ParseError: if the metadata type does not extend kernel_type.

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

Definition at line 713 of file lfric_kernel_metadata.py.

     def create_from_fparser2(fparser2_tree):
         '''Create an instance of this class from an fparser2 tree.
  
         :param fparser2_tree: fparser2 tree containing the metadata \
             for an LFRic Kernel.
         :type fparser2_tree: \
             :py:class:`fparser.two.Fortran2003.Derived_Type_Ref`
  
         :returns: an instance of LFRicKernelMetadata.
         :rtype: :py:class:`psyclone.domain.lfric.kernel.psyir.\
             LFRicKernelMetadata`
  
         :raises ParseError: if one of the meta_args entries is an \
             unexpected type.
         :raises ParseError: if the metadata type does not extend kernel_type.
  
         '''
         LFRicKernelMetadata.check_fparser2(
             fparser2_tree, Fortran2003.Derived_Type_Def)
  
         kernel_metadata = LFRicKernelMetadata()
  
         for fparser2_node in walk(
                 fparser2_tree, Fortran2003.Data_Component_Def_Stmt):
             fortran_string = str(fparser2_node).lower()
             # pylint: disable=protected-access
             if "operates_on" in fortran_string:
                 # the value of operates on (CELL_COLUMN, ...)
                 kernel_metadata._operates_on = OperatesOnMetadata.\
                     create_from_fparser2(fparser2_node)
             elif "meta_args" in fortran_string:
                 kernel_metadata._meta_args = MetaArgsMetadata.\
                     create_from_fparser2(fparser2_node)
             elif "meta_funcs" in fortran_string:
                 kernel_metadata._meta_funcs = MetaFuncsMetadata.\
                     create_from_fparser2(fparser2_node)
             elif "gh_shape" in fortran_string:
                 # the gh_shape values (gh_quadrature_XYoZ, ...)
                 kernel_metadata._shapes = ShapesMetadata.create_from_fparser2(
                     fparser2_node)
             elif "gh_evaluator_targets" in fortran_string:
                 # the gh_evaluator_targets values (w0, w1, ...)
                 kernel_metadata._evaluator_targets = EvaluatorTargetsMetadata.\
                     create_from_fparser2(fparser2_node)
             elif "meta_reference_element" in fortran_string:
                 kernel_metadata._meta_ref_element = MetaRefElementMetadata.\
                     create_from_fparser2(fparser2_node)
             elif "meta_mesh" in fortran_string:
                 kernel_metadata._meta_mesh = MetaMeshMetadata.\
                     create_from_fparser2(fparser2_node)
             else:
                 raise ParseError(
                     f"Found unexpected metadata declaration "
                     f"'{str(fparser2_node)}' in '{str(fparser2_tree)}'.")
             # pylint: enable=protected-access
  
         kernel_metadata.name = fparser2_tree.children[0].children[1].tostr()
  
         attribute_list = fparser2_tree.children[0].children[0]
         str_attribute_list = str(attribute_list).lower() \
             if attribute_list else ""
         if (attribute_list is None or
                 "extends(kernel_type)" not in str_attribute_list):
             raise ParseError(
                 f"The metadata type declaration should extend kernel_type, "
                 f"but found '{fparser2_tree.children[0]}' in {fparser2_tree}.")
         kernel_metadata.procedure_name = \
             LFRicKernelMetadata._get_procedure_name(fparser2_tree)
  
         return kernel_metadata
  

Here is the caller graph for this function:

◆ create_from_psyir()

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.create_from_psyir ( symbol )

static

Create a new instance of LFRicKernelMetadata populated with
metadata from a kernel in language-level PSyIR.

:param symbol: the symbol in which the metadata is stored \
    in language-level PSyIR.
:type symbol: :py:class:`psyclone.psyir.symbols.DataTypeSymbol`

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

:raises TypeError: if the symbol argument is not the expected \
    type.
:raises InternalError: if the datatype of the provided symbol \
    is not the expected type.

Definition at line 676 of file lfric_kernel_metadata.py.

     def create_from_psyir(symbol):
         '''Create a new instance of LFRicKernelMetadata populated with
         metadata from a kernel in language-level PSyIR.
  
         :param symbol: the symbol in which the metadata is stored \
             in language-level PSyIR.
         :type symbol: :py:class:`psyclone.psyir.symbols.DataTypeSymbol`
  
         :returns: an instance of LFRicKernelMetadata.
         :rtype: :py:class:`psyclone.domain.lfric.kernel.psyir.\
             LFRicKernelMetadata`
  
         :raises TypeError: if the symbol argument is not the expected \
             type.
         :raises InternalError: if the datatype of the provided symbol \
             is not the expected type.
  
         '''
         if not isinstance(symbol, DataTypeSymbol):
             raise TypeError(
                 f"Expected a DataTypeSymbol but found a "
                 f"{type(symbol).__name__}.")
  
         datatype = symbol.datatype
  
         if not isinstance(datatype, UnsupportedFortranType):
             raise InternalError(
                 f"Expected kernel metadata to be stored in the PSyIR as "
                 f"an UnsupportedFortranType, but found "
                 f"{type(datatype).__name__}.")
  
         # In an UnsupportedFortranType, the declaration is stored as a
         # string, so use create_from_fortran_string()
         return LFRicKernelMetadata.create_from_fortran_string(
             datatype.declaration)
  

◆ evaluator_targets() [1/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.evaluator_targets ( self )

:returns: a list of evaluator_targets metadata values.
:rtype: Optional[List[str]]

Definition at line 952 of file lfric_kernel_metadata.py.

     def evaluator_targets(self):
         '''
         :returns: a list of evaluator_targets metadata values.
         :rtype: Optional[List[str]]
  
         '''
         if self._evaluator_targets is None:
             return None
         return self._evaluator_targets.evaluator_targets
  

References psyclone.domain.lfric.kernel.evaluator_targets_metadata.EvaluatorTargetsMetadata._evaluator_targets, and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._evaluator_targets.

Here is the caller graph for this function:

◆ evaluator_targets() [2/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.evaluator_targets	(	self,
		values
	)

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

Definition at line 963 of file lfric_kernel_metadata.py.

     def evaluator_targets(self, values):
         '''
         :param values: set the evaluator_targets metadata to the \
             supplied list of values.
         :type values: List[str]
  
         '''
         self._evaluator_targets = EvaluatorTargetsMetadata(values)
  

References psyclone.domain.lfric.kernel.evaluator_targets_metadata.EvaluatorTargetsMetadata._evaluator_targets, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._evaluator_targets, and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.evaluator_targets().

Here is the call graph for this function:

◆ field_meta_args_on_fs()

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.field_meta_args_on_fs	(	self,
		arg_types,
		function_space
	)

Utility function to return any field (plus field vector, intergrid
or intergrid vector) meta_args in metadata that have the same
type as those specified in arg_types and are on the function
space specified in function_space.

:param arg_types: meta_arg classes indicating which meta_arg \
    arguments to check.
:type arg_types: \
    :py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata` or \
    List[ \
    :py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata`]
:param str function_space: the specified function space.

:returns: a list of meta_args.
:type arg_types: List[ \
    :py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata`]

Definition at line 1151 of file lfric_kernel_metadata.py.

     def field_meta_args_on_fs(self, arg_types, function_space):
         '''Utility function to return any field (plus field vector, intergrid
         or intergrid vector) meta_args in metadata that have the same
         type as those specified in arg_types and are on the function
         space specified in function_space.
  
         :param arg_types: meta_arg classes indicating which meta_arg \
             arguments to check.
         :type arg_types: \
             :py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata` or \
             List[ \
             :py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata`]
         :param str function_space: the specified function space.
  
         :returns: a list of meta_args.
         :type arg_types: List[ \
             :py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata`]
  
         '''
         return [arg for arg in self.meta_args_get(arg_types)
                 if arg.function_space == function_space]
  

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_args_get().

Here is the call graph for this function:

◆ fortran_string()

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.fortran_string ( self )

:returns: the metadata represented by this instance as Fortran.
:rtype: str

:raises ValueError: if the values for name, meta_arg, \
    operates_on and procedure_name have not been set.

Definition at line 841 of file lfric_kernel_metadata.py.

     def fortran_string(self):
         '''
         :returns: the metadata represented by this instance as Fortran.
         :rtype: str
  
         :raises ValueError: if the values for name, meta_arg, \
             operates_on and procedure_name have not been set.
  
         '''
         if not (self.operates_on and self._meta_args and self.name):
             raise ValueError(
                 f"Values for operates_on, meta_args and name "
                 f"must be provided before calling the fortran_string method, "
                 f"but found '{self.operates_on}', '{self._meta_args}' "
                 f"and '{self.name}' respectively.")
  
         operates_on = f"  {self._operates_on.fortran_string()}"
         meta_args = f"  {self._meta_args.fortran_string()}"
  
         shapes = ""
         if self._shapes:
             shapes = f"  {self._shapes.fortran_string()}"
  
         evaluator_targets = ""
         if self._evaluator_targets:
             evaluator_targets = f"  {self._evaluator_targets.fortran_string()}"
  
         meta_funcs = ""
         if self._meta_funcs:
             meta_funcs = f"  {self._meta_funcs.fortran_string()}"
  
         meta_ref_element = ""
         if self._meta_ref_element:
             meta_ref_element = f"  {self._meta_ref_element.fortran_string()}"
  
         meta_mesh = ""
         if self._meta_mesh:
             meta_mesh = f"  {self._meta_mesh.fortran_string()}"
  
         # TODO Issue #1946: potentially update the metadata to capture
         # interface names as well as the interface itself. The
         # procedure name will then no longer be optional.
         procedure = ""
         if self.procedure_name:
             procedure = (
                 f"  CONTAINS\n"
                 f"    PROCEDURE, NOPASS :: {self.procedure_name}\n")
  
         result = (
             f"TYPE, PUBLIC, EXTENDS(kernel_type) :: {self.name}\n"
             f"{meta_args}"
             f"{meta_funcs}"
             f"{meta_ref_element}"
             f"{meta_mesh}"
             f"{shapes}"
             f"{evaluator_targets}"
             f"{operates_on}"
             f"{procedure}"
             f"END TYPE {self.name}\n")
         return result
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ kernel_type()

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.kernel_type ( self )

:returns: the type of kernel that this is.
:rtype: str

Definition at line 903 of file lfric_kernel_metadata.py.

     def kernel_type(self):
         '''
         :returns: the type of kernel that this is.
         :rtype: str
         '''
         return self._get_kernel_type()
  

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._get_kernel_type().

Here is the call graph for this function:

◆ lower_to_psyir()

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.lower_to_psyir ( self )

Lower the metadata to language-level PSyIR.

:returns: metadata as stored in language-level PSyIR.
:rtype: :py:class:`psyclone.psyir.symbols.DataTypeSymbol`

Definition at line 784 of file lfric_kernel_metadata.py.

     def lower_to_psyir(self):
         '''Lower the metadata to language-level PSyIR.
  
         :returns: metadata as stored in language-level PSyIR.
         :rtype: :py:class:`psyclone.psyir.symbols.DataTypeSymbol`
  
         '''
         return DataTypeSymbol(
             str(self.name), UnsupportedFortranType(self.fortran_string()))
  

Here is the call graph for this function:

◆ meta_args() [1/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_args ( self )

:returns: a list of 'meta_arg' objects which capture the \
    metadata values of the kernel arguments.
:rtype: Optional[List[:py:class:`psyclone.domain.lfric.kernel.\
    CommonArg`]]

Definition at line 973 of file lfric_kernel_metadata.py.

     def meta_args(self):
         '''
         :returns: a list of 'meta_arg' objects which capture the \
             metadata values of the kernel arguments.
         :rtype: Optional[List[:py:class:`psyclone.domain.lfric.kernel.\
             CommonArg`]]
  
         '''
         if self._meta_args is None:
             return None
         return self._meta_args.meta_args_args
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._meta_args, and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._meta_args.

Here is the caller graph for this function:

◆ meta_args() [2/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_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 986 of file lfric_kernel_metadata.py.

     def meta_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._meta_args = MetaArgsMetadata(values)
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._meta_args, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._meta_args, and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_args().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ meta_args_get()

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_args_get	(	self,
		types
	)

Return a list of meta_args entries with names that match the
'types' argument.

:param types: a meta_arg type or list of meta_arg types.
:type names: :py:class:`psyclone.domain.lfric.kernel.\
    CommonMetaArgMetadata` or List[:py:class:`psyclone.domain.\
    lfric.kernel.CommonMetaArgMetadata`]

:returns: a list of meta_args entries.
:rtype: List[
    py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata`]

:raises TypeError: if the types argument is not of the correct type.

Definition at line 1113 of file lfric_kernel_metadata.py.

     def meta_args_get(self, types):
         '''Return a list of meta_args entries with names that match the
         'types' argument.
  
         :param types: a meta_arg type or list of meta_arg types.
         :type names: :py:class:`psyclone.domain.lfric.kernel.\
             CommonMetaArgMetadata` or List[:py:class:`psyclone.domain.\
             lfric.kernel.CommonMetaArgMetadata`]
  
         :returns: a list of meta_args entries.
         :rtype: List[
             py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata`]
  
         :raises TypeError: if the types argument is not of the correct type.
  
         '''
         if not (isinstance(types, list) or
                 (inspect.isclass(types) and
                  issubclass(types, CommonMetaArgMetadata))):
             raise TypeError(
                 f"Expected a subclass of CommonMetaArgMetadata or a list for "
                 f"the 'types' argument, but found '{type(types).__name__}'.")
         if isinstance(types, list):
             my_types = types
         else:
             my_types = [types]
         for my_type in my_types:
             if not (inspect.isclass(my_type) and
                     issubclass(my_type, CommonMetaArgMetadata)):
                 raise TypeError(
                     f"Expected list entries in the 'types' argument to be "
                     f"subclasses of CommonMetaArgMetadata, but found "
                     f"'{type(my_type).__name__}'.")
         if not self.meta_args:
             return []
         return [meta_arg for meta_arg in self.meta_args
                 if type(meta_arg) in my_types]
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.meta_args(), and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_args().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ meta_funcs() [1/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_funcs ( self )

:returns: a list of meta_funcs metadata values.
:rtype: Optional[List[:py:class:`psyclone.domain.lfric.kernel.\
    MetaFuncsArgMetadata`]]

Definition at line 997 of file lfric_kernel_metadata.py.

     def meta_funcs(self):
         '''
         :returns: a list of meta_funcs metadata values.
         :rtype: Optional[List[:py:class:`psyclone.domain.lfric.kernel.\
             MetaFuncsArgMetadata`]]
  
         '''
         if self._meta_funcs is None:
             return None
         return self._meta_funcs.meta_funcs_args
  

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._meta_funcs.

Here is the caller graph for this function:

◆ meta_funcs() [2/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_funcs	(	self,
		values
	)

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

Definition at line 1009 of file lfric_kernel_metadata.py.

     def meta_funcs(self, values):
         '''
         :param values: set the meta_funcs metadata to the \
             supplied list of values.
         :type values: List[:py:class:`psyclone.domain.lfric.kernel.\
             MetaFuncsArgMetadata`]
  
         '''
         self._meta_funcs = MetaFuncsMetadata(values)
  

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._meta_funcs, and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_funcs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ meta_mesh() [1/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_mesh ( self )

:returns: a list of meta_mesh metadata values.
:rtype: Optional[List[:py:class:`psyclone.domain.lfric.kernel.\
    MetaMeshArgMetadata`]]

Definition at line 1043 of file lfric_kernel_metadata.py.

     def meta_mesh(self):
         '''
         :returns: a list of meta_mesh metadata values.
         :rtype: Optional[List[:py:class:`psyclone.domain.lfric.kernel.\
             MetaMeshArgMetadata`]]
  
         '''
         if self._meta_mesh is None:
             return None
         return self._meta_mesh.meta_mesh_args
  

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._meta_mesh.

Here is the caller graph for this function:

◆ meta_mesh() [2/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_mesh	(	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 1055 of file lfric_kernel_metadata.py.

     def meta_mesh(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._meta_mesh = MetaMeshMetadata(values)
  

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._meta_mesh, and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ meta_ref_element() [1/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_ref_element ( self )

:returns: a list of meta_reference_element metadata values.
:rtype: Optional[List[:py:class:`psyclone.domain.lfric.kernel.\
    MetaRefElementArgMetadata`]]

Definition at line 1020 of file lfric_kernel_metadata.py.

     def meta_ref_element(self):
         '''
         :returns: a list of meta_reference_element metadata values.
         :rtype: Optional[List[:py:class:`psyclone.domain.lfric.kernel.\
             MetaRefElementArgMetadata`]]
  
         '''
         if self._meta_ref_element is None:
             return None
         return self._meta_ref_element.meta_ref_element_args
  

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._meta_ref_element.

Here is the caller graph for this function:

◆ meta_ref_element() [2/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_ref_element	(	self,
		values
	)

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

Definition at line 1032 of file lfric_kernel_metadata.py.

     def meta_ref_element(self, values):
         '''
         :param values: set the meta_funcs metadata to the \
             supplied list of values.
         :type values: List[:py:class:`psyclone.domain.lfric.kernel.\
             MetaRefElementArgMetadata`]
  
         '''
         self._meta_ref_element = MetaRefElementMetadata(values)
  

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._meta_ref_element, and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_ref_element().

Here is the call graph for this function:

◆ name() [1/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.name ( self )

:returns: the name of the symbol that will contain the \
    metadata when lowering.
:rtype: str

Definition at line 1092 of file lfric_kernel_metadata.py.

     def name(self):
         '''
         :returns: the name of the symbol that will contain the \
             metadata when lowering.
         :rtype: str
  
         '''
         return self._name
  

References psyclone.domain.common.algorithm.psyir.AlgorithmInvokeCall._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._name, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._name, psyclone.dynamo0p3.DynFuncDescriptor03._name, psyclone.expression.NamedArg._name, psyclone.gocean1p0.GOKernelGridArgument._name, psyclone.gocean1p0.GOStencil._name, psyclone.nemo.NemoInvoke._name, psyclone.nemo.NemoPSy._name, psyclone.parse.algorithm.FileInfo._name, psyclone.parse.algorithm.InvokeCall._name, psyclone.parse.kernel.KernelProcedure._name, psyclone.parse.kernel.KernelType._name, psyclone.parse.module_info.ModuleInfo._name, psyclone.psyGen.PSy._name, psyclone.psyGen.Invoke._name, psyclone.psyGen.Kern._name, psyclone.psyGen.Argument._name, psyclone.psyir.nodes.container.Container._name, psyclone.psyir.nodes.routine.Routine._name, and psyclone.psyir.symbols.symbol.Symbol._name.

Here is the caller graph for this function:

◆ name() [2/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.name	(	self,
		value
	)

:param str value: set the name of the symbol that will contain \
    the metadata when lowering.

:raises ValueError: if the name is not valid.

Definition at line 1102 of file lfric_kernel_metadata.py.

     def name(self, value):
         '''
         :param str value: set the name of the symbol that will contain \
             the metadata when lowering.
  
         :raises ValueError: if the name is not valid.
  
         '''
         FortranReader.validate_name(value)
         self._name = value
  

References psyclone.domain.common.algorithm.psyir.AlgorithmInvokeCall._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._name, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._name, psyclone.dynamo0p3.DynFuncDescriptor03._name, psyclone.expression.NamedArg._name, psyclone.gocean1p0.GOKernelGridArgument._name, psyclone.gocean1p0.GOStencil._name, psyclone.nemo.NemoInvoke._name, psyclone.nemo.NemoPSy._name, psyclone.parse.algorithm.FileInfo._name, psyclone.parse.algorithm.InvokeCall._name, psyclone.parse.kernel.KernelProcedure._name, psyclone.parse.kernel.KernelType._name, psyclone.parse.module_info.ModuleInfo._name, psyclone.psyGen.PSy._name, psyclone.psyGen.Invoke._name, psyclone.psyGen.Kern._name, psyclone.psyGen.Argument._name, psyclone.psyir.nodes.container.Container._name, psyclone.psyir.nodes.routine.Routine._name, and psyclone.psyir.symbols.symbol.Symbol._name.

Here is the caller graph for this function:

◆ operates_on() [1/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.operates_on ( self )

:returns: the kernel operates_on property specified by the \
    metadata.
:rtype: str

Definition at line 911 of file lfric_kernel_metadata.py.

     def operates_on(self):
         '''
         :returns: the kernel operates_on property specified by the \
             metadata.
         :rtype: str
         '''
         if self._operates_on is None:
             return None
         return self._operates_on.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.lfric_kernel_metadata.LFRicKernelMetadata.operates_on	(	self,
		value
	)

:param str value: set the kernel operates_on property \
    in the metadata to the specified value.

Definition at line 922 of file lfric_kernel_metadata.py.

     def operates_on(self, value):
         '''
         :param str value: set the kernel operates_on property \
             in the metadata to the specified value.
  
         '''
         self._operates_on = OperatesOnMetadata(value)
  

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:

◆ operator_meta_args_on_fs()

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.operator_meta_args_on_fs	(	self,
		arg_types,
		function_space
	)

Utility function to return any operator meta_args in metadata that
have the same type as those specified in arg_types and their
from or to function spaces are the same as the function space
specified in function_space.

:param arg_types: meta_arg classes indicating which meta_arg \
    arguments to check.
:type arg_types: \
    :py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata` or \
    List[ \
    :py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata`]
:param str function_space: the specified function space.

:returns: a list of meta_args.
:type arg_types: List[ \
    :py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata`]

Definition at line 1173 of file lfric_kernel_metadata.py.

     def operator_meta_args_on_fs(self, arg_types, function_space):
         '''Utility function to return any operator meta_args in metadata that
         have the same type as those specified in arg_types and their
         from or to function spaces are the same as the function space
         specified in function_space.
  
         :param arg_types: meta_arg classes indicating which meta_arg \
             arguments to check.
         :type arg_types: \
             :py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata` or \
             List[ \
             :py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata`]
         :param str function_space: the specified function space.
  
         :returns: a list of meta_args.
         :type arg_types: List[ \
             :py:class:`psyclone.domain.lfric.kernel.CommonMetaArgMetadata`]
  
         '''
         return [arg for arg in self.meta_args_get(arg_types)
                 if function_space in [arg.function_space_to,
                                       arg.function_space_from]]
  
  

References psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.meta_args_get().

Here is the call graph for this function:

◆ procedure_name() [1/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.procedure_name ( self )

:returns: the kernel procedure name specified by the metadata.
:rtype: str

Definition at line 1066 of file lfric_kernel_metadata.py.

     def procedure_name(self):
         '''
         :returns: the kernel procedure name specified by the metadata.
         :rtype: str
         '''
         return self._procedure_name
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._procedure_name, and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._procedure_name.

Here is the caller graph for this function:

◆ procedure_name() [2/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.procedure_name	(	self,
		value
	)

:param Optional[str] value: set the kernel procedure name in the \
    metadata to the specified value.

:raises ValueError: if the metadata has an invalid value.

Definition at line 1074 of file lfric_kernel_metadata.py.

     def procedure_name(self, value):
         '''
         :param Optional[str] value: set the kernel procedure name in the \
             metadata to the specified value.
  
         :raises ValueError: if the metadata has an invalid value.
  
         '''
         if value:
             try:
                 FortranReader.validate_name(value)
             except (ValueError, TypeError) as err:
                 raise ValueError(
                     f"Expected procedure_name to be a valid Fortran name but "
                     f"found '{value}'.") from err
         self._procedure_name = value
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._procedure_name, and psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._procedure_name.

Here is the caller graph for this function:

◆ shapes() [1/2]

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.shapes ( self )

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

Definition at line 931 of file lfric_kernel_metadata.py.

     def shapes(self):
         '''
         :returns: a list of shape metadata values.
         :rtype: Optional[List[str]]
  
         '''
         if self._shapes is None:
             return None
         return self._shapes.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.lfric_kernel_metadata.LFRicKernelMetadata.shapes	(	self,
		values
	)

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

Definition at line 942 of file lfric_kernel_metadata.py.

     def shapes(self, values):
         '''
         :param values: set the shape metadata to the \
             supplied list of values.
         :type values: List[str]
  
         '''
         self._shapes = ShapesMetadata(values)
  

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validate()

def psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata.validate ( self )

Only certain metadata combinations are allowed in LFRic. This
routine checks that any such constraints are respected.

:raises ParseError: if any validation checks fail.

Definition at line 184 of file lfric_kernel_metadata.py.

     def validate(self):
         '''Only certain metadata combinations are allowed in LFRic. This
         routine checks that any such constraints are respected.
  
         :raises ParseError: if any validation checks fail.
  
         '''
         # The _get_kernel_type method returns the type of kernel that
         # this metadata specifies (e.g. inter-grid or domain). In the
         # process it checks that the combined metadata conforms to the
         # constraints of the supported kernel types.
         _ = self._get_kernel_type()
  
         # TODO issue #1953: Checks that are not associated with
         # determining kernel type
         # - A kernel must modify at least one of its arguments
         # - Function spaces of basis functions exist in meta_args
         # - No shape if no basis or diff basis. shape
         #   if quadrature or evaluator
         # - evaluator_targets only if required
         # - evaluator_targets function spaces exist
         # - Disallow duplicate metadata in meta_args,
         #   meta_funcs etc. lists
         # - Writing to read-only function spaces (Check within
         #   meta_arg classes?)
  

Here is the call graph for this function:

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ create_from_fparser2()

◆ create_from_psyir()

◆ evaluator_targets() [1/2]

◆ evaluator_targets() [2/2]

◆ field_meta_args_on_fs()

◆ fortran_string()

◆ kernel_type()

◆ lower_to_psyir()

◆ meta_args() [1/2]

◆ meta_args() [2/2]

◆ meta_args_get()

◆ meta_funcs() [1/2]

◆ meta_funcs() [2/2]

◆ meta_mesh() [1/2]

◆ meta_mesh() [2/2]

◆ meta_ref_element() [1/2]

◆ meta_ref_element() [2/2]

◆ name() [1/2]

◆ name() [2/2]

◆ operates_on() [1/2]

◆ operates_on() [2/2]

◆ operator_meta_args_on_fs()

◆ procedure_name() [1/2]

◆ procedure_name() [2/2]

◆ shapes() [1/2]

◆ shapes() [2/2]

◆ validate()