psyclone.dynamo0p3.DynProxies Class Reference

Inheritance diagram for psyclone.dynamo0p3.DynProxies:

Collaboration diagram for psyclone.dynamo0p3.DynProxies:

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)

Detailed Description

Handles all proxy-related declarations and initialisation. Unlike other
sub-classes of LFRicCollection, we do not have to handle Kernel-stub
generation since Kernels know nothing about proxies.

An instance of this class is instantiated for each Invoke before the
PSy Layer is constructed. For each unique field or operator argument to
a kernel in the Invoke it:

  * Creates a DataSymbol for the corresponding proxy;
  * Creates a DataSymbol for the pointer to the data array accessed via
    the proxy. If the argument is a field vector then a DataSymbol is
    created for each component of the vector;
  * Tags that DataSymbol so that the correct symbol can always be looked
    up, irrespective of any name clashes;

Note that since the Fortran standard forbids (Note 12.34 in the
Fortran2008 standard) aliasing of effective arguments that are written to,
the set of unique kernel arguments must refer to unique memory locations
or to those that are read only.

Definition at line 1303 of file dynamo0p3.py.

Member Function Documentation

initialise()

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

Insert code into the PSy layer to initialise all necessary proxies.

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

:raises InternalError: if a kernel argument of an unrecognised type
    is encountered.

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

Definition at line 1547 of file dynamo0p3.py.

    def initialise(self, parent):
        '''
        Insert code into the PSy layer to initialise all necessary proxies.
 
        :param parent: node in the f2pygen AST representing the PSy-layer
                       routine.
        :type parent: :py:class:`psyclone.f2pygen.SubroutineGen`
 
        :raises InternalError: if a kernel argument of an unrecognised type
            is encountered.
 
        '''
        parent.add(CommentGen(parent, ""))
        parent.add(CommentGen(parent,
                              " Initialise field and/or operator proxies"))
        parent.add(CommentGen(parent, ""))
        for arg in self._invoke.psy_unique_vars:
            # We don't have proxies for scalars
            if arg.is_scalar:
                continue
 
            const = LFRicConstants()
            suffix = const.ARG_TYPE_SUFFIX_MAPPING[arg.argument_type]
 
            if arg.vector_size > 1:
                # the range function below returns values from
                # 1 to the vector size which is what we
                # require in our Fortran code
                for idx in range(1, arg.vector_size+1):
                    parent.add(
                        AssignGen(parent,
                                  lhs=arg.proxy_name+"("+str(idx)+")",
                                  rhs=arg.name+"("+str(idx)+")%get_proxy()"))
                    name = self._symbol_table.lookup_with_tag(
                        f"{arg.name}_{idx}:{suffix}").name
                    parent.add(
                        AssignGen(parent,
                                  lhs=name,
                                  rhs=f"{arg.proxy_name}({idx})%data",
                                  pointer=True))
            else:
                parent.add(AssignGen(parent, lhs=arg.proxy_name,
                                     rhs=arg.name+"%get_proxy()"))
                if arg.is_field:
                    name = self._symbol_table.lookup_with_tag(
                        f"{arg.name}:{suffix}").name
                    parent.add(
                        AssignGen(parent,
                                  lhs=name,
                                  rhs=f"{arg.proxy_name}%data",
                                  pointer=True))
                elif arg.is_operator:
                    if arg.argument_type == "gh_columnwise_operator":
                        # CMA operator arguments are handled in DynCMAOperators
                        pass
                    elif arg.argument_type == "gh_operator":
                        name = self._symbol_table.lookup_with_tag(
                            f"{arg.name}:{suffix}").name
                        parent.add(
                            AssignGen(parent,
                                      lhs=name,
                                      rhs=f"{arg.proxy_name}%local_stencil",
                                      pointer=True))
                    else:
                        raise InternalError(
                            f"Kernel argument '{arg.name}' is a recognised "
                            f"operator but its type ('{arg.argument_type}') is"
                            f" not supported by DynProxies.initialise()")
                else:
                    raise InternalError(
                        f"Kernel argument '{arg.name}' of type "
                        f"'{arg.argument_type}' not "
                        f"handled in DynProxies.initialise()")
 
 

References psyclone.domain.lfric.lfric_collection.LFRicCollection._invoke, psyclone.nemo.NemoInvokeSchedule._invoke, psyclone.psyGen.InvokeSchedule._invoke, 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, and psyclone.psyir.nodes.scoping_node.ScopingNode._symbol_table.

---

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