psyclone.dynamo0p3.DynBoundaryConditions Class Reference

Inheritance diagram for psyclone.dynamo0p3.DynBoundaryConditions:

Collaboration diagram for psyclone.dynamo0p3.DynBoundaryConditions:

Public Member Functions
def	__init__ (self, node)
def	initialise (self, parent)
Public Member Functions inherited from psyclone.domain.lfric.lfric_collection.LFRicCollection
def	declarations (self, parent)

Static Public Attributes
	BoundaryDofs = namedtuple("BoundaryDofs", ["argument", "function_space"])

Detailed Description

Manages declarations and initialisation of quantities required by
kernels that need boundary condition information.

:param node: the Invoke or Kernel stub for which we are to handle \
             any boundary conditions.
:type node: :py:class:`psyclone.dynamo0p3.LFRicInvoke` or \
            :py:class:`psyclone.domain.lfric.LFRicKern`

:raises GenerationError: if a kernel named "enforce_bc_code" is found \
                         but does not have an argument on ANY_SPACE_1.
:raises GenerationError: if a kernel named "enforce_operator_bc_code" is \
                         found but does not have exactly one argument.

Definition at line 3526 of file dynamo0p3.py.

Member Function Documentation

initialise()

def psyclone.dynamo0p3.DynBoundaryConditions.initialise	(		self,
			parent
	)

Initialise any boundary-dofs arrays required by an Invoke.

:param parent: node in PSyIR to which to add declarations.
:type parent: :py:class:`psyclone.psyir.nodes.Node`

Reimplemented from psyclone.domain.lfric.lfric_collection.LFRicCollection.

Definition at line 3615 of file dynamo0p3.py.

    def initialise(self, parent):
        '''
        Initialise any boundary-dofs arrays required by an Invoke.
 
        :param parent: node in PSyIR to which to add declarations.
        :type parent: :py:class:`psyclone.psyir.nodes.Node`
 
        '''
        for dofs in self._boundary_dofs:
            name = "boundary_dofs_" + dofs.argument.name
            parent.add(AssignGen(
                parent, pointer=True, lhs=name,
                rhs="%".join([dofs.argument.proxy_name,
                              dofs.argument.ref_name(dofs.function_space),
                              "get_boundary_dofs()"])))
 
 

References psyclone.dynamo0p3.DynBoundaryConditions._boundary_dofs.

---

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