psyclone.dynamo0p3.FSDescriptor Class Reference

Public Member Functions
def	__init__ (self, descriptor)
def	requires_basis (self)
def	requires_diff_basis (self)
def	fs_name (self)

Detailed Description

 Provides information about a particular function space used by
a meta-funcs entry in the kernel metadata. 

Definition at line 4894 of file dynamo0p3.py.

Member Function Documentation

fs_name()

def psyclone.dynamo0p3.FSDescriptor.fs_name

(

self

)

 Returns the raw metadata value of this function space. 

Definition at line 4915 of file dynamo0p3.py.

    def fs_name(self):
        ''' Returns the raw metadata value of this function space. '''
        return self._descriptor.function_space_name
 
 

References psyclone.dynamo0p3.FSDescriptor._descriptor.

requires_basis()

def psyclone.dynamo0p3.FSDescriptor.requires_basis

(

self

)

 Returns True if a basis function is associated with this
function space, otherwise it returns False. 

Definition at line 4902 of file dynamo0p3.py.

    def requires_basis(self):
        ''' Returns True if a basis function is associated with this
        function space, otherwise it returns False. '''
        return "gh_basis" in self._descriptor.operator_names
 

References psyclone.dynamo0p3.FSDescriptor._descriptor.

requires_diff_basis()

def psyclone.dynamo0p3.FSDescriptor.requires_diff_basis

(

self

)

 Returns True if a differential basis function is
associated with this function space, otherwise it returns
False. 

Definition at line 4908 of file dynamo0p3.py.

    def requires_diff_basis(self):
        ''' Returns True if a differential basis function is
        associated with this function space, otherwise it returns
        False. '''
        return "gh_diff_basis" in self._descriptor.operator_names
 

References psyclone.dynamo0p3.FSDescriptor._descriptor.

---

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