psyclone.gocean1p0.GO1p0Descriptor Class Reference

Inheritance diagram for psyclone.gocean1p0.GO1p0Descriptor:

Collaboration diagram for psyclone.gocean1p0.GO1p0Descriptor:

Public Member Functions
def	__init__ (self, kernel_name, kernel_arg, metadata_index)
def	__str__ (self)
def	grid_prop (self)
Public Member Functions inherited from psyclone.parse.kernel.Descriptor
def	__init__ (self, access, space, metadata_index, stencil=None, mesh=None, argument_type=None)
def	access (self)
def	function_space (self)
def	metadata_index (self)
def	stencil (self)
def	mesh (self)
def	argument_type (self)
def	__repr__ (self)

Detailed Description

 Description of a GOcean 1.0 kernel argument, as obtained by
parsing the kernel metadata.

:param str kernel_name: the name of the kernel metadata type \
                        that contains this metadata.
:param kernel_arg: the relevant part of the parser's AST.
:type kernel_arg: :py:class:`psyclone.expression.FunctionVar`
:param int metadata_index: the postion of this argument in the list of \
                           arguments specified in the metadata.

:raises ParseError: if a kernel argument has an invalid grid-point type.
:raises ParseError: for an unrecognised grid property.
:raises ParseError: for an invalid number of arguments.
:raises ParseError: for an invalid access argument.

Definition at line 1938 of file gocean1p0.py.

Member Function Documentation

grid_prop()

def psyclone.gocean1p0.GO1p0Descriptor.grid_prop

(

self

)

:returns: the name of the grid-property that this argument is to \
          supply to the kernel.
:rtype: str

Definition at line 2031 of file gocean1p0.py.

    def grid_prop(self):
        '''
        :returns: the name of the grid-property that this argument is to \
                  supply to the kernel.
        :rtype: str
 
        '''
        return self._grid_prop
 
 

References psyclone.gocean1p0.GO1p0Descriptor._grid_prop.

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/gocean1p0.py