Inheritance diagram for psyclone.gocean1p0.GOKernelGridArgument:

Collaboration diagram for psyclone.gocean1p0.GOKernelGridArgument:

Public Member Functions
def	__init__ (self, arg, kernel_call)

def	name (self)

def	psyir_expression (self)

def	dereference (self, fld_name)

def	argument_type (self)

def	intrinsic_type (self)

def	is_scalar (self)

def	text (self)

def	forward_dependence (self)

def	backward_dependence (self)

Public Member Functions inherited from psyclone.psyGen.Argument
def	__init__ (self, call, arg_info, access)

def	infer_datatype (self)

def	__str__ (self)

def	form (self)

def	is_literal (self)

def	access (self)

def	access (self, value)

def	precision (self)

def	data_type (self)

def	module_name (self)

def	call (self)

def	call (self, value)

def	forward_write_dependencies (self, ignore_halos=False)

def	backward_write_dependencies (self, ignore_halos=False)

def	forward_read_dependencies (self)

Detailed Description

Describes arguments that supply grid properties to a kernel.
These arguments are provided by the PSy layer rather than in
the Algorithm layer.

:param arg: the meta-data entry describing the required grid property.
:type arg: :py:class:`psyclone.gocean1p0.GO1p0Descriptor`
:param kernel_call: the kernel call node that this Argument belongs to.
:type kernel_call: :py:class:`psyclone.gocean1p0.GOKern`

:raises GenerationError: if the grid property is not recognised.

Definition at line 1562 of file gocean1p0.py.

Member Function Documentation

◆ argument_type()

def psyclone.gocean1p0.GOKernelGridArgument.argument_type ( self )

 The type of this argument. We have this for compatibility with
    GOKernelArgument objects since, for this class, it will always be
    "grid_property".

Reimplemented from psyclone.psyGen.Argument.

Definition at line 1644 of file gocean1p0.py.

     def argument_type(self):
         ''' The type of this argument. We have this for compatibility with
             GOKernelArgument objects since, for this class, it will always be
             "grid_property". '''
         return self._argument_type
  

References psyclone.domain.lfric.lfric_arg_descriptor.LFRicArgDescriptor._argument_type, psyclone.dynamo0p3.DynKernelArgument._argument_type, psyclone.gocean1p0.GOKernelGridArgument._argument_type, psyclone.gocean1p0.GO1p0Descriptor._argument_type, and psyclone.parse.kernel.Descriptor._argument_type.

Here is the caller graph for this function:

◆ backward_dependence()

def psyclone.gocean1p0.GOKernelGridArgument.backward_dependence ( self )

A grid-property argument is read-only and supplied by the
PSy layer so has no dependencies

:returns: None to indicate no dependencies
:rtype: NoneType

Reimplemented from psyclone.psyGen.Argument.

Definition at line 1688 of file gocean1p0.py.

     def backward_dependence(self):
         '''
         A grid-property argument is read-only and supplied by the
         PSy layer so has no dependencies
  
         :returns: None to indicate no dependencies
         :rtype: NoneType
         '''
         return None
  
  

Here is the caller graph for this function:

◆ dereference()

def psyclone.gocean1p0.GOKernelGridArgument.dereference	(	self,
		fld_name
	)

Returns a Fortran string to dereference a grid property of the
specified field. It queries the current config file settings for
getting the proper dereference string, which is a format string
where {0} represents the field name.

:param str fld_name: The name of the field which is used to \
    dereference a grid property.

:returns: the dereference string required to access a grid property
    in a dl_esm field (e.g. "subdomain%internal%xstart"). The name
    must contains a "{0}" which is replaced by the field name.
:rtype: str

Definition at line 1626 of file gocean1p0.py.

     def dereference(self, fld_name):
         '''Returns a Fortran string to dereference a grid property of the
         specified field. It queries the current config file settings for
         getting the proper dereference string, which is a format string
         where {0} represents the field name.
  
         :param str fld_name: The name of the field which is used to \
             dereference a grid property.
  
         :returns: the dereference string required to access a grid property
             in a dl_esm field (e.g. "subdomain%internal%xstart"). The name
             must contains a "{0}" which is replaced by the field name.
         :rtype: str'''
         api_config = Config.get().api_conf("gocean1.0")
         deref_name = api_config.grid_properties[self._property_name].fortran
         return deref_name.format(fld_name)
  

References psyclone.gocean1p0.GOKernelGridArgument._property_name.

Here is the caller graph for this function:

◆ forward_dependence()

def psyclone.gocean1p0.GOKernelGridArgument.forward_dependence ( self )

A grid-property argument is read-only and supplied by the
PSy layer so has no dependencies

:returns: None to indicate no dependencies
:rtype: NoneType

Reimplemented from psyclone.psyGen.Argument.

Definition at line 1678 of file gocean1p0.py.

     def forward_dependence(self):
         '''
         A grid-property argument is read-only and supplied by the
         PSy layer so has no dependencies
  
         :returns: None to indicate no dependencies
         :rtype: NoneType
         '''
         return None
  

Here is the caller graph for this function:

◆ intrinsic_type()

def psyclone.gocean1p0.GOKernelGridArgument.intrinsic_type ( self )

:returns: the intrinsic_type of this argument.
:rtype: str

Reimplemented from psyclone.psyGen.Argument.

Definition at line 1651 of file gocean1p0.py.

     def intrinsic_type(self):
         '''
         :returns: the intrinsic_type of this argument.
         :rtype: str
  
         '''
         api_config = Config.get().api_conf("gocean1.0")
         return api_config.grid_properties[self._property_name].intrinsic_type
  

References psyclone.gocean1p0.GOKernelGridArgument._property_name.

Here is the caller graph for this function:

◆ is_scalar()

def psyclone.gocean1p0.GOKernelGridArgument.is_scalar ( self )

:returns: if this variable is a scalar variable or not.
:rtype: bool

Definition at line 1661 of file gocean1p0.py.

     def is_scalar(self):
         '''
         :returns: if this variable is a scalar variable or not.
         :rtype: bool
         '''
         # The constructor guarantees that _property_name is a valid key!
         api_config = Config.get().api_conf("gocean1.0")
         return api_config.grid_properties[self._property_name].type \
             == "scalar"
  

References psyclone.gocean1p0.GOKernelGridArgument._property_name.

Here is the caller graph for this function:

◆ name()

def psyclone.gocean1p0.GOKernelGridArgument.name ( self )

 Returns the Fortran name of the grid property, which is used
in error messages etc.

Reimplemented from psyclone.psyGen.Argument.

Definition at line 1604 of file gocean1p0.py.

     def name(self):
         ''' Returns the Fortran name of the grid property, which is used
         in error messages etc.'''
         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:

◆ psyir_expression()

def psyclone.gocean1p0.GOKernelGridArgument.psyir_expression ( self )

:returns: the PSyIR expression represented by this Argument.
:rtype: :py:class:`psyclone.psyir.nodes.Node`

Reimplemented from psyclone.psyGen.Argument.

Definition at line 1609 of file gocean1p0.py.

     def psyir_expression(self):
         '''
         :returns: the PSyIR expression represented by this Argument.
         :rtype: :py:class:`psyclone.psyir.nodes.Node`
  
         '''
         # Find field from which to access grid properties
         base_field = self._call.arguments.find_grid_access().name
         tag = "AlgArgs_" + base_field
         symbol = self._call.scope.symbol_table.find_or_create_tag(tag)
  
         # Get aggregate grid type accessors without the base name
         access = self.dereference(base_field).split('%')[1:]
  
         # Construct the PSyIR reference
         return StructureReference.create(symbol, access)
  

References psyclone.f2pygen.CallGen._call, psyclone.gocean1p0.GOKernelGridArgument._call, psyclone.psyGen.DataAccess._call, psyclone.psyGen.Argument._call, and psyclone.gocean1p0.GOKernelGridArgument.dereference().

Here is the call graph for this function:

◆ text()

def psyclone.gocean1p0.GOKernelGridArgument.text ( self )

 The raw text used to pass data from the algorithm layer
    for this argument. Grid properties are not passed from the
    algorithm layer so None is returned.

Reimplemented from psyclone.psyGen.Argument.

Definition at line 1672 of file gocean1p0.py.

     def text(self):
         ''' The raw text used to pass data from the algorithm layer
             for this argument. Grid properties are not passed from the
             algorithm layer so None is returned.'''
         return None
  

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ argument_type()

◆ backward_dependence()

◆ dereference()

◆ forward_dependence()

◆ intrinsic_type()

◆ is_scalar()

◆ name()

◆ psyir_expression()

◆ text()