psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg Class Reference

Public Member Functions
def	__init__ (self, meta_arg, parent)
def	fortran_string (self)
def	access (self)
def	access (self, value)
def	name (self)
def	name (self, value)

Public Attributes
	access
	name

Detailed Description

Internal class to capture Kernel metadata argument information for
a grid property.

:param meta_arg: an fparser2 tree representation of the metadata.
:type meta_arg: :py:class:`fparser.two.Fortran2003.Part_Ref`
:param parent: a KernelMetadataSymbol instance that captures \
    other parts of the metadata and references this instance.
:type parent: :py:class`psyclone.psyir.common.kernel. \
    KernelMetadataSymbol`

:raises ParseError: if the metadata does not contain two \
    arguments.

Definition at line 547 of file psyir.py.

Member Function Documentation

access() [1/2]

def psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg.access

(

self

)

:returns: the value of the access descriptor. This \
    specifies how the grid property is accessed (read, write, \
    readwrite).
:rtype: str

Definition at line 605 of file psyir.py.

        def access(self):
            '''
            :returns: the value of the access descriptor. This \
                specifies how the grid property is accessed (read, write, \
                readwrite).
            :rtype: str
            '''
            return self._access
 

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.ScalarArg._access, psyclone.domain.lfric.kernel.common_meta_arg_metadata.CommonMetaArgMetadata._access, psyclone.parse.kernel.Descriptor._access, psyclone.psyGen.Argument._access, and psyclone.psyir.symbols.interfaces.ArgumentInterface._access.

Here is the caller graph for this function:

access() [2/2]

def psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg.access	(		self,
			value
	)

:param str value: set the access descriptor for this grid \
    property to the specified value.

Definition at line 615 of file psyir.py.

        def access(self, value):
            '''
            :param str value: set the access descriptor for this grid \
                property to the specified value.
            '''
            self._validate_access(value)
            self._access = value
 

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.ScalarArg._access, psyclone.domain.lfric.kernel.common_meta_arg_metadata.CommonMetaArgMetadata._access, psyclone.parse.kernel.Descriptor._access, psyclone.psyGen.Argument._access, psyclone.psyir.symbols.interfaces.ArgumentInterface._access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._validate_access(), psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._validate_access(), and psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.ScalarArg._validate_access().

Here is the call graph for this function:

Here is the caller graph for this function:

fortran_string()

def psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg.fortran_string

(

self

)

:returns: the metadata represented by this class as a \
    Fortran string.
:rtype: str

Definition at line 580 of file psyir.py.

        def fortran_string(self):
            '''
            :returns: the metadata represented by this class as a \
                Fortran string.
            :rtype: str
            '''
            return f"go_arg({self.access}, {self.name})"
 

Here is the caller graph for this function:

name() [1/2]

def psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg.name

(

self

)

:returns: the grid property name as specified by the metadata.
:rtype: str

Definition at line 643 of file psyir.py.

        def name(self):
            '''
            :returns: the grid property name as specified by the metadata.
            :rtype: str
            '''
            return self._name
 

References psyclone.domain.common.algorithm.psyir.AlgorithmInvokeCall._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._name, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._name, psyclone.dynamo0p3.DynFuncDescriptor03._name, psyclone.expression.NamedArg._name, psyclone.gocean1p0.GOKernelGridArgument._name, psyclone.gocean1p0.GOStencil._name, psyclone.nemo.NemoInvoke._name, psyclone.nemo.NemoPSy._name, psyclone.parse.algorithm.FileInfo._name, psyclone.parse.algorithm.InvokeCall._name, psyclone.parse.kernel.KernelProcedure._name, psyclone.parse.kernel.KernelType._name, psyclone.parse.module_info.ModuleInfo._name, psyclone.psyGen.PSy._name, psyclone.psyGen.Invoke._name, psyclone.psyGen.Kern._name, psyclone.psyGen.Argument._name, psyclone.psyir.nodes.container.Container._name, psyclone.psyir.nodes.routine.Routine._name, and psyclone.psyir.symbols.symbol.Symbol._name.

Here is the caller graph for this function:

name() [2/2]

def psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg.name	(		self,
			value
	)

:param str value: set the grid property name to the \
    specified value.

Definition at line 651 of file psyir.py.

        def name(self, value):
            '''
            :param str value: set the grid property name to the \
                specified value.
            '''
            self._validate_name(value)
            self._name = value
 
    class FieldArg():

References psyclone.domain.common.algorithm.psyir.AlgorithmInvokeCall._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._name, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._name, psyclone.dynamo0p3.DynFuncDescriptor03._name, psyclone.expression.NamedArg._name, psyclone.gocean1p0.GOKernelGridArgument._name, psyclone.gocean1p0.GOStencil._name, psyclone.nemo.NemoInvoke._name, psyclone.nemo.NemoPSy._name, psyclone.parse.algorithm.FileInfo._name, psyclone.parse.algorithm.InvokeCall._name, psyclone.parse.kernel.KernelProcedure._name, psyclone.parse.kernel.KernelType._name, psyclone.parse.module_info.ModuleInfo._name, psyclone.psyGen.PSy._name, psyclone.psyGen.Invoke._name, psyclone.psyGen.Kern._name, psyclone.psyGen.Argument._name, psyclone.psyir.nodes.container.Container._name, psyclone.psyir.nodes.routine.Routine._name, psyclone.psyir.symbols.symbol.Symbol._name, and psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._validate_name().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/domain/gocean/kernel/psyir.py