Inheritance diagram for psyclone.transformations.Dynamo0p3AsyncHaloExchangeTrans:

[legend]

Collaboration diagram for psyclone.transformations.Dynamo0p3AsyncHaloExchangeTrans:

[legend]

Public Member Functions
def	__str__ (self)

def	name (self)

def	apply (self, node, options=None)

def	validate (self, node, options)

Detailed Description

Splits a synchronous halo exchange into a halo exchange start and
halo exchange end. For example:

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

Definition at line 1991 of file transformations.py.

Member Function Documentation

◆ apply()

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

Transforms a synchronous halo exchange, represented by a
HaloExchange node, into an asynchronous halo exchange,
represented by HaloExchangeStart and HaloExchangeEnd nodes.

:param node: a synchronous haloexchange node.
:type node: :py:obj:`psyclone.psygen.HaloExchange`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2023 of file transformations.py.

     def apply(self, node, options=None):
         '''Transforms a synchronous halo exchange, represented by a
         HaloExchange node, into an asynchronous halo exchange,
         represented by HaloExchangeStart and HaloExchangeEnd nodes.
  
         :param node: a synchronous haloexchange node.
         :type node: :py:obj:`psyclone.psygen.HaloExchange`
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
  
         '''
         self.validate(node, options)
  
         # add asynchronous start and end halo exchanges and initialise
         # them using information from the existing synchronous halo
         # exchange
         # pylint: disable=protected-access
         node.parent.addchild(
             LFRicHaloExchangeStart(
                 node.field, check_dirty=node._check_dirty,
                 vector_index=node.vector_index, parent=node.parent),
             index=node.position)
         node.parent.addchild(
             LFRicHaloExchangeEnd(
                 node.field, check_dirty=node._check_dirty,
                 vector_index=node.vector_index, parent=node.parent),
             index=node.position)
  
         # remove the existing synchronous halo exchange
         node.detach()
  

Here is the call graph for this function:

◆ name()

def psyclone.transformations.Dynamo0p3AsyncHaloExchangeTrans.name ( self )

:returns: the name of this transformation as a string.
:rtype: str

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2016 of file transformations.py.

     def name(self):
         '''
         :returns: the name of this transformation as a string.
         :rtype: str
         '''
         return "Dynamo0p3AsyncHaloExchangeTrans"
  

Here is the caller graph for this function:

◆ validate()

def psyclone.transformations.Dynamo0p3AsyncHaloExchangeTrans.validate	(	self,
		node,
		options
	)

Internal method to check whether the node is valid for this
transformation.

:param node: a synchronous Halo Exchange node
:type node: :py:obj:`psyclone.psygen.HaloExchange`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]

:raises TransformationError: if the node argument is not a
                 HaloExchange (or subclass thereof)

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2054 of file transformations.py.

     def validate(self, node, options):
         # pylint: disable=signature-differs
         '''Internal method to check whether the node is valid for this
         transformation.
  
         :param node: a synchronous Halo Exchange node
         :type node: :py:obj:`psyclone.psygen.HaloExchange`
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
  
         :raises TransformationError: if the node argument is not a
                          HaloExchange (or subclass thereof)
  
         '''
         if not isinstance(node, psyGen.HaloExchange) or \
            isinstance(node, (LFRicHaloExchangeStart, LFRicHaloExchangeEnd)):
             raise TransformationError(
                 f"Error in Dynamo0p3AsyncHaloExchange transformation. Supplied"
                 f" node must be a synchronous halo exchange but found "
                 f"'{type(node)}'.")
  
  

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ apply()

◆ name()

◆ validate()