Inheritance diagram for psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn:

[legend]

Collaboration diagram for psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn:

[legend]

Public Member Functions
def	__init__ (self)

def	__str__ (self)

def	reference_accesses (self, var_accesses)

def	load (self, call, parent=None)

def	undf_name (self)

def	qr_required (self)

def	reference_element (self)

def	cma_operation (self)

def	is_intergrid (self)

def	fs_descriptors (self)

def	get_dof_loop_index_symbol (self)

def	get_indexed_field_argument_references (self)

def	get_scalar_argument_references (self)

Public Member Functions inherited from psyclone.psyGen.BuiltIn
def	dag_name (self)

def	load (self, call, arguments, parent=None)

def	local_vars (self)

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

def	args (self)

def	node_str (self, colour=True)

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	gen_code (self, parent)

Static Public Member Functions
def	metadata ()

Public Attributes
	qr_rules

	mesh

	arg_descriptors

Detailed Description

Abstract base class for a node representing a call to an LFRic
built-in.

:raises NotImplementedError: if a subclass of this abstract class \
    does not set the value of '_datatype'.

Definition at line 156 of file lfric_builtins.py.

Member Function Documentation

◆ cma_operation()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.cma_operation ( self )

Built-ins do not perform operations with Column-Matrix-Assembly
operators.

:returns: None
:rtype: NoneType

Definition at line 401 of file lfric_builtins.py.

     def cma_operation(self):
         '''
         Built-ins do not perform operations with Column-Matrix-Assembly
         operators.
  
         :returns: None
         :rtype: NoneType
  
         '''
         return None
  

◆ fs_descriptors()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.fs_descriptors ( self )

:returns: a list of function space descriptor objects which \
          contain information about the function spaces.
:rtype: list of :py:class:`psyclone.dynamo0p3.FSDescriptor`

Definition at line 424 of file lfric_builtins.py.

     def fs_descriptors(self):
         '''
         :returns: a list of function space descriptor objects which \
                   contain information about the function spaces.
         :rtype: list of :py:class:`psyclone.dynamo0p3.FSDescriptor`
  
         '''
         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.

◆ get_dof_loop_index_symbol()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.get_dof_loop_index_symbol ( self )

Finds or creates the symbol representing the index in any loops
over DoFs.

:returns: symbol representing the DoF loop index.
:rtype: :py:class:`psyclone.psyir.symbols.DataSymbol`

Definition at line 433 of file lfric_builtins.py.

     def get_dof_loop_index_symbol(self):
         '''
         Finds or creates the symbol representing the index in any loops
         over DoFs.
  
         :returns: symbol representing the DoF loop index.
         :rtype: :py:class:`psyclone.psyir.symbols.DataSymbol`
  
         '''
         table = self.scope.symbol_table
         # The symbol representing the loop index is created in the LFRicLoop
         # constructor.
         return table.find_or_create_integer_symbol(
             "df", tag="dof_loop_idx")
  

References psyclone.psyir.nodes.node.Node.scope(), and psyclone.psyir.symbols.symbol_table.SymbolTable.scope().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_indexed_field_argument_references()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.get_indexed_field_argument_references ( self )

Creates a DoF-indexed StructureReference for each of the field
arguments to this Built-In kernel. e.g. if the kernel has a field
argument named 'fld1' then this routine will create an
ArrayReference for 'fld1_data(df)' where 'df' is the DoF-loop
variable and 'fld1_data' is the pointer to the data array within
the fld1 object.

:returns: a reference to the 'df'th element of each kernel argument
          that is a field.
:rtype: List[:py:class:`psyclone.psyir.nodes.ArrayReference`]

Definition at line 448 of file lfric_builtins.py.

     def get_indexed_field_argument_references(self):
         '''
         Creates a DoF-indexed StructureReference for each of the field
         arguments to this Built-In kernel. e.g. if the kernel has a field
         argument named 'fld1' then this routine will create an
         ArrayReference for 'fld1_data(df)' where 'df' is the DoF-loop
         variable and 'fld1_data' is the pointer to the data array within
         the fld1 object.
  
         :returns: a reference to the 'df'th element of each kernel argument
                   that is a field.
         :rtype: List[:py:class:`psyclone.psyir.nodes.ArrayReference`]
  
         '''
         table = self.scope.symbol_table
         idx_sym = self.get_dof_loop_index_symbol()
         suffixes = LFRicConstants().ARG_TYPE_SUFFIX_MAPPING
  
         refs = []
         for arg in self._arguments.args:
             if not arg.is_field:
                 continue
             sym = table.lookup_with_tag(
                 f"{arg.name}:{suffixes[arg.argument_type]}")
             refs.append(ArrayReference.create(sym, [Reference(idx_sym)]))
         return refs
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._arguments, psyclone.psyGen.Kern._arguments, psyclone.psyGen.InlinedKern._arguments, psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.get_dof_loop_index_symbol(), psyclone.psyir.nodes.node.Node.scope(), and psyclone.psyir.symbols.symbol_table.SymbolTable.scope().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_scalar_argument_references()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.get_scalar_argument_references ( self )

Finds or creates either a Reference (for a symbol) or PSyIR (for a
literal expression) for any scalar arguments to this Built-In kernel.

:returns: a Reference or PSyIR expression for each scalar kernel
          argument.
:rtype: list of subclasses of `:py:class:`psyclone.psyir.nodes.Node`

Definition at line 475 of file lfric_builtins.py.

     def get_scalar_argument_references(self):
         '''
         Finds or creates either a Reference (for a symbol) or PSyIR (for a
         literal expression) for any scalar arguments to this Built-In kernel.
  
         :returns: a Reference or PSyIR expression for each scalar kernel
                   argument.
         :rtype: list of subclasses of `:py:class:`psyclone.psyir.nodes.Node`
  
         '''
         return [arg.psyir_expression() for arg in self._arguments.args
                 if arg.is_scalar]
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._arguments, psyclone.psyGen.Kern._arguments, psyclone.psyGen.InlinedKern._arguments, and psyclone.psyir.nodes.node.Node.replace_with().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_intergrid()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.is_intergrid ( self )

We don't have any inter-grid built-ins.

:returns: False
:rtype: bool

Definition at line 413 of file lfric_builtins.py.

     def is_intergrid(self):
         '''
         We don't have any inter-grid built-ins.
  
         :returns: False
         :rtype: bool
  
         '''
         return False
  

Here is the caller graph for this function:

◆ load()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.load	(	self,
		call,
		parent = `None`
	)

Populate the state of this object using the supplied call object.

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

Definition at line 258 of file lfric_builtins.py.

     def load(self, call, parent=None):
         '''
         Populate the state of this object using the supplied call object.
  
         :param call: The BuiltIn object from which to extract information \
                      about this built-in call.
         :type call: :py:class:`psyclone.parse.algorithm.BuiltInCall`
         :param parent: The parent node of the kernel call in the PSyIR \
                        we are constructing. This will be a loop.
         :type parent: :py:class:`psyclone.domain.lfric.LFRicLoop`
  
         '''
         # Avoid circular import
         # pylint: disable=import-outside-toplevel
         from psyclone.dynamo0p3 import FSDescriptors, DynKernelArguments
         BuiltIn.load(self, call, DynKernelArguments, parent)
         self.arg_descriptors = call.ktype.arg_descriptors
         self._func_descriptors = call.ktype.func_descriptors
         self._fs_descriptors = FSDescriptors(call.ktype.func_descriptors)
         self._idx_name = self.get_dof_loop_index_symbol().name
         # Check that this built-in kernel is valid
         self._validate()
  

Here is the call graph for this function:

◆ metadata()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.metadata ( )

static

Must be overridden by subclass.

Definition at line 181 of file lfric_builtins.py.

     def metadata():
         '''Must be overridden by subclass.'''
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ qr_required()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.qr_required ( self )

Built-ins do not currently require quadrature.

:returns: False
:rtype: bool

Definition at line 379 of file lfric_builtins.py.

     def qr_required(self):
         '''
         Built-ins do not currently require quadrature.
  
         :returns: False
         :rtype: bool
  
         '''
         return False
  

◆ reference_accesses()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.reference_accesses	(	self,
		var_accesses
	)

Get all variable access information from this node. The assigned-to
variable will be set to 'WRITE'.

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

:raises InternalError: if an unsupported argument type is encountered.

Reimplemented from psyclone.psyGen.Kern.

Definition at line 217 of file lfric_builtins.py.

     def reference_accesses(self, var_accesses):
         '''Get all variable access information from this node. The assigned-to
         variable will be set to 'WRITE'.
  
         :param var_accesses: VariablesAccessInfo instance that stores the \
             information about variable accesses.
         :type var_accesses: \
             :py:class:`psyclone.core.VariablesAccessInfo`
  
         :raises InternalError: if an unsupported argument type is encountered.
  
         '''
         table = self.scope.symbol_table
         # Collect all write access in a separate object, so they can be added
         # after all read access (which must happen before something is written)
         written = VariablesAccessInfo()
         suffix_map = LFRicConstants().ARG_TYPE_SUFFIX_MAPPING
  
         for arg in self.args:
             if arg.form in ["variable", "indexed_variable"]:
                 if arg.is_field:
                     sym = table.lookup_with_tag(
                         f"{arg.name}:{suffix_map[arg.argument_type]}")
                     name = sym.name
                 elif arg.is_scalar:
                     name = arg.declaration_name
                 else:
                     raise InternalError(
                         f"LFRicBuiltin.reference_accesses only supports field "
                         f"and scalar arguments but got '{arg.name}' of type "
                         f"'{arg.argument_type}'")
                 if arg.access == AccessType.WRITE:
                     written.add_access(Signature(name), arg.access, self)
                 else:
                     var_accesses.add_access(Signature(name), arg.access, self)
         # Now merge the write access to the end of all other accesses:
         var_accesses.merge(written)
         # Forward location pointer to next index, since this built-in kernel
         # finishes a statement
         var_accesses.next_location()
  

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(), psyclone.psyir.nodes.node.Node.args(), psyclone.psyir.nodes.node.Node.scope(), and psyclone.psyir.symbols.symbol_table.SymbolTable.scope().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reference_element()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.reference_element ( self )

Built-ins do not require reference-element properties.

:returns: None
:rtype: NoneType

Definition at line 390 of file lfric_builtins.py.

     def reference_element(self):
         '''
         Built-ins do not require reference-element properties.
  
         :returns: None
         :rtype: NoneType
  
         '''
         return None
  

◆ undf_name()

def psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.undf_name ( self )

Dynamically looks up the name of the 'undf' variable for the
space that this kernel updates.

:returns: the name of the undf variable.
:rtype: str

Definition at line 366 of file lfric_builtins.py.

     def undf_name(self):
         '''
         Dynamically looks up the name of the 'undf' variable for the
         space that this kernel updates.
  
         :returns: the name of the undf variable.
         :rtype: str
  
         '''
         field = self._arguments.iteration_space_arg()
         return field.function_space.undf_name
  

References psyclone.domain.lfric.lfric_kern.LFRicKern._arguments, psyclone.psyGen.Kern._arguments, and psyclone.psyGen.InlinedKern._arguments.

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

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ cma_operation()

◆ fs_descriptors()

◆ get_dof_loop_index_symbol()

◆ get_indexed_field_argument_references()

◆ get_scalar_argument_references()

◆ is_intergrid()

◆ load()

◆ metadata()

◆ qr_required()

◆ reference_accesses()

◆ reference_element()

◆ undf_name()