psyclone.parse.algorithm.InvokeCall Class Reference

Public Member Functions
def	__init__ (self, kcalls, name=None, invoke_name="invoke")
def	name (self)
def	kcalls (self)

Detailed Description

Keeps information about an individual invoke call.

:param kcalls: Information about the kernels specified in the \
invoke.
:type kcalls: list of \
:py:class:`psyclone.parse.algorithm.KernelCall` or \
:py:class:`psyclone.parse.algorithm.BuiltInCall`
:param str name: An optional name to call the transformed invoke \
call. This defaults to None.
:param str invoke_name: the name that is used to indicate an invoke \
call. This defaults to 'invoke'.

Definition at line 894 of file algorithm.py.

Member Function Documentation

kcalls()

def psyclone.parse.algorithm.InvokeCall.kcalls

(

self

)

:returns: the list of kernel calls in this invoke call
:rtype: list of \
:py:class:`psyclone.parse.algorithm.KernelCall` or \
:py:class:`psyclone.parse.algorithm.BuiltInCall`

Definition at line 931 of file algorithm.py.

    def kcalls(self):
        '''
        :returns: the list of kernel calls in this invoke call
        :rtype: list of \
        :py:class:`psyclone.parse.algorithm.KernelCall` or \
        :py:class:`psyclone.parse.algorithm.BuiltInCall`
 
        '''
        return self._kcalls
 
 

References psyclone.parse.algorithm.InvokeCall._kcalls.

name()

def psyclone.parse.algorithm.InvokeCall.name

(

self

)

:returns: the name of this invoke call
:rtype: str

Definition at line 922 of file algorithm.py.

    def name(self):
        '''
        :returns: the name of this invoke call
        :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:

---

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

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