Inheritance diagram for psyclone.transformations.OMPParallelLoopTrans:

[legend]

Collaboration diagram for psyclone.transformations.OMPParallelLoopTrans:

[legend]

Public Member Functions
def	__str__ (self)

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.parallel_loop_trans.ParallelLoopTrans
def	validate (self, node, options=None)

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

 Adds an OpenMP PARALLEL DO directive to a loop.

    For example:

    >>> from psyclone.parse.algorithm import parse
    >>> from psyclone.psyGen import PSyFactory
    >>> ast, invokeInfo = parse("dynamo.F90")
    >>> psy = PSyFactory("dynamo0.3").create(invokeInfo)
    >>> schedule = psy.invokes.get('invoke_v3_kernel_type').schedule
    >>> # Uncomment the following line to see a text view of the schedule
    >>> # print(schedule.view())
    >>>
    >>> from psyclone.transformations import OMPParallelLoopTrans
    >>> trans = OMPParallelLoopTrans()
    >>> trans.apply(schedule.children[0])
    >>> # Uncomment the following line to see a text view of the schedule
    >>> # print(schedule.view())

Definition at line 681 of file transformations.py.

Member Function Documentation

◆ apply()

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

 Apply an OMPParallelLoop Transformation to the supplied node
(which must be a Loop). In the generated code this corresponds to
wrapping the Loop with directives:

.. code-block:: fortran

  !$OMP PARALLEL DO ...
  do ...
    ...
  end do
  !$OMP END PARALLEL DO

:param node: the node (loop) to which to apply the transformation.
:type node: :py:class:`psyclone.f2pygen.DoGen`
:param options: a dictionary with options for transformations\
                and validation.
:type options: Optional[Dict[str, Any]]

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

Reimplemented in psyclone.transformations.GOceanOMPParallelLoopTrans.

Definition at line 705 of file transformations.py.

     def apply(self, node, options=None):
         ''' Apply an OMPParallelLoop Transformation to the supplied node
         (which must be a Loop). In the generated code this corresponds to
         wrapping the Loop with directives:
  
         .. code-block:: fortran
  
           !$OMP PARALLEL DO ...
           do ...
             ...
           end do
           !$OMP END PARALLEL DO
  
         :param node: the node (loop) to which to apply the transformation.
         :type node: :py:class:`psyclone.f2pygen.DoGen`
         :param options: a dictionary with options for transformations\
                         and validation.
         :type options: Optional[Dict[str, Any]]
         '''
         self.validate(node, options=options)
  
         # keep a reference to the node's original parent and its index as these
         # are required and will change when we change the node's location
         node_parent = node.parent
         node_position = node.position
  
         # add our OpenMP loop directive setting its parent to the node's
         # parent and its children to the node
         directive = OMPParallelDoDirective(children=[node.detach()],
                                            omp_schedule=self.omp_schedule)
  
         # add the OpenMP loop directive as a child of the node's parent
         node_parent.addchild(directive, index=node_position)
  
  

Here is the call 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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ apply()