Public Member Functions
def	__init__ (self, meta_arg, parent)

def	fortran_string (self)

def	access (self)

def	access (self, value)

def	grid_point_type (self)

def	grid_point_type (self, value)

def	form (self)

def	form (self, value)

def	stencil (self)

def	stencil (self, value_list)

Public Attributes
	access

	grid_point_type

	form

Detailed Description

Internal class to capture Kernel metadata information for
a field argument.

: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 three \
    arguments.

Definition at line 659 of file psyir.py.

Member Function Documentation

◆ access() [1/2]

def psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg.access ( self )

:returns: the access descriptor for this field \
    argument.
:rtype: str

Definition at line 737 of file psyir.py.

         def access(self):
             '''
             :returns: the access descriptor for this field \
                 argument.
             :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.FieldArg.access	(	self,
		value
	)

:param str value: set the access descriptor to the \
    specified value.

Definition at line 746 of file psyir.py.

         def access(self, value):
             '''
             :param str value: set the access descriptor 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:

◆ form() [1/2]

def psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg.form ( self )

:returns: the form of access for the field (pointwise, \
    stencil, ...).
:rtype: str

Definition at line 807 of file psyir.py.

         def form(self):
             '''
             :returns: the form of access for the field (pointwise, \
                 stencil, ...).
             :rtype: str
             '''
             return self._form
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._form, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.ScalarArg._form, psyclone.parse.algorithm.Arg._form, and psyclone.psyGen.Argument._form.

Here is the caller graph for this function:

◆ form() [2/2]

def psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg.form	(	self,
		value
	)

:param str value: set the form of access for the field to \
    the specified value.

Definition at line 816 of file psyir.py.

         def form(self, value):
             '''
             :param str value: set the form of access for the field to \
                 the specified value.
             '''
             self._validate_form(value)
             self._form = value
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._form, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.ScalarArg._form, psyclone.parse.algorithm.Arg._form, psyclone.psyGen.Argument._form, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._validate_form(), and psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.ScalarArg._validate_form().

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.FieldArg.fortran_string ( self )

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

Definition at line 708 of file psyir.py.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ grid_point_type() [1/2]

def psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg.grid_point_type ( self )

:returns: the value of the grid point type (go_ct, ...) \
    for the field argument.
:rtype: str

Definition at line 772 of file psyir.py.

         def grid_point_type(self):
             '''
             :returns: the value of the grid point type (go_ct, ...) \
                 for the field argument.
             :rtype: str
             '''
             return self._grid_point_type
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._grid_point_type.

◆ grid_point_type() [2/2]

def psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg.grid_point_type	(	self,
		value
	)

:param str value: set the field grid point type (ct, ...) \
    to the specified value.

Definition at line 781 of file psyir.py.

         def grid_point_type(self, value):
             '''
             :param str value: set the field grid point type (ct, ...) \
                 to the specified value.
             '''
             self._validate_grid_point_type(value)
             self._grid_point_type = value
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._grid_point_type, and psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._validate_grid_point_type().

Here is the call graph for this function:

◆ stencil() [1/2]

def psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg.stencil ( self )

:returns: the stencil value, or None if there is no stencil.
:rtype: Optional[List[str]]

Definition at line 876 of file psyir.py.

         def stencil(self):
             '''
             :returns: the stencil value, or None if there is no stencil.
             :rtype: Optional[List[str]]
             '''
             return self._stencil
  

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._stencil, psyclone.domain.lfric.arg_index_to_metadata_index.ArgIndexToMetadataIndex._stencil(), psyclone.domain.lfric.kernel.field_arg_metadata.FieldArgMetadata._stencil, psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._stencil, psyclone.domain.lfric.metadata_to_arguments_rules.MetadataToArgumentsRules._stencil(), psyclone.dynamo0p3.DynKernelArgument._stencil, psyclone.gocean1p0.GOStencil._stencil, and psyclone.parse.kernel.Descriptor._stencil.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stencil() [2/2]

def psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg.stencil	(	self,
		value_list
	)

:param value_list: set the new stencil value, encoded as \
    three strings, each of three digits (0 or 1), see the \
    `psyclone user guide <https://psyclone.readthedocs.io/en/\
stable/gocean1p0.html#argument-metadata-meta-args>` \
    for more details.
:type value_list: List[str]

Definition at line 884 of file psyir.py.

         def stencil(self, value_list):
             '''
             :param value_list: set the new stencil value, encoded as \
                 three strings, each of three digits (0 or 1), see the \
                 `psyclone user guide <https://psyclone.readthedocs.io/en/\
 stable/gocean1p0.html#argument-metadata-meta-args>` \
                 for more details.
             :type value_list: List[str]
  
             '''
             self._validate_stencil(value_list)
             self._stencil = value_list
             # If form was not GO_STENCIL, we need to set it to
             # GO_STENCIL now that we are providing a stencil value as
             # the format is GO_STENCIL(stencil) which is _form (
             # _stencil ).
             if self._form.upper() != "GO_STENCIL":
                 self._form = "GO_STENCIL"
  
     class ScalarArg():