Inheritance diagram for psyclone.dynamo0p3.HaloDepth:

Public Member Functions
def	__init__ (self, sym_table)

def	annexed_only (self)

def	max_depth (self)

def	max_depth_m1 (self)

def	var_depth (self)

def	literal_depth (self)

def	literal_depth (self, value)

def	set_by_value (self, max_depth, var_depth, literal_depth, annexed_only, max_depth_m1)

def	__str__ (self)

def	psyir_expression (self)

Detailed Description

Determines how much of the halo a read to a field accesses (the
halo depth).

:param sym_table: the symbol table of the enclosing InvokeSchedule.
:type sym_table: :py:class:`psyclone.psyir.symbols.SymbolTable`

Definition at line 4418 of file dynamo0p3.py.

Member Function Documentation

◆ str()

def psyclone.dynamo0p3.HaloDepth.__str__ ( self )

return the depth of a halo dependency
as a string

Definition at line 4545 of file dynamo0p3.py.

     def __str__(self):
         '''return the depth of a halo dependency
         as a string'''
         depth_str = ""
         if self.max_depth:
             max_depth = self._symbol_table.lookup_with_tag(
                 "max_halo_depth_mesh")
             depth_str += max_depth.name
         elif self.max_depth_m1:
             max_depth = self._symbol_table.lookup_with_tag(
                 "max_halo_depth_mesh")
             depth_str += f"{max_depth.name}-1"
         else:
             if self.var_depth:
                 depth_str += self.var_depth
                 if self.literal_depth:
                     # Ignores depth == 0
                     depth_str += f"+{self.literal_depth}"
             elif self.literal_depth is not None:
                 # Returns depth if depth has any value, including 0
                 depth_str = str(self.literal_depth)
         return depth_str
  

References psyclone.domain.lfric.lfric_collection.LFRicCollection._symbol_table, psyclone.dynamo0p3.DynMeshes._symbol_table, psyclone.dynamo0p3.HaloDepth._symbol_table, psyclone.psyGen.HaloExchange._symbol_table, psyclone.psyir.backend.sympy_writer.SymPyWriter._symbol_table, psyclone.psyir.nodes.scoping_node.ScopingNode._symbol_table, psyclone.dynamo0p3.HaloDepth.literal_depth(), psyclone.dynamo0p3.HaloDepth.max_depth(), psyclone.dynamo0p3.HaloDepth.max_depth_m1(), and psyclone.dynamo0p3.HaloDepth.var_depth().

Here is the call graph for this function:

◆ annexed_only()

def psyclone.dynamo0p3.HaloDepth.annexed_only ( self )

:returns: True if only annexed dofs are accessed in the halo and \
          False otherwise.
:rtype: bool

Definition at line 4458 of file dynamo0p3.py.

     def annexed_only(self):
         '''
         :returns: True if only annexed dofs are accessed in the halo and \
                   False otherwise.
         :rtype: bool
         '''
         return self._annexed_only
  

References psyclone.dynamo0p3.HaloDepth._annexed_only, and psyclone.dynamo0p3.HaloReadAccess._annexed_only.

◆ literal_depth() [1/2]

def psyclone.dynamo0p3.HaloDepth.literal_depth ( self )

Returns the known fixed (literal) depth of halo access. Note, this
depth should be added to the var_depth to find the total depth.

:returns: the known fixed (literal) halo access depth.
:rtype: int

Definition at line 4502 of file dynamo0p3.py.

     def literal_depth(self):
         '''Returns the known fixed (literal) depth of halo access. Note, this
         depth should be added to the var_depth to find the total depth.
  
         :returns: the known fixed (literal) halo access depth.
         :rtype: int
  
         '''
         return self._literal_depth
  

References psyclone.dynamo0p3.HaloDepth._literal_depth, and psyclone.dynamo0p3.HaloReadAccess._literal_depth.

Here is the caller graph for this function:

◆ literal_depth() [2/2]

def psyclone.dynamo0p3.HaloDepth.literal_depth	(	self,
		value
	)

 Set the known fixed (literal) depth of halo access.

:param int value: Set the known fixed (literal) halo access depth.

Definition at line 4513 of file dynamo0p3.py.

     def literal_depth(self, value):
         ''' Set the known fixed (literal) depth of halo access.
  
         :param int value: Set the known fixed (literal) halo access depth.
  
         '''
         self._literal_depth = value
  

References psyclone.dynamo0p3.HaloDepth._literal_depth, psyclone.dynamo0p3.HaloReadAccess._literal_depth, and psyclone.dynamo0p3.HaloDepth.literal_depth().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ max_depth()

def psyclone.dynamo0p3.HaloDepth.max_depth ( self )

:returns: True if the read to the field is known to access all \
          of the halo and False otherwise.
:rtype: bool

Definition at line 4467 of file dynamo0p3.py.

     def max_depth(self):
         '''
         :returns: True if the read to the field is known to access all \
                   of the halo and False otherwise.
         :rtype: bool
         '''
         return self._max_depth
  

References psyclone.dynamo0p3.HaloDepth._max_depth, and psyclone.dynamo0p3.HaloReadAccess._max_depth.

Here is the caller graph for this function:

◆ max_depth_m1()

def psyclone.dynamo0p3.HaloDepth.max_depth_m1 ( self )

Returns whether the read to the field is known to access all of the
halo except the outermost level or not.

:returns: True if the read to the field is known to access all \
          of the halo except the outermost and False otherwise.
:rtype: bool

Definition at line 4476 of file dynamo0p3.py.

     def max_depth_m1(self):
         '''Returns whether the read to the field is known to access all of the
         halo except the outermost level or not.
  
         :returns: True if the read to the field is known to access all \
                   of the halo except the outermost and False otherwise.
         :rtype: bool
  
         '''
         return self._max_depth_m1
  

References psyclone.dynamo0p3.HaloDepth._max_depth_m1.

Here is the caller graph for this function:

◆ psyir_expression()

def psyclone.dynamo0p3.HaloDepth.psyir_expression ( self )

:returns: the PSyIR expression representing this HaloDepth.
:rtype: :py:class:`psyclone.psyir.nodes.Node`

Definition at line 4568 of file dynamo0p3.py.

     def psyir_expression(self):
         '''
         :returns: the PSyIR expression representing this HaloDepth.
         :rtype: :py:class:`psyclone.psyir.nodes.Node`
         '''
         if self.max_depth:
             max_depth = self._symbol_table.lookup_with_tag(
                 "max_halo_depth_mesh")
             return Reference(max_depth)
         if self.max_depth_m1:
             max_depth = self._symbol_table.lookup_with_tag(
                 "max_halo_depth_mesh")
             return BinaryOperation.create(
                         BinaryOperation.Operator.SUB,
                         Reference(max_depth),
                         Literal('1', INTEGER_TYPE))
         if self.var_depth:
             depth_ref = Reference(self._symbol_table.lookup(self.var_depth))
             if self.literal_depth != 0:  # Ignores depth == 0
                 return BinaryOperation.create(
                             BinaryOperation.Operator.ADD,
                             depth_ref,
                             Literal(f"{self.literal_depth}", INTEGER_TYPE))
             return depth_ref
         # Returns depth if depth has any value, including 0
         return Literal(str(self.literal_depth), INTEGER_TYPE)
  
  

References psyclone.domain.lfric.lfric_collection.LFRicCollection._symbol_table, psyclone.dynamo0p3.DynMeshes._symbol_table, psyclone.dynamo0p3.HaloDepth._symbol_table, psyclone.psyGen.HaloExchange._symbol_table, psyclone.psyir.backend.sympy_writer.SymPyWriter._symbol_table, psyclone.psyir.nodes.scoping_node.ScopingNode._symbol_table, psyclone.dynamo0p3.HaloDepth.literal_depth(), psyclone.dynamo0p3.HaloDepth.max_depth(), psyclone.dynamo0p3.HaloDepth.max_depth_m1(), and psyclone.dynamo0p3.HaloDepth.var_depth().

Here is the call graph for this function:

◆ set_by_value()

def psyclone.dynamo0p3.HaloDepth.set_by_value	(	self,
		max_depth,
		var_depth,
		literal_depth,
		annexed_only,
		max_depth_m1
	)

Set halo depth information directly

:param bool max_depth: True if the field accesses all of the \
halo and False otherwise
:param str var_depth: A variable name specifying the halo \
access depth, if one exists, and None if not
:param int literal_depth: The known fixed (literal) halo \
access depth
:param bool annexed_only: True if only the halo's annexed dofs \
are accessed and False otherwise
:param bool max_depth_m1: True if the field accesses all of \
the halo but does not require the outermost halo to be correct \
and False otherwise

Definition at line 4521 of file dynamo0p3.py.

                      max_depth_m1):
         # pylint: disable=too-many-arguments
         '''Set halo depth information directly
  
         :param bool max_depth: True if the field accesses all of the \
         halo and False otherwise
         :param str var_depth: A variable name specifying the halo \
         access depth, if one exists, and None if not
         :param int literal_depth: The known fixed (literal) halo \
         access depth
         :param bool annexed_only: True if only the halo's annexed dofs \
         are accessed and False otherwise
         :param bool max_depth_m1: True if the field accesses all of \
         the halo but does not require the outermost halo to be correct \
         and False otherwise
  
         '''
         self._max_depth = max_depth
         self._var_depth = var_depth
         self._literal_depth = literal_depth
         self._annexed_only = annexed_only
         self._max_depth_m1 = max_depth_m1
  

References psyclone.dynamo0p3.HaloDepth._annexed_only, psyclone.dynamo0p3.HaloReadAccess._annexed_only, psyclone.dynamo0p3.HaloDepth._literal_depth, psyclone.dynamo0p3.HaloReadAccess._literal_depth, psyclone.dynamo0p3.HaloDepth._max_depth, psyclone.dynamo0p3.HaloReadAccess._max_depth, psyclone.dynamo0p3.HaloDepth._max_depth_m1, psyclone.dynamo0p3.HaloDepth._var_depth, and psyclone.dynamo0p3.HaloReadAccess._var_depth.

◆ var_depth()

def psyclone.dynamo0p3.HaloDepth.var_depth ( self )

Returns the name of the variable specifying the depth of halo
access if one is provided. Note, a variable will only be provided for
stencil accesses. Also note, this depth should be added to the
literal_depth to find the total depth.

:returns: a variable name specifying the halo access depth \
          if one exists, and None if not.
:rtype: str

Definition at line 4488 of file dynamo0p3.py.

     def var_depth(self):
         '''Returns the name of the variable specifying the depth of halo
         access if one is provided. Note, a variable will only be provided for
         stencil accesses. Also note, this depth should be added to the
         literal_depth to find the total depth.
  
         :returns: a variable name specifying the halo access depth \
                   if one exists, and None if not.
         :rtype: str
  
         '''
         return self._var_depth
  

References psyclone.dynamo0p3.HaloDepth._var_depth, and psyclone.dynamo0p3.HaloReadAccess._var_depth.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ __str__()

◆ annexed_only()

◆ literal_depth() [1/2]

◆ literal_depth() [2/2]

◆ max_depth()

◆ max_depth_m1()

◆ psyir_expression()

◆ set_by_value()

◆ var_depth()

◆ str()