psyclone.domain.lfric.lfric_builtins.LFRicRealToIntXKern Class Reference

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

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

Public Member Functions
def	metadata (cls)
def	__str__ (self)
def	lower_to_language_level (self)
Public Member Functions inherited from psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn
def	__init__ (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

 Converts real-valued field elements to integer-valued
field elements using the Fortran intrinsic `INT` function,
`Y = INT(X, kind=i_<prec>)`. Here `Y` is an integer-valued
field of precision `i_<prec>` and `X` is the real-valued
field being converted.

Definition at line 2687 of file lfric_builtins.py.

Member Function Documentation

lower_to_language_level()

def psyclone.domain.lfric.lfric_builtins.LFRicRealToIntXKern.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 2714 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()
 
        # Create the PSyIR for the kernel:
        #      proxy0%data(df) = INT(proxy1%data, kind=i_<prec>)
        lhs = arg_refs[0]
        i_precision = arg_refs[0].datatype.precision
        rhs = IntrinsicCall.create(
            IntrinsicCall.Intrinsic.INT,
            [arg_refs[1], ("kind", Reference(i_precision))])
 
        # Create assignment and replace node
        return self._replace_with_assignment(lhs, rhs)
 
 
# ------------------------------------------------------------------- #
# ============== Converting real to real field elements ============= #
# ------------------------------------------------------------------- #
 

References psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn._replace_with_assignment(), and psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.get_indexed_field_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.LFRicRealToIntXKern.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 2699 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`
 
        '''
        return cls._builtin_metadata([
            FieldArgMetadata("gh_integer", "gh_write", "any_space_1"),
            FieldArgMetadata("gh_real", "gh_read", "any_space_1")])
 

References psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn._builtin_metadata(), and psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.metadata().

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