psyclone.transformations.Dynamo0p3OMPLoopTrans Class Reference

Inheritance diagram for psyclone.transformations.Dynamo0p3OMPLoopTrans:

Collaboration diagram for psyclone.transformations.Dynamo0p3OMPLoopTrans:

Public Member Functions
def	__init__ (self, omp_schedule="static")
def	__str__ (self)
def	validate (self, node, options=None)
def	apply (self, node, options=None)
Public Member Functions inherited from psyclone.psyir.transformations.omp_loop_trans.OMPLoopTrans
def	__init__ (self, omp_directive="do", omp_schedule="auto")
def	omp_directive (self)
def	omp_directive (self, value)
def	omp_schedule (self)
def	omp_schedule (self, value)
Public Member Functions inherited from psyclone.psyir.transformations.loop_trans.LoopTrans
def	name (self)

Additional Inherited Members
Public Attributes inherited from psyclone.psyir.transformations.omp_loop_trans.OMPLoopTrans
	omp_schedule
	omp_directive
Static Public Attributes inherited from psyclone.psyir.transformations.parallel_loop_trans.ParallelLoopTrans
tuple	excluded_node_types = (nodes.Return, psyGen.HaloExchange, nodes.CodeBlock)
Static Public Attributes inherited from psyclone.psyir.transformations.loop_trans.LoopTrans
tuple	excluded_node_types = ()

Detailed Description

 LFRic (Dynamo 0.3) specific orphan OpenMP loop transformation. Adds
Dynamo-specific validity checks.

:param str omp_schedule: the OpenMP schedule to use. Must be one of \
    'runtime', 'static', 'dynamic', 'guided' or 'auto'. Defaults to \
    'static'.

Definition at line 845 of file transformations.py.

Member Function Documentation

apply()

def psyclone.transformations.Dynamo0p3OMPLoopTrans.apply	(		self,
			node,
			options = None
	)

 Apply LFRic (Dynamo 0.3) specific OMPLoopTrans.

:param node: the Node in the Schedule to check.
:type node: :py:class:`psyclone.psyir.nodes.Node`
:param options: a dictionary with options for transformations \
                and validation.
:type options: Optional[Dict[str, Any]]
:param bool options["reprod"]: \
        indicating whether reproducible reductions should be used. \
        By default the value from the config file will be used.

Reimplemented from psyclone.psyir.transformations.omp_loop_trans.OMPLoopTrans.

Definition at line 901 of file transformations.py.

    def apply(self, node, options=None):
        ''' Apply LFRic (Dynamo 0.3) specific OMPLoopTrans.
 
        :param node: the Node in the Schedule to check.
        :type node: :py:class:`psyclone.psyir.nodes.Node`
        :param options: a dictionary with options for transformations \
                        and validation.
        :type options: Optional[Dict[str, Any]]
        :param bool options["reprod"]: \
                indicating whether reproducible reductions should be used. \
                By default the value from the config file will be used.
 
        '''
        if not options:
            options = {}
 
        # Since this function potentially modifies the user's option
        # dictionary, create a copy:
        options = options.copy()
        # Make sure the default is set:
        options["reprod"] = options.get("reprod",
                                        Config.get().reproducible_reductions)
 
        # This transformation allows to parallelise loops with potential
        # dependencies because we use cell colouring to guarantee that
        # neighbours are not updated at the same time.
        options["force"] = True
 
        super().apply(node, options)
 
 

validate()

def psyclone.transformations.Dynamo0p3OMPLoopTrans.validate	(		self,
			node,
			options = None
	)

 Perform LFRic (Dynamo 0.3) specific loop validity checks for the
OMPLoopTrans.

:param node: the Node in the Schedule to check
:type node: :py:class:`psyclone.psyir.nodes.Node`
:param options: a dictionary with options for transformations \
                and validation.
:type options: Optional[Dict[str, Any]]
:param bool options["reprod"]: \
    indicating whether reproducible reductions should be used. \
    By default the value from the config file will be used.

:raises TransformationError: if an OMP loop transform would create \
    incorrect code.

Reimplemented from psyclone.psyir.transformations.parallel_loop_trans.ParallelLoopTrans.

Definition at line 861 of file transformations.py.

    def validate(self, node, options=None):
        ''' Perform LFRic (Dynamo 0.3) specific loop validity checks for the
        OMPLoopTrans.
 
        :param node: the Node in the Schedule to check
        :type node: :py:class:`psyclone.psyir.nodes.Node`
        :param options: a dictionary with options for transformations \
                        and validation.
        :type options: Optional[Dict[str, Any]]
        :param bool options["reprod"]: \
            indicating whether reproducible reductions should be used. \
            By default the value from the config file will be used.
 
        :raises TransformationError: if an OMP loop transform would create \
            incorrect code.
 
        '''
        if not options:
            options = {}
 
        # Since this function potentially modifies the user's option
        # dictionary, create a copy:
        options = options.copy()
        # Make sure the default is set:
        options["reprod"] = options.get("reprod",
                                        Config.get().reproducible_reductions)
 
        # This transformation allows to parallelise loops with potential
        # dependencies because we use cell colouring to guarantee that
        # neighbours are not updated at the same time.
        options["force"] = True
        super().validate(node, options=options)
 
        # If the loop is not already coloured then check whether or not
        # it should be
        if node.loop_type != 'colour' and node.has_inc_arg():
            raise TransformationError(
                f"Error in {self.name} transformation. The kernel has an "
                f"argument with INC access. Colouring is required.")
 

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