Inheritance diagram for psyclone.psyGen.HaloExchange:

[legend]

Collaboration diagram for psyclone.psyGen.HaloExchange:

Public Member Functions
def	__init__ (self, field, check_dirty=True, vector_index=None, parent=None)

def	vector_index (self)

def	halo_depth (self)

def	halo_depth (self, value)

def	field (self)

def	dag_name (self)

def	args (self)

def	check_vector_halos_differ (self, node)

def	node_str (self, colour=True)

Public Attributes
	vector_index

Detailed Description

Generic Halo Exchange class which can be added to and
manipulated in, a schedule.

:param field: the field that this halo exchange will act on
:type field: :py:class:`psyclone.dynamo0p3.DynKernelArgument`
:param check_dirty: optional argument default True indicating whether \
                    this halo exchange should be subject to a run-time \
                    check for clean/dirty halos.
:type check_dirty: bool
:param vector_index: optional vector index (default None) to identify \
                     which index of a vector field this halo exchange is \
                     responsible for.
:type vector_index: int
:param parent: optional parent (default None) of this object
:type parent: :py:class:`psyclone.psyir.nodes.Node`

Definition at line 841 of file psyGen.py.

Member Function Documentation

◆ args()

def psyclone.psyGen.HaloExchange.args ( self )

Return the list of arguments associated with this node. Overide the
base method and simply return our argument.

Definition at line 920 of file psyGen.py.

     def args(self):
         '''Return the list of arguments associated with this node. Overide the
         base method and simply return our 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:

◆ check_vector_halos_differ()

def psyclone.psyGen.HaloExchange.check_vector_halos_differ	(	self,
		node
	)

Helper method which checks that two halo exchange nodes (one being
self and the other being passed by argument) operating on the
same field, both have vector fields of the same size and use
different vector indices. If this is the case then the halo
exchange nodes do not depend on each other. If this is not the
case then an internal error will have occured and we raise an
appropriate exception.

:param node: a halo exchange which should exchange the same field as \
             self.
:type node: :py:class:`psyclone.psyGen.HaloExchange`
:raises GenerationError: if the argument passed is not a halo exchange.
:raises GenerationError: if the field name in the halo exchange \
                         passed in has a different name to the field \
                         in this halo exchange.
:raises GenerationError: if the field in this halo exchange is not a \
                         vector field
:raises GenerationError: if the vector size of the field in this halo \
                         exchange is different to vector size of the \
                         field in the halo exchange passed by argument.
:raises GenerationError: if the vector index of the field in this \
                         halo exchange is the same as the vector \
                         index of the field in the halo exchange \
                         passed by argument.

Definition at line 925 of file psyGen.py.

     def check_vector_halos_differ(self, node):
         '''Helper method which checks that two halo exchange nodes (one being
         self and the other being passed by argument) operating on the
         same field, both have vector fields of the same size and use
         different vector indices. If this is the case then the halo
         exchange nodes do not depend on each other. If this is not the
         case then an internal error will have occured and we raise an
         appropriate exception.
  
         :param node: a halo exchange which should exchange the same field as \
                      self.
         :type node: :py:class:`psyclone.psyGen.HaloExchange`
         :raises GenerationError: if the argument passed is not a halo exchange.
         :raises GenerationError: if the field name in the halo exchange \
                                  passed in has a different name to the field \
                                  in this halo exchange.
         :raises GenerationError: if the field in this halo exchange is not a \
                                  vector field
         :raises GenerationError: if the vector size of the field in this halo \
                                  exchange is different to vector size of the \
                                  field in the halo exchange passed by argument.
         :raises GenerationError: if the vector index of the field in this \
                                  halo exchange is the same as the vector \
                                  index of the field in the halo exchange \
                                  passed by argument.
  
         '''
  
         if not isinstance(node, HaloExchange):
             raise GenerationError(
                 "Internal error, the argument passed to "
                 "HaloExchange.check_vector_halos_differ() is not "
                 "a halo exchange object")
  
         if self.field.name != node.field.name:
             raise GenerationError(
                 f"Internal error, the halo exchange object passed to "
                 f"HaloExchange.check_vector_halos_differ() has a different "
                 f"field name '{node.field.name}' to self '{self.field.name}'")
  
         if self.field.vector_size <= 1:
             raise GenerationError(
                 "Internal error, HaloExchange.check_vector_halos_differ() "
                 "a halo exchange depends on another halo exchange but the "
                 f"vector size of field '{self.field.name}' is 1")
  
         if self.field.vector_size != node.field.vector_size:
             raise GenerationError(
                 f"Internal error, HaloExchange.check_vector_halos_differ() "
                 f"a halo exchange depends on another halo exchange but the "
                 f"vector sizes for field '{self.field.name}' differ")
  
         if self.vector_index == node.vector_index:
             raise GenerationError(
                 f"Internal error, HaloExchange.check_vector_halos_differ() "
                 f"a halo exchange depends on another halo exchange but both "
                 f"vector id's ('{self.vector_index}') of field "
                 f"'{self.field.name}' are the same")
  

References 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(), and psyclone.psyGen.HaloExchange.vector_index.

Here is the call graph for this function:

◆ dag_name()

def psyclone.psyGen.HaloExchange.dag_name ( self )

:returns: the name to use in a dag for this node.
:rtype: str

Definition at line 909 of file psyGen.py.

     def dag_name(self):
         '''
         :returns: the name to use in a dag for this node.
         :rtype: str
         '''
         name = f"{self._text_name}({self._field.name})_{self.position}"
         if self._check_dirty:
             name = "check" + name
         return name
  

References psyclone.psyGen.HaloExchange._check_dirty.

Here is the caller graph for this function:

◆ field()

def psyclone.psyGen.HaloExchange.field ( self )

 Return the field that the halo exchange acts on

Definition at line 904 of file psyGen.py.

     def field(self):
         ''' Return the field that the halo exchange acts on '''
         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:

◆ halo_depth() [1/2]

def psyclone.psyGen.HaloExchange.halo_depth ( self )

 Return the depth of the halo exchange

Definition at line 894 of file psyGen.py.

     def halo_depth(self):
         ''' Return the depth of the halo exchange '''
         return self._halo_depth
  

References psyclone.psyGen.HaloExchange._halo_depth.

Here is the caller graph for this function:

◆ halo_depth() [2/2]

def psyclone.psyGen.HaloExchange.halo_depth	(	self,
		value
	)

 Set the depth of the halo exchange

Definition at line 899 of file psyGen.py.

     def halo_depth(self, value):
         ''' Set the depth of the halo exchange '''
         self._halo_depth = value
  

References psyclone.psyGen.HaloExchange._halo_depth, and psyclone.psyGen.HaloExchange.halo_depth().

Here is the call graph for this function:

◆ node_str()

def psyclone.psyGen.HaloExchange.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.dynamo0p3.LFRicHaloExchange.

Definition at line 984 of file psyGen.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)}[field='{self._field.name}', "
                 f"type='{self._halo_type}', depth={self._halo_depth}, "
                 f"check_dirty={self._check_dirty}]")
  
  

Here is the caller graph for this function:

◆ vector_index()

def psyclone.psyGen.HaloExchange.vector_index ( self )

If the field is a vector then return the vector index associated
with this halo exchange. Otherwise return None

Definition at line 888 of file psyGen.py.

     def vector_index(self):
         '''If the field is a vector then return the vector index associated
         with this halo exchange. Otherwise return None'''
         return self._vector_index
  

References psyclone.psyGen.HaloExchange._vector_index.

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

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ args()

◆ check_vector_halos_differ()

◆ dag_name()

◆ field()

◆ halo_depth() [1/2]

◆ halo_depth() [2/2]

◆ node_str()

◆ vector_index()