psyclone.dynamo0p3.FSDescriptors Class Reference

Public Member Functions
def	__init__ (self, descriptors)
def	exists (self, fspace)
def	get_descriptor (self, fspace)
def	descriptors (self)

Detailed Description

 Contains a collection of FSDescriptor objects and methods
that provide information across these objects. We have one
FSDescriptor for each meta-funcs entry in the kernel
metadata.
# TODO #274 this should actually be named something like
BasisFuncDescriptors as it holds information describing the
basis/diff-basis functions required by a kernel.

:param descriptors: list of objects describing the basis/diff-basis \
                    functions required by a kernel, as obtained from \
                    metadata.
:type descriptors: list of :py:class:`psyclone.DynFuncDescriptor03`.

Definition at line 4920 of file dynamo0p3.py.

Member Function Documentation

descriptors()

def psyclone.dynamo0p3.FSDescriptors.descriptors

(

self

)

:return: the list of Descriptors, one for each of the meta-funcs
         entries in the kernel metadata.
:rtype: List of :py:class:`psyclone.dynamo0p3.FSDescriptor`

Definition at line 4963 of file dynamo0p3.py.

    def descriptors(self):
        '''
        :return: the list of Descriptors, one for each of the meta-funcs
                 entries in the kernel metadata.
        :rtype: List of :py:class:`psyclone.dynamo0p3.FSDescriptor`
        '''
        return self._descriptors
 
 

References psyclone.dynamo0p3.FSDescriptors._descriptors.

exists()

def psyclone.dynamo0p3.FSDescriptors.exists	(		self,
			fspace
	)

 Return True if a descriptor with the specified function
space exists, otherwise return False. 

Definition at line 4941 of file dynamo0p3.py.

    def exists(self, fspace):
        ''' Return True if a descriptor with the specified function
        space exists, otherwise return False. '''
        for descriptor in self._descriptors:
            # FS descriptors hold information taken from the kernel
            # metadata and therefore it is the original name of
            # the supplied function space that we must look at
            if descriptor.fs_name == fspace.orig_name:
                return True
        return False
 

References psyclone.dynamo0p3.FSDescriptors._descriptors.

get_descriptor()

def psyclone.dynamo0p3.FSDescriptors.get_descriptor	(		self,
			fspace
	)

 Return the descriptor with the specified function space
name. If it does not exist raise an error.

Definition at line 4952 of file dynamo0p3.py.

    def get_descriptor(self, fspace):
        ''' Return the descriptor with the specified function space
        name. If it does not exist raise an error.'''
        for descriptor in self._descriptors:
            if descriptor.fs_name == fspace.orig_name:
                return descriptor
        raise GenerationError(
            f"FSDescriptors:get_descriptor: there is no descriptor for "
            f"function space {fspace.orig_name}")
 

References psyclone.dynamo0p3.FSDescriptors._descriptors.

---

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