psyclone.dynamo0p3.DynCellIterators Class Reference

Inheritance diagram for psyclone.dynamo0p3.DynCellIterators:

Collaboration diagram for psyclone.dynamo0p3.DynCellIterators:

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

Detailed Description

Handles all entities required by kernels that operate on cell-columns.

:param kern_or_invoke: the Kernel or Invoke for which to manage cell \
                       iterators.
:type kern_or_invoke: :py:class:`psyclone.domain.lfric.LFRicKern` or \
                      :py:class:`psyclone.dynamo0p3.LFRicInvoke`

: raises GenerationError: if an Invoke has no field or operator arguments.

Definition at line 1622 of file dynamo0p3.py.

Member Function Documentation

initialise()

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

Look-up the number of vertical layers in the mesh in the PSy layer.

:param parent: the f2pygen node representing the PSy-layer routine.
:type parent: :py:class:`psyclone.f2pygen.SubroutineGen`

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

Definition at line 1688 of file dynamo0p3.py.

    def initialise(self, parent):
        '''
        Look-up the number of vertical layers in the mesh in the PSy layer.
 
        :param parent: the f2pygen node representing the PSy-layer routine.
        :type parent: :py:class:`psyclone.f2pygen.SubroutineGen`
 
        '''
        if not self._dofs_only:
            parent.add(CommentGen(parent, ""))
            parent.add(CommentGen(parent, " Initialise number of layers"))
            parent.add(CommentGen(parent, ""))
            parent.add(AssignGen(
                parent, lhs=self._nlayers_name,
                rhs=self._first_var.proxy_name_indexed + "%" +
                self._first_var.ref_name() + "%get_nlayers()"))
 
 

References psyclone.domain.lfric.lfric_collection.LFRicCollection._dofs_only, psyclone.dynamo0p3.DynCellIterators._first_var, psyclone.dynamo0p3.DynMeshes._first_var, and psyclone.dynamo0p3.DynCellIterators._nlayers_name.

---

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