psyclone.dynamo0p3.DynBasisFunctions Class Reference

Inheritance diagram for psyclone.dynamo0p3.DynBasisFunctions:

Collaboration diagram for psyclone.dynamo0p3.DynBasisFunctions:

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

Static Public Member Functions
def	basis_first_dim_name (function_space)
def	basis_first_dim_value (function_space)
def	diff_basis_first_dim_name (function_space)
def	diff_basis_first_dim_value (function_space)

Static Public Attributes
dictionary	qr_dim_vars
dictionary	qr_weight_vars

Detailed Description

 Holds all information on the basis and differential basis
functions required by an invoke or kernel call. This covers both those
required for quadrature and for evaluators.

:param node: either the schedule of an Invoke or a single Kernel object
             for which to extract information on all required
             basis/diff-basis functions.
:type node: :py:class:`psyclone.domain.lfric.LFRicInvokeSchedule` or
            :py:class:`psyclone.domain.lfric.LFRicKern`

:raises InternalError: if a call has an unrecognised evaluator shape.

Definition at line 2627 of file dynamo0p3.py.

Member Function Documentation

basis_first_dim_name()

def psyclone.dynamo0p3.DynBasisFunctions.basis_first_dim_name (   function_space )

static

Get the name of the variable holding the first dimension of a
basis function

:param function_space: the function space the basis function is for
:type function_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
:return: a Fortran variable name
:rtype: str

Definition at line 2712 of file dynamo0p3.py.

    def basis_first_dim_name(function_space):
        '''
        Get the name of the variable holding the first dimension of a
        basis function
 
        :param function_space: the function space the basis function is for
        :type function_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
        :return: a Fortran variable name
        :rtype: str
 
        '''
        return "dim_" + function_space.mangled_name
 

Here is the caller graph for this function:

basis_first_dim_value()

def psyclone.dynamo0p3.DynBasisFunctions.basis_first_dim_value (   function_space )

static

Get the size of the first dimension of a basis function.

:param function_space: the function space the basis function is for
:type function_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
:return: an integer length.
:rtype: string

:raises GenerationError: if an unsupported function space is supplied \
                         (e.g. ANY_SPACE_*, ANY_DISCONTINUOUS_SPACE_*)

Definition at line 2726 of file dynamo0p3.py.

    def basis_first_dim_value(function_space):
        '''
        Get the size of the first dimension of a basis function.
 
        :param function_space: the function space the basis function is for
        :type function_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
        :return: an integer length.
        :rtype: string
 
        :raises GenerationError: if an unsupported function space is supplied \
                                 (e.g. ANY_SPACE_*, ANY_DISCONTINUOUS_SPACE_*)
        '''
        if function_space.has_scalar_basis:
            first_dim = "1"
        elif function_space.has_vector_basis:
            first_dim = "3"
        else:
            # It is not possible to determine explicitly the first basis
            # function array dimension from the metadata for any_space or
            # any_discontinuous_space. This information needs to be passed
            # from the PSy layer to the kernels (see issue #461).
            const = LFRicConstants()
            raise GenerationError(
                f"Unsupported space for basis function, "
                f"expecting one of {const.VALID_FUNCTION_SPACES} but found "
                f"'{function_space.orig_name}'")
        return first_dim
 

Here is the caller graph for this function:

deallocate()

def psyclone.dynamo0p3.DynBasisFunctions.deallocate	(		self,
			parent
	)

Add code to deallocate all basis/diff-basis function arrays

:param parent: node in the f2pygen AST to which the deallocate \
               calls will be added.
:type parent: :py:class:`psyclone.f2pygen.SubroutineGen`

:raises InternalError: if an unrecognised type of basis function \
                       is encountered.

Definition at line 3485 of file dynamo0p3.py.

    def deallocate(self, parent):
        '''
        Add code to deallocate all basis/diff-basis function arrays
 
        :param parent: node in the f2pygen AST to which the deallocate \
                       calls will be added.
        :type parent: :py:class:`psyclone.f2pygen.SubroutineGen`
 
        :raises InternalError: if an unrecognised type of basis function \
                               is encountered.
        '''
        if self._basis_fns:
            # deallocate all allocated basis function arrays
            parent.add(CommentGen(parent, ""))
            parent.add(CommentGen(parent, " Deallocate basis arrays"))
            parent.add(CommentGen(parent, ""))
 
        func_space_var_names = set()
        for basis_fn in self._basis_fns:
            # add the basis array name to the list to use later
            if basis_fn["type"] == "basis":
                basis_name = "gh_basis"
            elif basis_fn["type"] == "diff-basis":
                basis_name = "gh_diff_basis"
            else:
                raise InternalError(
                    f"Unrecognised type of basis function: "
                    f"'{basis_fn['''type''']}'. Should be one of 'basis' or "
                    f"'diff-basis'.")
            for fspace in basis_fn["nodal_fspaces"]:
                op_name = basis_fn["fspace"].\
                    get_operator_name(basis_name,
                                      qr_var=basis_fn["qr_var"],
                                      on_space=fspace)
                func_space_var_names.add(op_name)
 
        if func_space_var_names:
            # add the required deallocate call
            parent.add(DeallocateGen(parent, sorted(func_space_var_names)))
 
 

References psyclone.dynamo0p3.DynBasisFunctions._basis_fns.

diff_basis_first_dim_name()

def psyclone.dynamo0p3.DynBasisFunctions.diff_basis_first_dim_name (   function_space )

static

Get the name of the variable holding the first dimension of a
differential basis function.

:param function_space: the function space the diff-basis function \
                       is for.
:type function_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
:return: a Fortran variable name.
:rtype: str

Definition at line 2755 of file dynamo0p3.py.

    def diff_basis_first_dim_name(function_space):
        '''
        Get the name of the variable holding the first dimension of a
        differential basis function.
 
        :param function_space: the function space the diff-basis function \
                               is for.
        :type function_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
        :return: a Fortran variable name.
        :rtype: str
 
        '''
        return "diff_dim_" + function_space.mangled_name
 

Here is the caller graph for this function:

diff_basis_first_dim_value()

def psyclone.dynamo0p3.DynBasisFunctions.diff_basis_first_dim_value (   function_space )

static

Get the size of the first dimension of an array for a
differential basis function.

:param function_space: the function space the diff-basis function \
                       is for.
:type function_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
:return: an integer length.
:rtype: str

:raises GenerationError: if an unsupported function space is \
                         supplied (e.g. ANY_SPACE_*, \
                         ANY_DISCONTINUOUS_SPACE_*)

Definition at line 2770 of file dynamo0p3.py.

    def diff_basis_first_dim_value(function_space):
        '''
        Get the size of the first dimension of an array for a
        differential basis function.
 
        :param function_space: the function space the diff-basis function \
                               is for.
        :type function_space: :py:class:`psyclone.domain.lfric.FunctionSpace`
        :return: an integer length.
        :rtype: str
 
        :raises GenerationError: if an unsupported function space is \
                                 supplied (e.g. ANY_SPACE_*, \
                                 ANY_DISCONTINUOUS_SPACE_*)
 
        '''
        if function_space.has_scalar_diff_basis:
            first_dim = "1"
        elif function_space.has_vector_diff_basis:
            first_dim = "3"
        else:
            # It is not possible to determine explicitly the first
            # differential basis function array dimension from the metadata
            # for any_space or any_discontinuous_space. This information
            # needs to be passed from the PSy layer to the kernels
            # (see issue #461).
            const = LFRicConstants()
            raise GenerationError(
                f"Unsupported space for differential basis function, "
                f"expecting one of {const.VALID_FUNCTION_SPACES} but found "
                f"'{function_space.orig_name}'")
        return first_dim
 

References psyclone.dynamo0p3.DynBasisFunctions._basis_fn_declns(), psyclone.dynamo0p3.DynBasisFunctions._basis_fns, psyclone.domain.lfric.lfric_kern.LFRicKern._eval_targets, psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata._eval_targets, psyclone.dynamo0p3.DynBasisFunctions._eval_targets, psyclone.dynamo0p3.DynBasisFunctions._qr_vars, 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.

Here is the call graph for this function:

Here is the caller graph for this function:

initialise()

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

Create the declarations and assignments required for the
basis-functions required by an invoke. These are added as children
of the supplied parent node in the AST.

:param parent: the node in the f2pygen AST that will be the
               parent of all of the declarations and assignments.
:type parent: :py:class:`psyclone.f2pygen.SubroutineGen`

:raises InternalError: if an invalid entry is encountered in the \
                       self._basis_fns list.

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

Definition at line 2973 of file dynamo0p3.py.

    def initialise(self, parent):
        '''
        Create the declarations and assignments required for the
        basis-functions required by an invoke. These are added as children
        of the supplied parent node in the AST.
 
        :param parent: the node in the f2pygen AST that will be the
                       parent of all of the declarations and assignments.
        :type parent: :py:class:`psyclone.f2pygen.SubroutineGen`
 
        :raises InternalError: if an invalid entry is encountered in the \
                               self._basis_fns list.
        '''
        # pylint: disable=too-many-branches, too-many-locals
        api_config = Config.get().api_conf("dynamo0.3")
        const = LFRicConstants()
        basis_declarations = []
 
        # We need BASIS and/or DIFF_BASIS if any kernel requires quadrature
        # or an evaluator
        if self._qr_vars or self._eval_targets:
            parent.add(
                UseGen(parent, name=const.
                       FUNCTION_SPACE_TYPE_MAP["function_space"]["module"],
                       only=True, funcnames=["BASIS", "DIFF_BASIS"]))
 
        if self._qr_vars:
            parent.add(CommentGen(parent, ""))
            parent.add(CommentGen(parent, " Look-up quadrature variables"))
            parent.add(CommentGen(parent, ""))
 
            # Look-up the module- and type-names from the QUADRATURE_TYPE_MAP
            for shp in self._qr_vars:
                quad_map = const.QUADRATURE_TYPE_MAP[shp]
                parent.add(UseGen(parent,
                                  name=quad_map["module"],
                                  only=True,
                                  funcnames=[quad_map["type"],
                                             quad_map["proxy_type"]]))
            self._initialise_xyz_qr(parent)
            self._initialise_xyoz_qr(parent)
            self._initialise_xoyoz_qr(parent)
            self._initialise_face_or_edge_qr(parent, "face")
            self._initialise_face_or_edge_qr(parent, "edge")
 
        if self._eval_targets:
            parent.add(CommentGen(parent, ""))
            parent.add(CommentGen(parent,
                                  " Initialise evaluator-related quantities "
                                  "for the target function spaces"))
            parent.add(CommentGen(parent, ""))
 
        for (fspace, arg) in self._eval_targets.values():
            # We need the list of nodes for each unique FS upon which we need
            # to evaluate basis/diff-basis functions
            nodes_name = "nodes_" + fspace.mangled_name
            parent.add(AssignGen(
                parent, lhs=nodes_name,
                rhs="%".join([arg.proxy_name_indexed, arg.ref_name(fspace),
                              "get_nodes()"]),
                pointer=True))
            my_kind = api_config.default_kind["real"]
            parent.add(DeclGen(parent, datatype="real",
                               kind=my_kind,
                               pointer=True,
                               entity_decls=[nodes_name+"(:,:) => null()"]))
            const_mod = const.UTILITIES_MOD_MAP["constants"]["module"]
            const_mod_uses = self._invoke.invokes.psy. \
                infrastructure_modules[const_mod]
            # Record that we will need to import the kind for a
            # pointer declaration (associated with a function
            # space) from the appropriate infrastructure module
            const_mod_uses.add(my_kind)
 
        if self._basis_fns:
            parent.add(CommentGen(parent, ""))
            parent.add(CommentGen(parent, " Allocate basis/diff-basis arrays"))
            parent.add(CommentGen(parent, ""))
 
        var_dim_list = []
        for basis_fn in self._basis_fns:
            # Get the extent of the first dimension of the basis array.
            if basis_fn['type'] == "basis":
                first_dim = self.basis_first_dim_name(basis_fn["fspace"])
                dim_space = "get_dim_space()"
            elif basis_fn['type'] == "diff-basis":
                first_dim = self.diff_basis_first_dim_name(
                    basis_fn["fspace"])
                dim_space = "get_dim_space_diff()"
            else:
                raise InternalError(
                    f"Unrecognised type of basis function: "
                    f"'{basis_fn['''type''']}'. Should be either 'basis' or "
                    f"'diff-basis'.")
 
            if first_dim not in var_dim_list:
                var_dim_list.append(first_dim)
                rhs = "%".join(
                    [basis_fn["arg"].proxy_name_indexed,
                     basis_fn["arg"].ref_name(basis_fn["fspace"]),
                     dim_space])
                parent.add(AssignGen(parent, lhs=first_dim, rhs=rhs))
 
        var_dims, basis_arrays = self._basis_fn_declns()
 
        if var_dims:
            # declare dim and diff_dim for all function spaces
            parent.add(DeclGen(parent, datatype="integer",
                               kind=api_config.default_kind["integer"],
                               entity_decls=var_dims))
 
        basis_declarations = []
        for basis in basis_arrays:
            parent.add(
                AllocateGen(parent,
                            basis+"("+", ".join(basis_arrays[basis])+")"))
            basis_declarations.append(
                basis+"("+",".join([":"]*len(basis_arrays[basis]))+")")
 
        # declare the basis function arrays
        if basis_declarations:
            my_kind = api_config.default_kind["real"]
            parent.add(DeclGen(parent, datatype="real", kind=my_kind,
                               allocatable=True,
                               entity_decls=basis_declarations))
            # Default kind (r_def) will always already exist due to
            # arrays associated with gh_shape, so there is no need to
            # declare it here.
 
        # Compute the values for any basis arrays
        self._compute_basis_fns(parent)
 

References psyclone.dynamo0p3.DynBasisFunctions._basis_fn_declns(), psyclone.dynamo0p3.DynBasisFunctions._basis_fns, psyclone.dynamo0p3.DynBasisFunctions._compute_basis_fns(), psyclone.domain.lfric.lfric_kern.LFRicKern._eval_targets, psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata._eval_targets, psyclone.dynamo0p3.DynBasisFunctions._eval_targets, psyclone.dynamo0p3.DynBasisFunctions._initialise_face_or_edge_qr(), psyclone.dynamo0p3.DynBasisFunctions._initialise_xoyoz_qr(), psyclone.dynamo0p3.DynBasisFunctions._initialise_xyoz_qr(), psyclone.dynamo0p3.DynBasisFunctions._initialise_xyz_qr(), psyclone.domain.lfric.lfric_collection.LFRicCollection._invoke, psyclone.nemo.NemoInvokeSchedule._invoke, psyclone.psyGen.InvokeSchedule._invoke, psyclone.domain.lfric.lfric_collection.LFRicCollection._kernel, psyclone.dynamo0p3.DynBasisFunctions._qr_vars, psyclone.dynamo0p3.DynBasisFunctions.basis_first_dim_name(), psyclone.dynamo0p3.DynBasisFunctions.basis_first_dim_value(), psyclone.dynamo0p3.DynBasisFunctions.diff_basis_first_dim_name(), and psyclone.dynamo0p3.DynBasisFunctions.diff_basis_first_dim_value().

Here is the call graph for this function:

Member Data Documentation

qr_dim_vars

dictionary psyclone.dynamo0p3.DynBasisFunctions.qr_dim_vars

static

Initial value:

=  {"xyoz": ["np_xy", "np_z"],
                   "edge": ["np_xyz", "nedges"],
                   "face": ["np_xyz", "nfaces"]}

Definition at line 2643 of file dynamo0p3.py.

qr_weight_vars

dictionary psyclone.dynamo0p3.DynBasisFunctions.qr_weight_vars

static

Initial value:

=  {"xyoz": ["weights_xy", "weights_z"],
                      "edge": ["weights_xyz"],
                      "face": ["weights_xyz"]}

Definition at line 2647 of file dynamo0p3.py.

---

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