psyclone.dynamo0p3.DynFunctionSpaces Class Reference

Inheritance diagram for psyclone.dynamo0p3.DynFunctionSpaces:

Collaboration diagram for psyclone.dynamo0p3.DynFunctionSpaces:

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 the declaration and initialisation of all function-space-related
quantities required by an Invoke.

:param invoke: the Invoke or Kernel object.

Definition at line 1182 of file dynamo0p3.py.

Member Function Documentation

initialise()

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

Create the code that initialises function-space quantities.

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

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

Definition at line 1255 of file dynamo0p3.py.

    def initialise(self, parent):
        '''
        Create the code that initialises function-space quantities.
 
        :param parent: the node in the f2pygen AST representing the PSy-layer \
                       routine.
        :type parent: :py:class:`psyclone.f2pygen.SubroutineGen`
 
        '''
        # Loop over all unique function spaces used by the kernels in
        # the invoke
        for function_space in self._function_spaces:
            # Initialise information associated with this function space.
            # If we have 1+ kernels that operate on cell-columns then we
            # will need ndf and undf. If we don't then we only need undf
            # (for the upper bound of the loop over dofs) if we're not
            # doing DM.
            if not (self._dofs_only and Config.get().distributed_memory):
                parent.add(CommentGen(parent, ""))
                parent.add(CommentGen(parent,
                                      " Initialise number of DoFs for " +
                                      function_space.mangled_name))
                parent.add(CommentGen(parent, ""))
 
            # Find argument proxy name used to dereference the argument
            arg = self._invoke.arg_for_funcspace(function_space)
            name = arg.proxy_name_indexed
            # Initialise ndf for this function space.
            if not self._dofs_only:
                ndf_name = function_space.ndf_name
                parent.add(AssignGen(parent, lhs=ndf_name,
                                     rhs=name +
                                     "%" + arg.ref_name(function_space) +
                                     "%get_ndf()"))
            # If there is a field on this space then initialise undf
            # for this function space. However, if the invoke contains
            # only kernels that operate on dofs and distributed
            # memory is enabled then the number of dofs is obtained
            # from the field proxy and undf is not required.
            if not (self._dofs_only and Config.get().distributed_memory):
                if self._invoke.field_on_space(function_space):
                    undf_name = function_space.undf_name
                    parent.add(AssignGen(parent, lhs=undf_name,
                                         rhs=name + "%" +
                                         arg.ref_name(function_space) +
                                         "%get_undf()"))
 
 

References psyclone.domain.lfric.lfric_collection.LFRicCollection._dofs_only, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._function_spaces, psyclone.dynamo0p3.DynFunctionSpaces._function_spaces, psyclone.dynamo0p3.DynKernelArgument._function_spaces, psyclone.domain.lfric.lfric_collection.LFRicCollection._invoke, psyclone.nemo.NemoInvokeSchedule._invoke, and psyclone.psyGen.InvokeSchedule._invoke.

---

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