psyclone.psyGen.Arguments Class Reference

Inheritance diagram for psyclone.psyGen.Arguments:

Public Member Functions
def	__init__ (self, parent_call)
def	psyir_expressions (self)
def	names (self)
def	args (self)
def	iteration_space_arg (self)
def	acc_args (self)
def	scalars (self)
def	append (self, name, argument_type)

Detailed Description

Arguments abstract base class.

:param parent_call: kernel call with which the arguments are associated.
:type parent_call: sub-class of :py:class:`psyclone.psyGen.Kern`

Definition at line 1887 of file psyGen.py.

Member Function Documentation

acc_args()

def psyclone.psyGen.Arguments.acc_args

(

self

)

:returns: the list of quantities that must be available on an \
          OpenACC device before the associated kernel can be launched
:rtype: list of str

Reimplemented in psyclone.gocean1p0.GOKernelArguments, and psyclone.dynamo0p3.DynKernelArguments.

Definition at line 1944 of file psyGen.py.

    def acc_args(self):
        '''
        :returns: the list of quantities that must be available on an \
                  OpenACC device before the associated kernel can be launched
        :rtype: list of str
        '''
        raise NotImplementedError(
            "Arguments.acc_args must be implemented in sub-class")
 

append()

def psyclone.psyGen.Arguments.append	(		self,
			name,
			argument_type
	)

 Abstract method to append KernelArguments to the Argument
list.

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

Reimplemented in psyclone.gocean1p0.GOKernelArguments.

Definition at line 1962 of file psyGen.py.

    def append(self, name, argument_type):
        ''' Abstract method to append KernelArguments to the Argument
        list.
 
        :param str name: name of the appended argument.
        :param str argument_type: type of the appended argument.
        '''
        raise NotImplementedError(
            "Arguments.append must be implemented in sub-class")
 
 

Here is the caller graph for this function:

iteration_space_arg()

def psyclone.psyGen.Arguments.iteration_space_arg

(

self

)

Returns an argument that can be iterated over, i.e. modified
(has WRITE, READWRITE or INC access), but not the result of
a reduction operation.

:returns: a Fortran argument name
:rtype: string
:raises GenerationError: if none such argument is found.

Reimplemented in psyclone.dynamo0p3.DynKernelArguments.

Definition at line 1924 of file psyGen.py.

    def iteration_space_arg(self):
        '''
        Returns an argument that can be iterated over, i.e. modified
        (has WRITE, READWRITE or INC access), but not the result of
        a reduction operation.
 
        :returns: a Fortran argument name
        :rtype: string
        :raises GenerationError: if none such argument is found.
 
        '''
        for arg in self._args:
            if arg.access in AccessType.all_write_accesses() and \
                    arg.access not in AccessType.get_valid_reduction_modes():
                return arg
        raise GenerationError("psyGen:Arguments:iteration_space_arg Error, "
                              "we assume there is at least one writer, "
                              "reader/writer, or increment as an argument")
 

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

names()

def psyclone.psyGen.Arguments.names

(

self

)

:returns: the Algorithm-visible kernel arguments in a \
          comma-delimited string.
:rtype: str

Definition at line 1912 of file psyGen.py.

    def names(self):
        '''
        :returns: the Algorithm-visible kernel arguments in a \
                  comma-delimited string.
        :rtype: str
        '''
        return ",".join([arg.name for arg in self.args])
 

References psyclone.dynamo0p3.DynKernelArguments._args, psyclone.gocean1p0.GOKernelArguments._args, psyclone.parse.algorithm.ParsedCall._args, psyclone.psyGen.Arguments._args, 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:

psyir_expressions()

def psyclone.psyGen.Arguments.psyir_expressions

(

self

)

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

Reimplemented in psyclone.gocean1p0.GOKernelArguments, and psyclone.dynamo0p3.DynKernelArguments.

Definition at line 1904 of file psyGen.py.

    def psyir_expressions(self):
        '''
        :returns: the PSyIR expressions representing this Argument list.
        :rtype: list of :py:class:`psyclone.psyir.nodes.Node`
 
        '''
 

scalars()

def psyclone.psyGen.Arguments.scalars

(

self

)

:returns: the list of scalar quantities belonging to this object
:rtype: list of str

Reimplemented in psyclone.gocean1p0.GOKernelArguments, and psyclone.dynamo0p3.DynKernelArguments.

Definition at line 1954 of file psyGen.py.

    def scalars(self):
        '''
        :returns: the list of scalar quantities belonging to this object
        :rtype: list of str
        '''
        raise NotImplementedError(
            "Arguments.scalars must be implemented in sub-class")
 

---

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

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