psyclone.domain.common.psylayer.psyloop.PSyLoop Class Reference

Inheritance diagram for psyclone.domain.common.psylayer.psyloop.PSyLoop:

Collaboration diagram for psyclone.domain.common.psylayer.psyloop.PSyLoop:

Public Member Functions
def	__init__ (self, valid_loop_types=None, **kwargs)
def	__eq__ (self, other)
def	dag_name (self)
def	valid_loop_types (self)
def	loop_type (self)
def	loop_type (self, value)
def	node_str (self, colour=True)
def	field_space (self)
def	field_space (self, my_field_space)
def	field_name (self)
def	field (self)
def	field_name (self, my_field_name)
def	iteration_space (self)
def	iteration_space (self, it_space)
def	kernel (self)
def	kernel (self, kern)
def	__str__ (self)
def	has_inc_arg (self)
def	unique_modified_args (self, arg_type)
def	unique_fields_with_halo_reads (self)
def	args_filter (self, arg_types=None, arg_accesses=None, unique=False)
def	gen_mark_halos_clean_dirty (self, parent)

Public Attributes
	loop_type
	field
	field_name
	field_space
	iteration_space
	kernel

Detailed Description

Node representing a psylayer loop within the PSyIR. It extends the PSyIR
loop construct with information about the domain-specific iteration space
that the loop is traversing and utility methods to interact with other
psylayer nodes.

:param List[str] valid_loop_types: a list of loop types that are specific \
    to a particular API.
:param kwargs: additional keyword arguments provided to the PSyIR node.
:type kwargs: unwrapped dict.

Definition at line 46 of file psyloop.py.

Member Function Documentation

__eq__()

def psyclone.domain.common.psylayer.psyloop.PSyLoop.__eq__	(		self,
			other
	)

Checks whether two nodes are equal. Two PSyLoop nodes are equal
if they have equal loop_type, field, field_name, field_space
iteraction_space and kernel.

:param object other: the object to check equality to.

:returns: whether other is equal to self.
:rtype: bool

Definition at line 82 of file psyloop.py.

    def __eq__(self, other):
        '''
        Checks whether two nodes are equal. Two PSyLoop nodes are equal
        if they have equal loop_type, field, field_name, field_space
        iteraction_space and kernel.
 
        :param object other: the object to check equality to.
 
        :returns: whether other is equal to self.
        :rtype: bool
        '''
        is_eq = super().__eq__(other)
        is_eq = is_eq and self.loop_type == other.loop_type
        is_eq = is_eq and self.field == other.field
        is_eq = is_eq and self.field_name == other.field_name
        is_eq = is_eq and self.field_space == other.field_space
        is_eq = is_eq and self.iteration_space == other.iteration_space
        is_eq = is_eq and self.kernel == other.kernel
        # pylint: disable=protected-access
        is_eq = is_eq and self._iterates_over == other._iterates_over
 
        return is_eq
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._iterates_over, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._iterates_over, psyclone.parse.kernel.KernelType._iterates_over, psyclone.psyGen.Kern._iterates_over, psyclone.domain.common.psylayer.psyloop.PSyLoop.field, psyclone.psyGen.HaloExchange.field(), psyclone.domain.lfric.arg_ordering.ArgOrdering.field(), psyclone.domain.lfric.kern_call_arg_list.KernCallArgList.field(), psyclone.domain.lfric.kern_call_invoke_arg_list.KernCallInvokeArgList.field(), psyclone.domain.lfric.kern_stub_arg_list.KernStubArgList.field(), psyclone.domain.lfric.kernel_interface.KernelInterface.field(), psyclone.domain.common.psylayer.psyloop.PSyLoop.field_name, psyclone.gocean1p0.GOLoop.field_name, psyclone.domain.common.psylayer.psyloop.PSyLoop.field_space, psyclone.gocean1p0.GOLoop.field_space, psyclone.domain.common.psylayer.psyloop.PSyLoop.iteration_space, psyclone.gocean1p0.GOLoop.iteration_space, psyclone.domain.common.psylayer.psyloop.PSyLoop.kernel, psyclone.domain.common.psylayer.psyloop.PSyLoop.loop_type, psyclone.domain.lfric.lfric_loop.LFRicLoop.loop_type, psyclone.gocean1p0.GOLoop.loop_type, and psyclone.psyir.nodes.loop.Loop.loop_type().

Here is the call graph for this function:

args_filter()

def psyclone.domain.common.psylayer.psyloop.PSyLoop.args_filter	(		self,
			arg_types = None,
			arg_accesses = None,
			unique = False
	)

:returns: all arguments of type arg_types and arg_accesses. If these \
    are not set then return all arguments. If unique is set to \
    True then only return uniquely named arguments.
:rtype: List[:py:class:`psyclone.psyGen.Argument`]

Definition at line 309 of file psyloop.py.

    def args_filter(self, arg_types=None, arg_accesses=None, unique=False):
        '''
        :returns: all arguments of type arg_types and arg_accesses. If these \
            are not set then return all arguments. If unique is set to \
            True then only return uniquely named arguments.
        :rtype: List[:py:class:`psyclone.psyGen.Argument`]
        '''
        # Avoid circular import
        # pylint: disable=import-outside-toplevel
        from psyclone.psyGen import args_filter
        all_args = []
        all_arg_names = []
        for call in self.kernels():
            call_args = args_filter(call.arguments.args, arg_types,
                                    arg_accesses)
            if unique:
                for arg in call_args:
                    if arg.name not in all_arg_names:
                        all_args.append(arg)
                        all_arg_names.append(arg.name)
            else:
                all_args.extend(call_args)
        return all_args
 

References psyclone.psyir.nodes.node.Node.kernels().

Here is the call graph for this function:

dag_name()

def psyclone.domain.common.psylayer.psyloop.PSyLoop.dag_name

(

self

)

:returns: the dag name to use for this loop.
:rtype: str

Definition at line 106 of file psyloop.py.

    def dag_name(self):
        '''
        :returns: the dag name to use for this loop.
        :rtype: str
 
        '''
        if self.loop_type:
            _, position = self._find_position(self.ancestor(Routine))
            name = f"loop_[{self.loop_type}]_{position}"
        else:
            name = super().dag_name
        return name
 

References psyclone.psyir.nodes.node.Node._find_position(), psyclone.psyir.nodes.node.Node.ancestor(), psyclone.domain.common.psylayer.psyloop.PSyLoop.loop_type, psyclone.domain.lfric.lfric_loop.LFRicLoop.loop_type, psyclone.gocean1p0.GOLoop.loop_type, and psyclone.psyir.nodes.loop.Loop.loop_type().

Here is the call graph for this function:

Here is the caller graph for this function:

field()

def psyclone.domain.common.psylayer.psyloop.PSyLoop.field

(

self

)

:returns: the field associated to this loop.
:rtype: :py:class:`psyclone.psyGen.Argument`

Definition at line 196 of file psyloop.py.

    def field(self):
        '''
        :returns: the field associated to this loop.
        :rtype: :py:class:`psyclone.psyGen.Argument`
        '''
        return self._field
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._field, psyclone.domain.lfric.arg_index_to_metadata_index.ArgIndexToMetadataIndex._field(), psyclone.domain.lfric.lfric_loop.LFRicLoop._field, psyclone.domain.lfric.metadata_to_arguments_rules.MetadataToArgumentsRules._field(), and psyclone.psyGen.HaloExchange._field.

Here is the call graph for this function:

Here is the caller graph for this function:

field_name() [1/2]

def psyclone.domain.common.psylayer.psyloop.PSyLoop.field_name

(

self

)

:returns: the field name associated to this loop.
:rtype: str

Definition at line 188 of file psyloop.py.

    def field_name(self):
        '''
        :returns: the field name associated to this loop.
        :rtype: str
        '''
        return self._field_name
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._field_name, and psyclone.domain.lfric.lfric_loop.LFRicLoop._field_name.

Here is the caller graph for this function:

field_name() [2/2]

def psyclone.domain.common.psylayer.psyloop.PSyLoop.field_name	(		self,
			my_field_name
	)

 Set a new field_name for the field associated to this loop.

:param str my_field_name: the new field name.

Definition at line 204 of file psyloop.py.

    def field_name(self, my_field_name):
        ''' Set a new field_name for the field associated to this loop.
 
        :param str my_field_name: the new field name.
        '''
        self._field_name = my_field_name
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._field_name, and psyclone.domain.lfric.lfric_loop.LFRicLoop._field_name.

Here is the caller graph for this function:

field_space() [1/2]

def psyclone.domain.common.psylayer.psyloop.PSyLoop.field_space

(

self

)

:returns: the field_space associated this loop.
:rtype: str

Reimplemented in psyclone.gocean1p0.GOLoop.

Definition at line 171 of file psyloop.py.

    def field_space(self):
        '''
        :returns: the field_space associated this loop.
        :rtype: str
        '''
        return self._field_space
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._field_space, psyclone.domain.lfric.lfric_loop.LFRicLoop._field_space, and psyclone.gocean1p0.GOLoop._field_space.

Here is the caller graph for this function:

field_space() [2/2]

def psyclone.domain.common.psylayer.psyloop.PSyLoop.field_space	(		self,
			my_field_space
	)

 Set a new field_space for this loop.

:param my_field_space: the new field_space value.
:rtype my_field_space: str

Reimplemented in psyclone.gocean1p0.GOLoop.

Definition at line 179 of file psyloop.py.

    def field_space(self, my_field_space):
        ''' Set a new field_space for this loop.
 
        :param my_field_space: the new field_space value.
        :rtype my_field_space: str
        '''
        self._field_space = my_field_space
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._field_space, psyclone.domain.lfric.lfric_loop.LFRicLoop._field_space, and psyclone.gocean1p0.GOLoop._field_space.

Here is the caller graph for this function:

gen_mark_halos_clean_dirty()

def psyclone.domain.common.psylayer.psyloop.PSyLoop.gen_mark_halos_clean_dirty	(		self,
			parent
	)

Generates the necessary code to mark halo regions as clean or dirty
following execution of this loop. This default implementation does
nothing.

TODO #1648 - this method should be removed when the corresponding
one in LFRicLoop is removed.

:param parent: the node in the f2pygen AST to which to add content.
:type parent: :py:class:`psyclone.f2pygen.BaseGen`

Reimplemented in psyclone.domain.lfric.lfric_loop.LFRicLoop.

Definition at line 333 of file psyloop.py.

    def gen_mark_halos_clean_dirty(self, parent):
        '''
        Generates the necessary code to mark halo regions as clean or dirty
        following execution of this loop. This default implementation does
        nothing.
 
        TODO #1648 - this method should be removed when the corresponding
        one in LFRicLoop is removed.
 
        :param parent: the node in the f2pygen AST to which to add content.
        :type parent: :py:class:`psyclone.f2pygen.BaseGen`
 
        '''
 

Here is the caller graph for this function:

has_inc_arg()

def psyclone.domain.common.psylayer.psyloop.PSyLoop.has_inc_arg

(

self

)

:returns: True if any of the Kernels called within this loop have an \
        argument with INC access, False otherwise.
:rtype: bool

Definition at line 258 of file psyloop.py.

    def has_inc_arg(self):
        '''
        :returns: True if any of the Kernels called within this loop have an \
                argument with INC access, False otherwise.
        :rtype: bool
        '''
        for kern_call in self.coded_kernels():
            for arg in kern_call.arguments.args:
                if arg.access == AccessType.INC:
                    return True
        return False
 

References psyclone.nemo.NemoInvokeSchedule.coded_kernels(), and psyclone.psyir.nodes.node.Node.coded_kernels().

Here is the call graph for this function:

Here is the caller graph for this function:

iteration_space() [1/2]

def psyclone.domain.common.psylayer.psyloop.PSyLoop.iteration_space

(

self

)

:returns: the iteration_space of this loop.
:rtype: str

Reimplemented in psyclone.gocean1p0.GOLoop.

Definition at line 212 of file psyloop.py.

    def iteration_space(self):
        '''
        :returns: the iteration_space of this loop.
        :rtype: str
        '''
        return self._iteration_space
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._iteration_space, psyclone.domain.lfric.lfric_loop.LFRicLoop._iteration_space, and psyclone.gocean1p0.GOLoop._iteration_space.

Here is the caller graph for this function:

iteration_space() [2/2]

def psyclone.domain.common.psylayer.psyloop.PSyLoop.iteration_space	(		self,
			it_space
	)

 Set a new iteration space for this loop.

:param str it_space: the new iteration_space fore this loop.

Reimplemented in psyclone.gocean1p0.GOLoop.

Definition at line 220 of file psyloop.py.

    def iteration_space(self, it_space):
        ''' Set a new iteration space for this loop.
 
        :param str it_space: the new iteration_space fore this loop.
        '''
        self._iteration_space = it_space
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._iteration_space, psyclone.domain.lfric.lfric_loop.LFRicLoop._iteration_space, and psyclone.gocean1p0.GOLoop._iteration_space.

Here is the caller graph for this function:

kernel() [1/2]

def psyclone.domain.common.psylayer.psyloop.PSyLoop.kernel

(

self

)

:returns: the kernel object associated with this PSyLoop (if any).
:rtype: Optional[:py:class:`psyclone.psyGen.Kern`]

Definition at line 228 of file psyloop.py.

    def kernel(self):
        '''
        :returns: the kernel object associated with this PSyLoop (if any).
        :rtype: Optional[:py:class:`psyclone.psyGen.Kern`]
        '''
        return self._kern
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._kern, psyclone.domain.lfric.arg_ordering.ArgOrdering._kern, and psyclone.domain.lfric.lfric_loop.LFRicLoop._kern.

Here is the caller graph for this function:

kernel() [2/2]

def psyclone.domain.common.psylayer.psyloop.PSyLoop.kernel	(		self,
			kern
	)

Setter for kernel object associated with this PSyLoop.

:param kern: a kernel object.
:type kern: :py:class:`psyclone.psyGen.Kern`

Definition at line 236 of file psyloop.py.

    def kernel(self, kern):
        '''
        Setter for kernel object associated with this PSyLoop.
 
        :param kern: a kernel object.
        :type kern: :py:class:`psyclone.psyGen.Kern`
        '''
        self._kern = kern
 

References psyclone.psyir.symbols.symbol.Symbol.__class__, psyclone.f2pygen.BaseGen._children, psyclone.psyir.nodes.node.Node._children, psyclone.psyir.nodes.omp_directives.OMPParallelDirective._children, psyclone.domain.common.psylayer.psyloop.PSyLoop._kern, psyclone.domain.lfric.arg_ordering.ArgOrdering._kern, psyclone.domain.lfric.lfric_loop.LFRicLoop._kern, psyclone.domain.common.psylayer.psyloop.PSyLoop._loop_type, psyclone.domain.lfric.lfric_loop.LFRicLoop._loop_type, psyclone.gocean1p0.GOLoop._loop_type, psyclone.domain.common.psylayer.psyloop.PSyLoop.loop_type, psyclone.domain.lfric.lfric_loop.LFRicLoop.loop_type, psyclone.gocean1p0.GOLoop.loop_type, psyclone.psyir.nodes.loop.Loop.loop_type(), psyclone.domain.lfric.lfric_loop.LFRicLoop.variable, psyclone.gocean1p0.GOLoop.variable, and psyclone.psyir.nodes.loop.Loop.variable.

Here is the call graph for this function:

Here is the caller graph for this function:

loop_type() [1/2]

def psyclone.domain.common.psylayer.psyloop.PSyLoop.loop_type

(

self

)

:returns: the (domain-specific) type of this loop.
:rtype: str

Definition at line 128 of file psyloop.py.

    def loop_type(self):
        '''
        :returns: the (domain-specific) type of this loop.
        :rtype: str
        '''
        return self._loop_type
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._loop_type, psyclone.domain.lfric.lfric_loop.LFRicLoop._loop_type, and psyclone.gocean1p0.GOLoop._loop_type.

Here is the caller graph for this function:

loop_type() [2/2]

def psyclone.domain.common.psylayer.psyloop.PSyLoop.loop_type	(		self,
			value
	)

Set the type of this Loop.

:param str value: the type of this loop.

:raises TypeError: if the specified value is not a recognised \
    loop type.

Definition at line 136 of file psyloop.py.

    def loop_type(self, value):
        '''
        Set the type of this Loop.
 
        :param str value: the type of this loop.
 
        :raises TypeError: if the specified value is not a recognised \
            loop type.
        '''
        if value not in self._valid_loop_types:
            raise TypeError(
                f"Error, loop_type value ({value}) is invalid. Must be one of "
                f"{self._valid_loop_types}.")
        self._loop_type = value
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._loop_type, psyclone.domain.lfric.lfric_loop.LFRicLoop._loop_type, psyclone.gocean1p0.GOLoop._loop_type, and psyclone.domain.common.psylayer.psyloop.PSyLoop._valid_loop_types.

Here is the caller graph for this function:

node_str()

def psyclone.domain.common.psylayer.psyloop.PSyLoop.node_str	(		self,
			colour = True
	)

Returns the name of this node with (optional) control codes
to generate coloured output in a terminal that supports it.

:param bool colour: whether or not to include colour control codes.

:returns: description of this node, possibly coloured.
:rtype: str

Reimplemented in psyclone.domain.lfric.lfric_loop.LFRicLoop.

Definition at line 151 of file psyloop.py.

    def node_str(self, colour=True):
        '''
        Returns the name of this node with (optional) control codes
        to generate coloured output in a terminal that supports it.
 
        :param bool colour: whether or not to include colour control codes.
 
        :returns: description of this node, possibly coloured.
        :rtype: str
 
        '''
        return (f"{self.coloured_name(colour)}[type='{self._loop_type}', "
                f"field_space='{self._field_space}', "
                f"it_space='{self.iteration_space}']")
 

Here is the caller graph for this function:

unique_fields_with_halo_reads()

def psyclone.domain.common.psylayer.psyloop.PSyLoop.unique_fields_with_halo_reads

(

self

)

:returns: fields in this loop that require at least some of their \
    halo to be clean to work correctly.
:rtype: List[:py:class:`psyclone.psyGen.Argument`]

Definition at line 291 of file psyloop.py.

    def unique_fields_with_halo_reads(self):
        '''
        :returns: fields in this loop that require at least some of their \
            halo to be clean to work correctly.
        :rtype: List[:py:class:`psyclone.psyGen.Argument`]
        '''
 
        unique_fields = []
        unique_field_names = []
 
        for call in self.kernels():
            for arg in call.arguments.args:
                if self._halo_read_access(arg):
                    if arg.name not in unique_field_names:
                        unique_field_names.append(arg.name)
                        unique_fields.append(arg)
        return unique_fields
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._halo_read_access(), psyclone.domain.lfric.lfric_loop.LFRicLoop._halo_read_access(), psyclone.gocean1p0.GOLoop._halo_read_access(), and psyclone.psyir.nodes.node.Node.kernels().

Here is the call graph for this function:

Here is the caller graph for this function:

unique_modified_args()

def psyclone.domain.common.psylayer.psyloop.PSyLoop.unique_modified_args	(		self,
			arg_type
	)

Return all unique arguments of the given type from kernels inside
this loop that are modified.

:param str arg_type: the type of kernel argument (e.g. field, \
                     operator) to search for.
:returns: all unique arguments of the given type from kernels inside \
    this loop that are modified.
:rtype: List[:py:class:`psyclone.psyGen.DynKernelArgument`]

Definition at line 270 of file psyloop.py.

    def unique_modified_args(self, arg_type):
        '''Return all unique arguments of the given type from kernels inside
        this loop that are modified.
 
        :param str arg_type: the type of kernel argument (e.g. field, \
                             operator) to search for.
        :returns: all unique arguments of the given type from kernels inside \
            this loop that are modified.
        :rtype: List[:py:class:`psyclone.psyGen.DynKernelArgument`]
        '''
        arg_names = []
        args = []
        for call in self.kernels():
            for arg in call.arguments.args:
                if arg.argument_type.lower() == arg_type:
                    if arg.access != AccessType.READ:
                        if arg.name not in arg_names:
                            arg_names.append(arg.name)
                            args.append(arg)
        return args
 

References psyclone.psyir.nodes.node.Node.kernels().

Here is the call graph for this function:

Here is the caller graph for this function:

valid_loop_types()

def psyclone.domain.common.psylayer.psyloop.PSyLoop.valid_loop_types

(

self

)

:returns: the (domain-specific) loop types allowed by this instance.
:rtype: list of str

Definition at line 120 of file psyloop.py.

    def valid_loop_types(self):
        '''
        :returns: the (domain-specific) loop types allowed by this instance.
        :rtype: list of str
        '''
        return self._valid_loop_types
 

References psyclone.domain.common.psylayer.psyloop.PSyLoop._valid_loop_types.

---

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/common/psylayer/psyloop.py