psyclone.psyGen.PSyFactory Class Reference

Public Member Functions
def	__init__ (self, api="", distributed_memory=None)
def	create (self, invoke_info)

Detailed Description

Creates a specific version of the PSy. If a particular api is not
provided then the default api, as specified in the psyclone.cfg
file, is chosen.

:param str api: name of the PSyclone API (domain) for which to create \
    a factory.
:param bool distributed_memory: whether or not the PSy object created \
    will include support for distributed-memory parallelism.

:raises TypeError: if the distributed_memory argument is not a bool.

Definition at line 152 of file psyGen.py.

Member Function Documentation

create()

def psyclone.psyGen.PSyFactory.create	(		self,
			invoke_info
	)

Create the API-specific PSy instance.

:param invoke_info: information on the invoke()s found by parsing \
                    the Algorithm layer or (for NEMO) the fparser2 \
                    parse tree of the source file.
:type invoke_info: :py:class:`psyclone.parse.algorithm.FileInfo` or \
                   :py:class:`fparser.two.Fortran2003.Program`

:returns: an instance of the API-specific sub-class of PSy.
:rtype: subclass of :py:class:`psyclone.psyGen.PSy`

:raises InternalError: if this factory is found to have an \
                       unsupported type (API).

Definition at line 183 of file psyGen.py.

    def create(self, invoke_info):
        '''
        Create the API-specific PSy instance.
 
        :param invoke_info: information on the invoke()s found by parsing \
                            the Algorithm layer or (for NEMO) the fparser2 \
                            parse tree of the source file.
        :type invoke_info: :py:class:`psyclone.parse.algorithm.FileInfo` or \
                           :py:class:`fparser.two.Fortran2003.Program`
 
        :returns: an instance of the API-specific sub-class of PSy.
        :rtype: subclass of :py:class:`psyclone.psyGen.PSy`
 
        :raises InternalError: if this factory is found to have an \
                               unsupported type (API).
        '''
        # Conditional run-time importing is a part of this factory
        # implementation.
        # pylint: disable=import-outside-toplevel
        if self._type == "dynamo0.3":
            from psyclone.dynamo0p3 import DynamoPSy as PSyClass
        elif self._type == "gocean1.0":
            from psyclone.gocean1p0 import GOPSy as PSyClass
        elif self._type == "nemo":
            from psyclone.nemo import NemoPSy as PSyClass
            # For this API, the 'invoke_info' is actually the fparser2 AST
            # of the Fortran file being processed
        else:
            raise InternalError(
                f"PSyFactory: Unsupported API type '{self._type}' found. "
                f"Expected one of {Config.get().supported_apis}.")
        return PSyClass(invoke_info)
 
 

References psyclone.parse.kernel.KernelTypeFactory._type, and psyclone.psyGen.PSyFactory._type.

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/psyGen.py