psyclone.gocean1p0.GOKernelArguments Class Reference

Inheritance diagram for psyclone.gocean1p0.GOKernelArguments:

Collaboration diagram for psyclone.gocean1p0.GOKernelArguments:

Public Member Functions
def	__init__ (self, call, parent_call, check=True)
def	psyir_expressions (self)
def	find_grid_access (self)
def	dofs (self)
def	acc_args (self)
def	fields (self)
def	scalars (self)
def	append (self, name, argument_type)
Public Member Functions inherited from psyclone.psyGen.Arguments
def	__init__ (self, parent_call)
def	names (self)
def	args (self)
def	iteration_space_arg (self)

Detailed Description

Provides information about GOcean kernel-call arguments
collectively, as specified by the kernel argument metadata. This
class ensures that initialisation is performed correctly. It also
overrides the iteration_space_arg method to supply a
GOcean-specific dictionary for the mapping of argument-access
types.

:param call: the kernel meta-data for which to extract argument info.
:type call: :py:class:`psyclone.parse.KernelCall`
:param parent_call: the kernel-call object.
:type parent_call: :py:class:`psyclone.gocean1p0.GOKern`
:param bool check: whether to check for consistency between the \
    kernel metadata and the algorithm layer. Defaults to \
    True. Currently does nothing in this API.

Definition at line 1263 of file gocean1p0.py.

Member Function Documentation

acc_args()

def psyclone.gocean1p0.GOKernelArguments.acc_args

(

self

)

Provide the list of references (both objects and arrays) that must
be present on an OpenACC device before the kernel associated with
this Arguments object may be launched.

:returns: list of (Fortran) quantities
:rtype: list of str

Reimplemented from psyclone.psyGen.Arguments.

Definition at line 1345 of file gocean1p0.py.

    def acc_args(self):
        '''
        Provide the list of references (both objects and arrays) that must
        be present on an OpenACC device before the kernel associated with
        this Arguments object may be launched.
 
        :returns: list of (Fortran) quantities
        :rtype: list of str
        '''
        arg_list = []
 
        # First off, specify the field object which we will de-reference in
        # order to get any grid properties (if this kernel requires them).
        # We do this as some compilers do less optimisation if we get (read-
        # -only) grid properties from a field object that has read-write
        # access.
        grid_fld = self.find_grid_access()
        grid_ptr = grid_fld.name + "%grid"
        api_config = Config.get().api_conf("gocean1.0")
        # TODO: #676 go_grid_data is actually a field property
        data_fmt = api_config.grid_properties["go_grid_data"].fortran
        arg_list.extend([grid_fld.name, data_fmt.format(grid_fld.name)])
        for arg in self._args:
            if arg.argument_type == "scalar":
                arg_list.append(arg.name)
            elif arg.argument_type == "field" and arg != grid_fld:
                # The remote device will need the reference to the field
                # object *and* the reference to the array within that object.
                arg_list.extend([arg.name, data_fmt.format(arg.name)])
            elif arg.argument_type == "grid_property":
                if grid_ptr not in arg_list:
                    # This kernel needs a grid property and therefore the
                    # pointer to the grid object must be copied to the device.
                    arg_list.append(grid_ptr)
                arg_list.append(grid_ptr+"%"+arg.name)
        return arg_list
 

References psyclone.dynamo0p3.DynKernelArguments._args, psyclone.gocean1p0.GOKernelArguments._args, psyclone.parse.algorithm.ParsedCall._args, psyclone.psyGen.Arguments._args, and psyclone.gocean1p0.GOKernelArguments.find_grid_access().

Here is the call graph for this function:

append()

def psyclone.gocean1p0.GOKernelArguments.append	(		self,
			name,
			argument_type
	)

 Create and append a GOKernelArgument to the Argument list.

:param str name: name of the appended argument.
:param str argument_type: type of the appended argument.

:raises TypeError: if the given name is not a string.

Reimplemented from psyclone.psyGen.Arguments.

Definition at line 1407 of file gocean1p0.py.

    def append(self, name, argument_type):
        ''' Create and append a GOKernelArgument to the Argument list.
 
        :param str name: name of the appended argument.
        :param str argument_type: type of the appended argument.
 
        :raises TypeError: if the given name is not a string.
 
        '''
        if not isinstance(name, str):
            raise TypeError(
                f"The name parameter given to GOKernelArguments.append "
                f"method should be a string, but found "
                f"'{type(name).__name__}' instead.")
 
        # Create a descriptor with the given type. `len(self.args)` gives the
        # position in the argument list of the argument to which this
        # descriptor corresponds. (This argument is appended in the code
        # below.)
        descriptor = Descriptor(None, argument_type, len(self.args))
 
        # Create the argument and append it to the argument list
        arg = Arg("variable", name)
        argument = GOKernelArgument(descriptor, arg, self._parent_call)
        self.args.append(argument)
 
 

References psyclone.psyGen.Arguments._parent_call, psyclone.expression.FunctionVar.args, psyclone.f2pygen.SubroutineGen.args(), psyclone.parse.algorithm.ParsedCall.args(), psyclone.psyGen.GlobalSum.args(), psyclone.psyGen.HaloExchange.args(), psyclone.psyGen.Kern.args(), psyclone.psyGen.Arguments.args(), and psyclone.psyir.nodes.node.Node.args().

Here is the call graph for this function:

Here is the caller graph for this function:

dofs()

def psyclone.gocean1p0.GOKernelArguments.dofs

(

self

)

 Currently required for invoke base class although this makes no
    sense for GOcean. Need to refactor the Invoke base class and
    remove the need for this property (#279). 

Definition at line 1338 of file gocean1p0.py.

    def dofs(self):
        ''' Currently required for invoke base class although this makes no
            sense for GOcean. Need to refactor the Invoke base class and
            remove the need for this property (#279). '''
        return self._dofs
 

References psyclone.dynamo0p3.DynKernelArguments._dofs, psyclone.gocean1p0.GOKernelArguments._dofs, and psyclone.psyGen.Invoke._dofs.

fields()

def psyclone.gocean1p0.GOKernelArguments.fields

(

self

)

Provides the list of names of field objects that are required by
the kernel associated with this Arguments object.

:returns: List of names of (Fortran) field objects.
:rtype: list of str

Definition at line 1383 of file gocean1p0.py.

    def fields(self):
        '''
        Provides the list of names of field objects that are required by
        the kernel associated with this Arguments object.
 
        :returns: List of names of (Fortran) field objects.
        :rtype: list of str
        '''
        args = args_filter(self._args, arg_types=["field"])
        return [arg.name for arg in args]
 

References psyclone.dynamo0p3.DynKernelArguments._args, psyclone.gocean1p0.GOKernelArguments._args, psyclone.parse.algorithm.ParsedCall._args, and psyclone.psyGen.Arguments._args.

Here is the caller graph for this function:

find_grid_access()

def psyclone.gocean1p0.GOKernelArguments.find_grid_access

(

self

)

Determine the best kernel argument from which to get properties of
the grid. For this, an argument must be a field (i.e. not
a scalar) and must be supplied by the algorithm layer
(i.e. not a grid property). If possible it should also be
a field that is read-only as otherwise compilers can get
confused about data dependencies and refuse to SIMD
vectorise.
:returns: the argument object from which to get grid properties.
:rtype: :py:class:`psyclone.gocean1p0.GOKernelArgument` or None

Definition at line 1315 of file gocean1p0.py.

    def find_grid_access(self):
        '''
        Determine the best kernel argument from which to get properties of
        the grid. For this, an argument must be a field (i.e. not
        a scalar) and must be supplied by the algorithm layer
        (i.e. not a grid property). If possible it should also be
        a field that is read-only as otherwise compilers can get
        confused about data dependencies and refuse to SIMD
        vectorise.
        :returns: the argument object from which to get grid properties.
        :rtype: :py:class:`psyclone.gocean1p0.GOKernelArgument` or None
        '''
        for access in [AccessType.READ, AccessType.READWRITE,
                       AccessType.WRITE]:
            for arg in self._args:
                if arg.argument_type == "field" and arg.access == access:
                    return arg
        # We failed to find any kernel argument which could be used
        # to access the grid properties. This will only be a problem
        # if the kernel requires a grid-property argument.
        return None
 

References psyclone.dynamo0p3.DynKernelArguments._args, psyclone.gocean1p0.GOKernelArguments._args, psyclone.parse.algorithm.ParsedCall._args, and psyclone.psyGen.Arguments._args.

Here is the caller graph for this function:

psyir_expressions()

def psyclone.gocean1p0.GOKernelArguments.psyir_expressions

(

self

)

:returns: the PSyIR expressions representing this Argument list.
:rtype: list of :py:class:`psyclone.psyir.nodes.Node`

Reimplemented from psyclone.psyGen.Arguments.

Definition at line 1303 of file gocean1p0.py.

    def psyir_expressions(self):
        '''
        :returns: the PSyIR expressions representing this Argument list.
        :rtype: list of :py:class:`psyclone.psyir.nodes.Node`
 
        '''
        symtab = self._parent_call.scope.symbol_table
        symbol1 = symtab.lookup_with_tag("contiguous_kidx")
        symbol2 = symtab.lookup_with_tag("noncontiguous_kidx")
        return ([Reference(symbol1), Reference(symbol2)] +
                [arg.psyir_expression() for arg in self.args])
 

References psyclone.psyGen.Arguments._parent_call, psyclone.expression.FunctionVar.args, psyclone.f2pygen.SubroutineGen.args(), psyclone.parse.algorithm.ParsedCall.args(), psyclone.psyGen.GlobalSum.args(), psyclone.psyGen.HaloExchange.args(), psyclone.psyGen.Kern.args(), psyclone.psyGen.Arguments.args(), and psyclone.psyir.nodes.node.Node.args().

Here is the call graph for this function:

scalars()

def psyclone.gocean1p0.GOKernelArguments.scalars

(

self

)

Provides the list of names of scalar arguments required by the
kernel associated with this Arguments object. If there are none
then the returned list is empty.

:returns: A list of the names of scalar arguments in this object.
:rtype: list of str

Reimplemented from psyclone.psyGen.Arguments.

Definition at line 1395 of file gocean1p0.py.

    def scalars(self):
        '''
        Provides the list of names of scalar arguments required by the
        kernel associated with this Arguments object. If there are none
        then the returned list is empty.
 
        :returns: A list of the names of scalar arguments in this object.
        :rtype: list of str
        '''
        args = args_filter(self._args, arg_types=["scalar"])
        return [arg.name for arg in args]
 

References psyclone.dynamo0p3.DynKernelArguments._args, psyclone.gocean1p0.GOKernelArguments._args, psyclone.parse.algorithm.ParsedCall._args, and psyclone.psyGen.Arguments._args.

---

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