Inheritance diagram for psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata:

Collaboration diagram for psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata:

Public Member Functions
def	__init__ (self, ast, name=None)

def	func_descriptors (self)

def	cma_operation (self)

def	eval_shapes (self)

def	eval_targets (self)

def	is_intergrid (self)

Public Member Functions inherited from psyclone.parse.kernel.KernelType
def	name (self)

def	iterates_over (self)

def	procedure (self)

def	nargs (self)

def	arg_descriptors (self)

def	__repr__ (self)

def	get_integer_variable (self, name)

def	get_integer_array (self, name)

Public Attributes
	reference_element

	mesh

Detailed Description

Captures the Kernel subroutine code and metadata describing
the subroutine for the LFRic API.

:param ast: fparser1 AST for the kernel.
:type ast: :py:class:`fparser.block_statements.BeginSource`
:param str name: the name of this kernel.

:raises ParseError: if the metadata does not conform to the
                    rules for the LFRic API.

Definition at line 56 of file lfric_kern_metadata.py.

Member Function Documentation

◆ cma_operation()

def psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata.cma_operation ( self )

Returns the type of CMA operation identified from the kernel
metadata (one of 'assembly', 'apply' or 'matrix-matrix') or
None if the kernel does not involve CMA operators

Definition at line 629 of file lfric_kern_metadata.py.

     def cma_operation(self):
         '''
         Returns the type of CMA operation identified from the kernel
         metadata (one of 'assembly', 'apply' or 'matrix-matrix') or
         None if the kernel does not involve CMA operators '''
         return self._cma_operation
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._cma_operation, and psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata._cma_operation.

◆ eval_shapes()

def psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata.eval_shapes ( self )

Returns the shape(s) of evaluator required by this kernel or an
empty string if none.

:return: the shape(s) of the evaluator (one of VALID_EVALUATOR_SHAPES)
         or an empty list if the kernel does not require one.
:rtype: list

Definition at line 637 of file lfric_kern_metadata.py.

     def eval_shapes(self):
         '''
         Returns the shape(s) of evaluator required by this kernel or an
         empty string if none.
  
         :return: the shape(s) of the evaluator (one of VALID_EVALUATOR_SHAPES)
                  or an empty list if the kernel does not require one.
         :rtype: list
  
         '''
         return self._eval_shapes
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._eval_shapes, and psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata._eval_shapes.

◆ eval_targets()

def psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata.eval_targets ( self )

Returns the list of function spaces upon which any evaluator must be
provided. This list is obtained from the GH_EVALUATOR_TARGETS metadata
entry (if present). If this is not specified in the metadata then
we default to providing evaluators on all of the function spaces
associated with the arguments which this kernel updates.

:return: list of the names of the function spaces (as they appear in
         kernel metadata) upon which any evaluator must be provided.
:rtype: list of str

Definition at line 650 of file lfric_kern_metadata.py.

     def eval_targets(self):
         '''
         Returns the list of function spaces upon which any evaluator must be
         provided. This list is obtained from the GH_EVALUATOR_TARGETS metadata
         entry (if present). If this is not specified in the metadata then
         we default to providing evaluators on all of the function spaces
         associated with the arguments which this kernel updates.
  
         :return: list of the names of the function spaces (as they appear in
                  kernel metadata) upon which any evaluator must be provided.
         :rtype: list of str
         '''
         return self._eval_targets
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._eval_targets, psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata._eval_targets, and psyclone.dynamo0p3.DynBasisFunctions._eval_targets.

◆ func_descriptors()

def psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata.func_descriptors ( self )

Returns metadata about the function spaces within a
Kernel. This metadata is provided within Kernel code via the
meta_funcs variable. Information is returned as a list of
DynFuncDescriptor03 objects, one for each function space.

Definition at line 620 of file lfric_kern_metadata.py.

     def func_descriptors(self):
         '''
         Returns metadata about the function spaces within a
         Kernel. This metadata is provided within Kernel code via the
         meta_funcs variable. Information is returned as a list of
         DynFuncDescriptor03 objects, one for each function space. '''
         return self._func_descriptors
  

References psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn._func_descriptors, psyclone.domain.lfric.lfric_kern.LFRicKern._func_descriptors, psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata._func_descriptors, and psyclone.psyGen.BuiltIn._func_descriptors.

◆ is_intergrid()

def psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata.is_intergrid ( self )

Returns whether or not this is an inter-grid kernel.

:return: True if kernel is an inter-grid kernel, False otherwise
:rtype: bool

Definition at line 665 of file lfric_kern_metadata.py.

     def is_intergrid(self):
         '''
         Returns whether or not this is an inter-grid kernel.
  
         :return: True if kernel is an inter-grid kernel, False otherwise
         :rtype: bool
         '''
         return self._is_intergrid
  
  
 # ---------- Documentation utils -------------------------------------------- #
 # The list of module members that we wish AutoAPI to generate
 # documentation for. (See https://psyclone-ref.readthedocs.io)

References psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata._is_intergrid.

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

Public Member Functions