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

[legend]

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

[legend]

Public Member Functions
def	metadata (cls)

def	lower_to_language_level (self)

Public Member Functions inherited from psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn
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)

Additional Inherited Members
Static Public Member Functions inherited from psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn
def	metadata ()

Public Attributes inherited from psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn
	qr_rules

	mesh

	arg_descriptors

Detailed Description

 `X = a*X + b*Y` where `a` and `b` are real scalars and `X` and `Y`
are real-valued fields.

Definition at line 905 of file lfric_builtins.py.

Member Function Documentation

◆ lower_to_language_level()

def psyclone.domain.lfric.lfric_builtins.LFRicIncAXPlusBYKern.lower_to_language_level ( self )

Lowers this LFRic-specific built-in kernel to language-level PSyIR.
This BuiltIn node is replaced by an Assignment node.

:returns: the lowered version of this node.
:rtype: :py:class:`psyclone.psyir.node.Node`

Definition at line 928 of file lfric_builtins.py.

     def lower_to_language_level(self):
         '''
         Lowers this LFRic-specific built-in kernel to language-level PSyIR.
         This BuiltIn node is replaced by an Assignment node.
  
         :returns: the lowered version of this node.
         :rtype: :py:class:`psyclone.psyir.node.Node`
  
         '''
         # Get indexed references for each of the field (proxy) arguments.
         arg_refs = self.get_indexed_field_argument_references()
         # Get a reference for the kernel scalar argument.
         scalar_args = self.get_scalar_argument_references()
  
         # Create the PSyIR for the kernel:
         #      proxy0%data(df) = ascalar * proxy0%data(df) +
         #                        bscalar * proxy1%data(df)
         lhs = arg_refs[0]
         mult_op_a = BinaryOperation.create(BinaryOperation.Operator.MUL,
                                            scalar_args[0], lhs.copy())
         mult_op_b = BinaryOperation.create(BinaryOperation.Operator.MUL,
                                            scalar_args[1], arg_refs[1])
         rhs = BinaryOperation.create(BinaryOperation.Operator.ADD,
                                      mult_op_a, mult_op_b)
  
         # Create assignment and replace node
         return self._replace_with_assignment(lhs, rhs)
  
  

References psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn._replace_with_assignment(), psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.get_indexed_field_argument_references(), and psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.get_scalar_argument_references().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ metadata()

def psyclone.domain.lfric.lfric_builtins.LFRicIncAXPlusBYKern.metadata ( cls )

Returns the kernel metadata describing this built-in.

:returns: kernel metadata describing this built-in.
:rtype: :py:class:`psyclone.domain.lfric.kernel.LFRicKernelMetadata`

Definition at line 914 of file lfric_builtins.py.

     def metadata(cls):
         '''Returns the kernel metadata describing this built-in.
  
         :returns: kernel metadata describing this built-in.
         :rtype: :py:class:`psyclone.domain.lfric.kernel.LFRicKernelMetadata`
  
         '''
         gh_datatype = LFRicConstants().MAPPING_INTRINSIC_TYPES[cls._datatype]
         return cls._builtin_metadata([
             ScalarArgMetadata(gh_datatype, "gh_read"),
             FieldArgMetadata(gh_datatype, "gh_readwrite", "any_space_1"),
             ScalarArgMetadata(gh_datatype, "gh_read"),
             FieldArgMetadata(gh_datatype, "gh_read", "any_space_1")])
  

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ lower_to_language_level()

◆ metadata()