psyclone.parse.kernel.KernelTypeFactory Class Reference

Inheritance diagram for psyclone.parse.kernel.KernelTypeFactory:

Public Member Functions
def	__init__ (self, api="")
def	create (self, parse_tree, name=None)

Detailed Description

Factory to create the required API-specific information about
coded-kernel metadata and a reference to its code.

:param str api: The API for which this factory is to create Kernel \
information. If it is not supplied then the default API, as \
specified in the PSyclone config file, is used.

Definition at line 210 of file kernel.py.

Member Function Documentation

create()

def psyclone.parse.kernel.KernelTypeFactory.create	(		self,
			parse_tree,
			name = None
	)

Create API-specific information about the kernel metadata and a
reference to its code. The API is set when the factory is
created.

:param parse_tree: The fparser1 parse tree for the Kernel code.
:type parse_tree: :py:class:`fparser.one.block_statements.BeginSource`

:param name: the name of the Kernel. Defaults to None if \
one is not provided.
:type name: str or NoneType

:raises ParseError: if the supplied API is not supported.

Definition at line 227 of file kernel.py.

    def create(self, parse_tree, name=None):
        '''Create API-specific information about the kernel metadata and a
        reference to its code. The API is set when the factory is
        created.
 
        :param parse_tree: The fparser1 parse tree for the Kernel code.
        :type parse_tree: :py:class:`fparser.one.block_statements.BeginSource`
 
        :param name: the name of the Kernel. Defaults to None if \
        one is not provided.
        :type name: str or NoneType
 
        :raises ParseError: if the supplied API is not supported.
 
        '''
        # Avoid circular import
        # pylint: disable=import-outside-toplevel
        if self._type == "dynamo0.3":
            from psyclone.domain.lfric import LFRicKernMetadata
            return LFRicKernMetadata(parse_tree, name=name)
        if self._type == "gocean1.0":
            from psyclone.gocean1p0 import GOKernelType1p0
            return GOKernelType1p0(parse_tree, name=name)
        raise ParseError(
            f"KernelTypeFactory:create: Unsupported kernel type '{self._type}'"
            f" found.")
 
 

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/parse/kernel.py