Inheritance diagram for psyclone.domain.lfric.lfric_kern.LFRicKern:

[legend]

Collaboration diagram for psyclone.domain.lfric.lfric_kern.LFRicKern:

[legend]

Public Member Functions
def	__init__ (self)

def	reference_accesses (self, var_accesses)

def	load (self, call, parent=None)

def	load_meta (self, ktype)

def	qr_rules (self)

def	cma_operation (self)

def	is_intergrid (self)

def	colourmap (self)

def	last_cell_all_colours_symbol (self)

def	ncolours_var (self)

def	fs_descriptors (self)

def	qr_required (self)

def	eval_shapes (self)

def	eval_targets (self)

def	reference_element (self)

def	mesh (self)

def	all_updates_are_writes (self)

def	base_name (self)

def	argument_kinds (self)

def	gen_stub (self)

def	get_kernel_schedule (self)

def	validate_kernel_code_args (self, table)

def	validate_global_constraints (self)

Public Member Functions inherited from psyclone.psyGen.CodedKern
def	__init__ (self, KernelArguments, call, parent=None, check=True)

def	opencl_options (self)

def	set_opencl_options (self, options)

def	__str__ (self)

def	module_name (self)

def	dag_name (self)

def	module_inline (self)

def	module_inline (self, value)

def	node_str (self, colour=True)

def	lower_to_language_level (self)

def	incremented_arg (self)

def	ast (self)

def	rename_and_write (self)

def	modified (self)

def	modified (self, value)

Public Member Functions inherited from psyclone.psyGen.Kern
def	__init__ (self, parent, call, name, ArgumentsClass, check=True)

def	args (self)

def	is_reduction (self)

def	reduction_arg (self)

def	reprod_reduction (self)

def	local_reduction_name (self)

def	zero_reduction_variable (self, parent, position=None)

def	reduction_sum_loop (self, parent)

def	arg_descriptors (self)

def	arg_descriptors (self, obj)

def	arguments (self)

def	name (self)

def	name (self, value)

def	is_coloured (self)

def	iterates_over (self)

def	local_vars (self)

def	gen_code (self, parent)

Static Public Attributes
	QRRule

Additional Inherited Members
Public Attributes inherited from psyclone.psyGen.CodedKern
	arg_descriptors

	modified

	name

Detailed Description

 Stores information about LFRic Kernels as specified by the
Kernel metadata and associated algorithm call. Uses this
information to generate appropriate PSy layer code for the Kernel
instance or to generate a Kernel stub.

Definition at line 59 of file lfric_kern.py.

Member Function Documentation

◆ all_updates_are_writes()

def psyclone.domain.lfric.lfric_kern.LFRicKern.all_updates_are_writes ( self )

:returns: True if all of the arguments updated by this kernel have \
          'GH_WRITE' access, False otherwise.
:rtype: bool

Definition at line 538 of file lfric_kern.py.

     def all_updates_are_writes(self):
         '''
         :returns: True if all of the arguments updated by this kernel have \
                   'GH_WRITE' access, False otherwise.
         :rtype: bool
  
         '''
         accesses = set(arg.access for arg in self.args)
         all_writes = AccessType.all_write_accesses()
         all_writes.remove(AccessType.WRITE)
         return (not accesses.intersection(set(all_writes)))
  

References psyclone.expression.FunctionVar.args, psyclone.f2pygen.SubroutineGen.args(), psyclone.parse.algorithm.ParsedCall.args(), psyclone.psyGen.GlobalSum.args(), psyclone.psyGen.HaloExchange.args(), psyclone.psyGen.Kern.args(), psyclone.psyGen.Arguments.args(), and psyclone.psyir.nodes.node.Node.args().

Here is the call graph for this function:

◆ argument_kinds()

def psyclone.domain.lfric.lfric_kern.LFRicKern.argument_kinds ( self )

:returns: kinds (precisions) for all arguments in a kernel.
:rtype: set of str

Definition at line 559 of file lfric_kern.py.

     def argument_kinds(self):
         '''
         :returns: kinds (precisions) for all arguments in a kernel.
         :rtype: set of str
  
         '''
         return self._argument_kinds
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._argument_kinds.

◆ base_name()

def psyclone.domain.lfric.lfric_kern.LFRicKern.base_name ( self )

:returns: a base name for this kernel.
:rtype: str

Definition at line 551 of file lfric_kern.py.

     def base_name(self):
         '''
         :returns: a base name for this kernel.
         :rtype: str
         '''
         return self._base_name
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._base_name.

◆ cma_operation()

def psyclone.domain.lfric.lfric_kern.LFRicKern.cma_operation ( self )

:return: the type of CMA operation performed by this kernel
         (one of 'assembly', 'apply' or 'matrix-matrix') or None
         if the kernel does not involve CMA operators.
:rtype: str

Definition at line 380 of file lfric_kern.py.

     def cma_operation(self):
         '''
         :return: the type of CMA operation performed by this kernel
                  (one of 'assembly', 'apply' or 'matrix-matrix') or None
                  if the kernel does not involve CMA operators.
         :rtype: str
         '''
         return self._cma_operation
  

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

◆ colourmap()

def psyclone.domain.lfric.lfric_kern.LFRicKern.colourmap ( self )

Getter for the name of the colourmap associated with this kernel call.

:returns: name of the colourmap (Fortran array).
:rtype: str

:raises InternalError: if this kernel is not coloured.

Definition at line 398 of file lfric_kern.py.

     def colourmap(self):
         '''
         Getter for the name of the colourmap associated with this kernel call.
  
         :returns: name of the colourmap (Fortran array).
         :rtype: str
  
         :raises InternalError: if this kernel is not coloured.
  
         '''
         if not self.is_coloured():
             raise InternalError(f"Kernel '{self.name}' is not inside a "
                                 f"coloured loop.")
         sched = self.ancestor(InvokeSchedule)
         if self.is_intergrid:
             cmap = self._intergrid_ref.colourmap_symbol.name
         else:
             try:
                 cmap = sched.symbol_table.lookup_with_tag("cmap").name
             except KeyError:
                 # We have to do this here as _init_colourmap (which calls this
                 # method) is only called at code-generation time.
                 cmap = sched.symbol_table.find_or_create_array(
                     "cmap", 2, ScalarType.Intrinsic.INTEGER,
                     tag="cmap").name
  
         return cmap
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._intergrid_ref, psyclone.psyir.nodes.node.Node.ancestor(), psyclone.psyGen.Kern.is_coloured(), psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.is_intergrid(), psyclone.domain.lfric.lfric_kern.LFRicKern.is_intergrid(), and psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata.is_intergrid().

Here is the call graph for this function:

◆ eval_shapes()

def psyclone.domain.lfric.lfric_kern.LFRicKern.eval_shapes ( self )

:return: the value(s) of GH_SHAPE for this kernel or an empty list \
         if none are specified.
:rtype: list

Definition at line 501 of file lfric_kern.py.

     def eval_shapes(self):
         '''
         :return: the value(s) of GH_SHAPE for this kernel or an empty list \
                  if none are specified.
         :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.LFRicKern.eval_targets ( self )

:return: the function spaces upon which basis/diff-basis functions \
         are to be evaluated for this kernel.
:rtype: dict of (:py:class:`psyclone.domain.lfric.FunctionSpace`, \
        :py:class`psyclone.dynamo0p3.DynKernelArgument`), indexed by \
        the names of the target function spaces.

Definition at line 511 of file lfric_kern.py.

     def eval_targets(self):
         '''
         :return: the function spaces upon which basis/diff-basis functions \
                  are to be evaluated for this kernel.
         :rtype: dict of (:py:class:`psyclone.domain.lfric.FunctionSpace`, \
                 :py:class`psyclone.dynamo0p3.DynKernelArgument`), indexed by \
                 the names of the target function spaces.
         '''
         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.

◆ fs_descriptors()

def psyclone.domain.lfric.lfric_kern.LFRicKern.fs_descriptors ( self )

:return: a list of function space descriptor objects of
         type FSDescriptors which contain information about
         the function spaces.
:rtype: List[:py:class:`psyclone.FSDescriptors`].

Definition at line 481 of file lfric_kern.py.

     def fs_descriptors(self):
         '''
         :return: a list of function space descriptor objects of
                  type FSDescriptors which contain information about
                  the function spaces.
         :rtype: List[:py:class:`psyclone.FSDescriptors`].
  
         '''
         return self._fs_descriptors
  

References psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn._fs_descriptors, psyclone.domain.lfric.lfric_kern.LFRicKern._fs_descriptors, and psyclone.psyGen.BuiltIn._fs_descriptors.

◆ gen_stub()

def psyclone.domain.lfric.lfric_kern.LFRicKern.gen_stub ( self )

Create the fparser1 AST for a kernel stub.

:returns: root of fparser1 AST for the stub routine.
:rtype: :py:class:`fparser.one.block_statements.Module`

:raises GenerationError: if the supplied kernel stub does not operate \
    on a supported subset of the domain (currently only "cell_column").

Definition at line 568 of file lfric_kern.py.

     def gen_stub(self):
         '''
         Create the fparser1 AST for a kernel stub.
  
         :returns: root of fparser1 AST for the stub routine.
         :rtype: :py:class:`fparser.one.block_statements.Module`
  
         :raises GenerationError: if the supplied kernel stub does not operate \
             on a supported subset of the domain (currently only "cell_column").
  
         '''
         # The operates-on/iterates-over values supported by the stub generator.
         const = LFRicConstants()
         supported_operates_on = const.USER_KERNEL_ITERATION_SPACES[:]
         # TODO #925 Add support for 'domain' kernels
         supported_operates_on.remove("domain")
  
         # Check operates-on (iteration space) before generating code
         if self.iterates_over not in supported_operates_on:
             raise GenerationError(
                 f"The LFRic API kernel-stub generator supports kernels that "
                 f"operate on one of {supported_operates_on} but found "
                 f"'{self.iterates_over}' in kernel '{self.name}'.")
  
         # Create an empty PSy layer module
         psy_module = ModuleGen(self._base_name+"_mod")
  
         # Create the subroutine
         sub_stub = SubroutineGen(psy_module, name=self._base_name+"_code",
                                  implicitnone=True)
  
         # Add all the declarations
         # Import here to avoid circular dependency
         # pylint: disable=import-outside-toplevel
         from psyclone.domain.lfric import (LFRicScalarArgs, LFRicFields,
                                            LFRicDofmaps, LFRicStencils)
         from psyclone.dynamo0p3 import (DynCellIterators, DynFunctionSpaces,
                                         DynCMAOperators, DynBoundaryConditions,
                                         DynLMAOperators, LFRicMeshProperties,
                                         DynBasisFunctions, DynReferenceElement)
         for entities in [DynCellIterators, LFRicDofmaps, DynFunctionSpaces,
                          DynCMAOperators, LFRicScalarArgs, LFRicFields,
                          DynLMAOperators, LFRicStencils, DynBasisFunctions,
                          DynBoundaryConditions, DynReferenceElement,
                          LFRicMeshProperties]:
             entities(self).declarations(sub_stub)
  
         # Add wildcard "use" statement for all supported argument
         # kinds (precisions)
         sub_stub.add(
             UseGen(sub_stub,
                    name=const.UTILITIES_MOD_MAP["constants"]["module"]))
  
         # Create the arglist
         create_arg_list = KernStubArgList(self)
         create_arg_list.generate()
  
         # Add the arglist
         sub_stub.args = create_arg_list.arglist
  
         # Add the subroutine to the parent module
         psy_module.add(sub_stub)
         return psy_module.root
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._base_name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.iterates_over, psyclone.parse.kernel.KernelType.iterates_over(), and psyclone.psyGen.Kern.iterates_over().

Here is the call graph for this function:

◆ get_kernel_schedule()

def psyclone.domain.lfric.lfric_kern.LFRicKern.get_kernel_schedule ( self )

Returns a PSyIR Schedule representing the kernel code. The base
class creates the PSyIR schedule on first invocation which is
then checked for consistency with the kernel metadata
here. The Schedule is just generated on first invocation, this
allows us to retain transformations that may subsequently be
applied to the Schedule.

Once issue #935 is implemented, this routine will return the
PSyIR Schedule using LFRic-specific PSyIR where possible.

:returns: Schedule representing the kernel code.
:rtype: :py:class:`psyclone.psyGen.KernelSchedule`

:raises GenerationError: if no subroutine matching this kernel can \
    be found in the parse tree of the associated source code.

Reimplemented from psyclone.psyGen.CodedKern.

Definition at line 632 of file lfric_kern.py.

     def get_kernel_schedule(self):
         '''Returns a PSyIR Schedule representing the kernel code. The base
         class creates the PSyIR schedule on first invocation which is
         then checked for consistency with the kernel metadata
         here. The Schedule is just generated on first invocation, this
         allows us to retain transformations that may subsequently be
         applied to the Schedule.
  
         Once issue #935 is implemented, this routine will return the
         PSyIR Schedule using LFRic-specific PSyIR where possible.
  
         :returns: Schedule representing the kernel code.
         :rtype: :py:class:`psyclone.psyGen.KernelSchedule`
  
         :raises GenerationError: if no subroutine matching this kernel can \
             be found in the parse tree of the associated source code.
         '''
         if self._kern_schedule:
             return self._kern_schedule
  
         # Get the PSyIR Kernel Schedule(s)
         routines = Fparser2Reader().get_routine_schedules(self.name, self.ast)
         for routine in routines:
             # If one of the symbols is not declared in a routine then
             # this is only picked up when writing out the routine
             # (raising a VisitorError), so we check here so that
             # invalid code is not inlined. We use debug_string() to
             # minimise the overhead.
  
             # TODO #2271 could potentially avoid the need for
             # debug_string() within. Sergi suggests that we may be
             # missing the traversal of the declaration init
             # expressions and that might solve the problem. I'm not so
             # sure as we are talking about unknown symbols that will
             # only be resolved in the back-end (or not). If I am right
             # then one option would be to use the FortranWriter, but
             # that would be bigger overhead, or perhaps just the
             # declarations part of FortranWriter if that is possible.
             # Also see TODO issue #2336 which captures the specific
             # problem in LFRic that this fixes.
             routine.debug_string()
  
         if len(routines) == 1:
             sched = routines[0]
             # TODO #928: We don't validate the arguments yet because the
             # validation has many false negatives.
             # self.validate_kernel_code_args(sched.symbol_table)
         else:
             # The kernel name corresponds to an interface block. Find which
             # of the routines matches the precision of the arguments.
             for routine in routines:
                 try:
                     # The validity check for the kernel arguments will raise
                     # an exception if the precisions don't match.
                     self.validate_kernel_code_args(routine.symbol_table)
                     sched = routine
                     break
                 except GenerationError:
                     pass
             else:
                 raise GenerationError(
                     f"Failed to find a kernel implementation with an interface"
                     f" that matches the invoke of '{self.name}'. (Tried "
                     f"routines {[item.name for item in routines]}.)")
  
         # TODO #935 - replace the PSyIR argument data symbols with LFRic data
         # symbols. For the moment we just return the unmodified PSyIR schedule
         # but this should use RaisePSyIR2LFRicKernTrans once KernelInterface
         # is fully functional (#928).
         ksched = KernelSchedule(sched.name,
                                 symbol_table=sched.symbol_table.detach())
         for child in sched.pop_all_children():
             ksched.addchild(child)
         sched.replace_with(ksched)
  
         self._kern_schedule = ksched
  
         return self._kern_schedule
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_intergrid()

def psyclone.domain.lfric.lfric_kern.LFRicKern.is_intergrid ( self )

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

Definition at line 390 of file lfric_kern.py.

     def is_intergrid(self):
         '''
         :return: True if it is an inter-grid kernel, False otherwise
         :rtype: bool
         '''
         return self._intergrid_ref is not None
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._intergrid_ref.

Here is the caller graph for this function:

◆ last_cell_all_colours_symbol()

def psyclone.domain.lfric.lfric_kern.LFRicKern.last_cell_all_colours_symbol ( self )

Getter for the symbol of the array holding the index of the last
cell of each colour.

:returns: name of the array.
:rtype: str

:raises InternalError: if this kernel is not coloured.

Definition at line 427 of file lfric_kern.py.

     def last_cell_all_colours_symbol(self):
         '''
         Getter for the symbol of the array holding the index of the last
         cell of each colour.
  
         :returns: name of the array.
         :rtype: str
  
         :raises InternalError: if this kernel is not coloured.
         '''
         if not self.is_coloured():
             raise InternalError(f"Kernel '{self.name}' is not inside a "
                                 f"coloured loop.")
  
         if self.is_intergrid:
             return self._intergrid_ref.last_cell_var_symbol
  
         ubnd_name = self.ancestor(Loop).upper_bound_name
         const = LFRicConstants()
  
         if ubnd_name in const.HALO_ACCESS_LOOP_BOUNDS:
             return self.scope.symbol_table.find_or_create_array(
                 "last_halo_cell_all_colours", 2,
                 ScalarType.Intrinsic.INTEGER,
                 tag="last_halo_cell_all_colours")
  
         return self.scope.symbol_table.find_or_create_array(
             "last_edge_cell_all_colours", 1,
             ScalarType.Intrinsic.INTEGER,
             tag="last_edge_cell_all_colours")
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._intergrid_ref, psyclone.psyir.nodes.node.Node.ancestor(), psyclone.psyGen.Kern.is_coloured(), psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.is_intergrid(), psyclone.domain.lfric.lfric_kern.LFRicKern.is_intergrid(), psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata.is_intergrid(), psyclone.psyir.nodes.node.Node.scope(), and psyclone.psyir.symbols.symbol_table.SymbolTable.scope().

Here is the call graph for this function:

◆ load()

def psyclone.domain.lfric.lfric_kern.LFRicKern.load	(	self,
		call,
		parent = `None`
	)

Sets up kernel information with the call object which is
created by the parser. This object includes information about
the invoke call and the associated kernel.

:param call: The KernelCall object from which to extract information
             about this kernel
:type call: :py:class:`psyclone.parse.algorithm.KernelCall`
:param parent: The parent node of the kernel call in the AST
               we are constructing. This will be a loop.
:type parent: :py:class:`psyclone.domain.lfric.LFRicLoop`

Definition at line 139 of file lfric_kern.py.

     def load(self, call, parent=None):
         '''
         Sets up kernel information with the call object which is
         created by the parser. This object includes information about
         the invoke call and the associated kernel.
  
         :param call: The KernelCall object from which to extract information
                      about this kernel
         :type call: :py:class:`psyclone.parse.algorithm.KernelCall`
         :param parent: The parent node of the kernel call in the AST
                        we are constructing. This will be a loop.
         :type parent: :py:class:`psyclone.domain.lfric.LFRicLoop`
         '''
         self._setup_basis(call.ktype)
         self._setup(call.ktype, call.module_name, call.args, parent)
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._setup(), and psyclone.domain.lfric.lfric_kern.LFRicKern._setup_basis().

Here is the call graph for this function:

◆ load_meta()

def psyclone.domain.lfric.lfric_kern.LFRicKern.load_meta	(	self,
		ktype
	)

Sets up kernel information with the kernel type object
which is created by the parser. The object includes the
metadata describing the kernel code.

:param ktype: the kernel metadata object produced by the parser
:type ktype: :py:class:`psyclone.domain.lfric.LFRicKernMetadata`

:raises InternalError: for an invalid data type of a scalar argument.
:raises GenerationError: if an invalid argument type is found \
                         in the kernel.

Definition at line 155 of file lfric_kern.py.

     def load_meta(self, ktype):
         '''
         Sets up kernel information with the kernel type object
         which is created by the parser. The object includes the
         metadata describing the kernel code.
  
         :param ktype: the kernel metadata object produced by the parser
         :type ktype: :py:class:`psyclone.domain.lfric.LFRicKernMetadata`
  
         :raises InternalError: for an invalid data type of a scalar argument.
         :raises GenerationError: if an invalid argument type is found \
                                  in the kernel.
  
         '''
         # pylint: disable=too-many-branches
         # Create a name for each argument
         args = []
         const = LFRicConstants()
         for idx, descriptor in enumerate(ktype.arg_descriptors):
             pre = None
             if descriptor.argument_type.lower() == "gh_operator":
                 pre = "op_"
             elif descriptor.argument_type.lower() == "gh_columnwise_operator":
                 pre = "cma_op_"
             elif descriptor.argument_type.lower() == "gh_field":
                 pre = "field_"
             elif (descriptor.argument_type.lower() in
                   const.VALID_SCALAR_NAMES):
                 if descriptor.data_type.lower() == "gh_real":
                     pre = "rscalar_"
                 elif descriptor.data_type.lower() == "gh_integer":
                     pre = "iscalar_"
                 elif descriptor.data_type.lower() == "gh_logical":
                     pre = "lscalar_"
                 else:
                     raise InternalError(
                         f"Expected one of {const.VALID_SCALAR_DATA_TYPES} "
                         f"data types for a scalar argument but found "
                         f"'{descriptor.data_type}'.")
             else:
                 raise GenerationError(
                     f"LFRicKern.load_meta() expected one of "
                     f"{const.VALID_ARG_TYPE_NAMES} but found "
                     f"'{descriptor.argument_type}'")
             args.append(Arg("variable", pre+str(idx+1)))
  
             if descriptor.stencil:
                 if not descriptor.stencil["extent"]:
                     # Stencil size (in cells) is passed in
                     args.append(Arg("variable",
                                     pre+str(idx+1)+"_stencil_size"))
                 if descriptor.stencil["type"] == "xory1d":
                     # Direction is passed in
                     args.append(Arg("variable", pre+str(idx+1)+"_direction"))
  
         # Initialise basis/diff basis so we can test whether quadrature
         # or an evaluator is required
         self._setup_basis(ktype)
         if self._basis_required:
             for shape in self._eval_shapes:
                 if shape in const.VALID_QUADRATURE_SHAPES:
                     # Add a quadrature argument for each required quadrature
                     # rule.
                     args.append(Arg("variable", "qr_"+shape))
         self._setup(ktype, "dummy_name", args, None, check=False)
  

Here is the call graph for this function:

◆ mesh()

def psyclone.domain.lfric.lfric_kern.LFRicKern.mesh ( self )

:returns: the mesh properties required by this kernel.
:rtype: :py:class`psyclone.dynamo0p3.MeshPropertiesMetaData`

Definition at line 530 of file lfric_kern.py.

     def mesh(self):
         '''
         :returns: the mesh properties required by this kernel.
         :rtype: :py:class`psyclone.dynamo0p3.MeshPropertiesMetaData`
         '''
         return self._mesh_properties
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._mesh_properties, and psyclone.domain.lfric.metadata_to_arguments_rules.MetadataToArgumentsRules._mesh_properties().

Here is the call graph for this function:

◆ ncolours_var()

def psyclone.domain.lfric.lfric_kern.LFRicKern.ncolours_var ( self )

Getter for the name of the variable holding the number of colours
associated with this kernel call.

:return: name of the variable holding the number of colours
:rtype: Optional[str]

:raises InternalError: if this kernel is not coloured.

Definition at line 459 of file lfric_kern.py.

     def ncolours_var(self):
         '''
         Getter for the name of the variable holding the number of colours
         associated with this kernel call.
  
         :return: name of the variable holding the number of colours
         :rtype: Optional[str]
  
         :raises InternalError: if this kernel is not coloured.
         '''
         if not self.is_coloured():
             raise InternalError(f"Kernel '{self.name}' is not inside a "
                                 f"coloured loop.")
         if self.is_intergrid:
             ncols_sym = self._intergrid_ref.ncolours_var_symbol
             if not ncols_sym:
                 return None
             return ncols_sym.name
  
         return self.scope.symbol_table.lookup_with_tag("ncolour").name
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._intergrid_ref, psyclone.psyGen.Kern.is_coloured(), psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.is_intergrid(), psyclone.domain.lfric.lfric_kern.LFRicKern.is_intergrid(), psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata.is_intergrid(), psyclone.psyir.nodes.node.Node.scope(), and psyclone.psyir.symbols.symbol_table.SymbolTable.scope().

Here is the call graph for this function:

◆ qr_required()

def psyclone.domain.lfric.lfric_kern.LFRicKern.qr_required ( self )

:return: True if this kernel requires quadrature, else returns False.
:rtype: bool

Definition at line 492 of file lfric_kern.py.

     def qr_required(self):
         '''
         :return: True if this kernel requires quadrature, else returns False.
         :rtype: bool
  
         '''
         return self._basis_required and self.qr_rules
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._basis_required, psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.qr_rules, and psyclone.domain.lfric.lfric_kern.LFRicKern.qr_rules().

Here is the call graph for this function:

◆ qr_rules()

def psyclone.domain.lfric.lfric_kern.LFRicKern.qr_rules ( self )

:return: details of each of the quadrature rules required by this \
         kernel.
:rtype: OrderedDict containing \
        :py:class:`psyclone.domain.lfric.LFRicKern.QRRule` indexed by \
        quadrature shape.

Definition at line 369 of file lfric_kern.py.

     def qr_rules(self):
         '''
         :return: details of each of the quadrature rules required by this \
                  kernel.
         :rtype: OrderedDict containing \
                 :py:class:`psyclone.domain.lfric.LFRicKern.QRRule` indexed by \
                 quadrature shape.
         '''
         return self._qr_rules
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._qr_rules.

Here is the caller graph for this function:

◆ reference_accesses()

def psyclone.domain.lfric.lfric_kern.LFRicKern.reference_accesses	(	self,
		var_accesses
	)

Get all variable access information. All accesses are marked
according to the kernel metadata

:param var_accesses: VariablesAccessInfo instance that stores the \
    information about variable accesses.
:type var_accesses: \
    :py:class:`psyclone.core.VariablesAccessInfo`

Reimplemented from psyclone.psyGen.Kern.

Definition at line 119 of file lfric_kern.py.

     def reference_accesses(self, var_accesses):
         '''Get all variable access information. All accesses are marked
         according to the kernel metadata
  
         :param var_accesses: VariablesAccessInfo instance that stores the \
             information about variable accesses.
         :type var_accesses: \
             :py:class:`psyclone.core.VariablesAccessInfo`
  
         '''
         # Use the KernelCallArgList class, which can also provide variable
         # access information:
         create_arg_list = KernCallArgList(self)
         create_arg_list.generate(var_accesses)
  
         super().reference_accesses(var_accesses)
         # Set the current location index to the next location, since after
         # this kernel a new statement starts.
         var_accesses.next_location()
  

Here is the caller graph for this function:

◆ reference_element()

def psyclone.domain.lfric.lfric_kern.LFRicKern.reference_element ( self )

:returns: the reference-element properties required by this kernel.
:rtype: :py:class:`psyclone.dynamo0p3.RefElementMetaData`

Definition at line 522 of file lfric_kern.py.

     def reference_element(self):
         '''
         :returns: the reference-element properties required by this kernel.
         :rtype: :py:class:`psyclone.dynamo0p3.RefElementMetaData`
         '''
         return self._reference_element
  

References psyclone.domain.lfric.kernel.meta_ref_element_arg_metadata.MetaRefElementArgMetadata._reference_element, and psyclone.domain.lfric.lfric_kern.LFRicKern._reference_element.

◆ validate_global_constraints()

def psyclone.domain.lfric.lfric_kern.LFRicKern.validate_global_constraints ( self )

Perform validation checks for any global constraints (that require the
tree to be complete).

:raises GenerationError: if this kernel does not have a supported
                operates-on (currently only "cell_column").
:raises GenerationError: if the loop goes beyond the level 1
                halo and an operator is accessed.
:raises GenerationError: if a kernel in the loop has an inc access
                and the loop is not coloured but is within an OpenMP
                parallel region.

Definition at line 883 of file lfric_kern.py.

     def validate_global_constraints(self):
         '''
         Perform validation checks for any global constraints (that require the
         tree to be complete).
  
         :raises GenerationError: if this kernel does not have a supported
                         operates-on (currently only "cell_column").
         :raises GenerationError: if the loop goes beyond the level 1
                         halo and an operator is accessed.
         :raises GenerationError: if a kernel in the loop has an inc access
                         and the loop is not coloured but is within an OpenMP
                         parallel region.
         '''
         # Check operates-on (iteration space) before generating code
         const = LFRicConstants()
         if self.iterates_over not in const.USER_KERNEL_ITERATION_SPACES:
             raise GenerationError(
                 f"The LFRic API supports calls to user-supplied kernels that "
                 f"operate on one of {const.USER_KERNEL_ITERATION_SPACES}, but "
                 f"kernel '{self.name}' operates on '{self.iterates_over}'.")
  
         # pylint: disable=import-outside-toplevel
         from psyclone.domain.lfric import LFRicLoop
         parent_loop = self.ancestor(LFRicLoop)
  
         # Check whether this kernel reads from an operator
         op_args = parent_loop.args_filter(
             arg_types=const.VALID_OPERATOR_NAMES,
             arg_accesses=[AccessType.READ, AccessType.READWRITE])
         if op_args:
             # It does. We must check that our parent loop does not
             # go beyond the L1 halo.
             if (parent_loop.upper_bound_name == "cell_halo" and
                     parent_loop.upper_bound_halo_depth > 1):
                 raise GenerationError(
                     f"Kernel '{self._name}' reads from an operator and "
                     f"therefore cannot be used for cells beyond the level 1 "
                     f"halo. However the containing loop goes out to level "
                     f"{parent_loop.upper_bound_halo_depth}")
  
         if not self.is_coloured():
             # This kernel call has not been coloured
             #  - is it OpenMP parallel, i.e. are we a child of
             # an OpenMP directive?
             if self.is_openmp_parallel():
                 try:
                     # It is OpenMP parallel - does it have an argument
                     # with INC access?
                     _ = self.incremented_arg()
                     raise GenerationError(f"Kernel '{self._name}' has an "
                                           f"argument with INC access and "
                                           f"therefore must be coloured in "
                                           f"order to be parallelised with "
                                           f"OpenMP.")
                 except FieldNotFoundError:
                     pass
  
         super().validate_global_constraints()
  
  
 # ---------- Documentation utils -------------------------------------------- #
 # The list of module members that we wish AutoAPI to generate
 # documentation for. (See https://psyclone-ref.readthedocs.io)

References psyclone.psyir.nodes.node.Node.ancestor(), psyclone.psyGen.CodedKern.incremented_arg(), psyclone.psyGen.Kern.is_coloured(), psyclone.psyir.nodes.node.Node.is_openmp_parallel(), psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.iterates_over, psyclone.parse.kernel.KernelType.iterates_over(), and psyclone.psyGen.Kern.iterates_over().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validate_kernel_code_args()

def psyclone.domain.lfric.lfric_kern.LFRicKern.validate_kernel_code_args	(	self,
		table
	)

Check that the arguments in the kernel code match the expected
arguments as defined by the kernel metadata and the LFRic
API.

:param table: the symbol table to validate against the metadata.
:type table: :py:class:`psyclone.psyir.symbols.SymbolTable`

:raises GenerationError: if the number of arguments indicated by the \
    kernel metadata doesn't match the actual number of arguments in \
    the symbol table.

Definition at line 711 of file lfric_kern.py.

     def validate_kernel_code_args(self, table):
         '''Check that the arguments in the kernel code match the expected
         arguments as defined by the kernel metadata and the LFRic
         API.
  
         :param table: the symbol table to validate against the metadata.
         :type table: :py:class:`psyclone.psyir.symbols.SymbolTable`
  
         :raises GenerationError: if the number of arguments indicated by the \
             kernel metadata doesn't match the actual number of arguments in \
             the symbol table.
  
         '''
         # Get the kernel subroutine arguments
         kern_code_args = table.argument_list
  
         # Get the kernel code interface according to the kernel
         # metadata and LFRic API
         interface_info = KernelInterface(self)
         interface_info.generate()
         interface_args = interface_info.arglist
  
         # 1: Check the the number of arguments match
         actual_n_args = len(kern_code_args)
         expected_n_args = len(interface_args)
         if actual_n_args != expected_n_args:
             raise GenerationError(
                 f"In kernel '{self.name}' the number of arguments indicated by"
                 f" the kernel metadata is {expected_n_args} but the actual "
                 f"number of kernel arguments found is {actual_n_args}.")
  
         # 2: Check that the properties of each argument match.
         for idx, kern_code_arg in enumerate(kern_code_args):
             interface_arg = interface_args[idx]
             try:
                 alg_idx = interface_info.metadata_index_from_actual_index(idx)
                 alg_arg = self.arguments.args[alg_idx]
             except KeyError:
                 # There's no algorithm argument directly associated with this
                 # kernel argument. (We only care about the data associated
                 # with scalar, field and operator arguments.)
                 alg_arg = None
             self._validate_kernel_code_arg(kern_code_arg, interface_arg,
                                            alg_arg)
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._validate_kernel_code_arg(), psyclone.psyGen.Kern.arguments(), and psyclone.psyir.nodes.call.Call.arguments().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ QRRule

psyclone.domain.lfric.lfric_kern.LFRicKern.QRRule

static

Initial value:

= namedtuple("QRRule",

["alg_name", "psy_name", "kernel_args"])

Definition at line 75 of file lfric_kern.py.

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ all_updates_are_writes()

◆ argument_kinds()

◆ base_name()

◆ cma_operation()

◆ colourmap()

◆ eval_shapes()

◆ eval_targets()

◆ fs_descriptors()

◆ gen_stub()

◆ get_kernel_schedule()

◆ is_intergrid()

◆ last_cell_all_colours_symbol()

◆ load()

◆ load_meta()

◆ mesh()

◆ ncolours_var()

◆ qr_required()

◆ qr_rules()

◆ reference_accesses()

◆ reference_element()

◆ validate_global_constraints()

◆ validate_kernel_code_args()

Member Data Documentation

◆ QRRule