Inheritance diagram for psyclone.parse.kernel.KernelType:

Public Member Functions
def	__init__ (self, ast, name=None)

def	name (self)

def	iterates_over (self)

def	procedure (self)

def	nargs (self)

def	arg_descriptors (self)

def	__repr__ (self)

def	get_integer_variable (self, name)

def	get_integer_array (self, name)

Detailed Description

Base class for describing Kernel Metadata.

This contains the name of the elemental procedure and metadata associated
with how that procedure is mapped over mesh entities.

:param ast: fparser1 AST for the parsed kernel meta-data.
:type ast: :py:class:`fparser.one.block_statements.BeginSource`
:param str name: name of the Fortran derived type describing the kernel.

:raises ParseError: if the supplied AST does not contain a Fortran \
module.
:raises ParseError: if the module name is too short to contain \
'_mod' at the end.
:raises ParseError: if the module name does not end in '_mod'.

Definition at line 777 of file kernel.py.

Member Function Documentation

◆ arg_descriptors()

def psyclone.parse.kernel.KernelType.arg_descriptors ( self )

:returns: a list of API-specific argument descriptors.
:rtype: list of API-specific specialisation of \
:py:class:`psyclone.kernel.Descriptor`

Definition at line 894 of file kernel.py.

     def arg_descriptors(self):
         '''
         :returns: a list of API-specific argument descriptors.
         :rtype: list of API-specific specialisation of \
         :py:class:`psyclone.kernel.Descriptor`
  
         '''
         return self._arg_descriptors
  

References psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata._arg_descriptors, psyclone.gocean1p0.GOKernelType1p0._arg_descriptors, psyclone.parse.kernel.KernelType._arg_descriptors, psyclone.psyGen.Kern._arg_descriptors, and psyclone.psyGen.BuiltIn._arg_descriptors.

Here is the caller graph for this function:

◆ get_integer_array()

def psyclone.parse.kernel.KernelType.get_integer_array	(	self,
		name
	)

 Parse the kernel meta-data and find the values of the
integer array variable with the supplied name. Returns an empty list
if no matching variable is found. The search is not case sensitive.

:param str name: the name of the integer array to find.

:return: list of values (lower-case).
:rtype: list of str.

:raises InternalError: if we fail to parse the LHS of the array \
                       declaration or the array constructor.
:raises ParseError: if the array is not of rank 1.
:raises ParseError: if the array extent is not specified using an \
                    integer literal.
:raises ParseError: if the RHS of the declaration is not an array \
                    constructor.
:raises InternalError: if the parse tree for the array constructor \
                       does not have the expected structure.
:raises ParseError: if the number of items in the array constructor \
                    does not match the extent of the array.

Definition at line 939 of file kernel.py.

     def get_integer_array(self, name):
         ''' Parse the kernel meta-data and find the values of the
         integer array variable with the supplied name. Returns an empty list
         if no matching variable is found. The search is not case sensitive.
  
         :param str name: the name of the integer array to find.
  
         :return: list of values (lower-case).
         :rtype: list of str.
  
         :raises InternalError: if we fail to parse the LHS of the array \
                                declaration or the array constructor.
         :raises ParseError: if the array is not of rank 1.
         :raises ParseError: if the array extent is not specified using an \
                             integer literal.
         :raises ParseError: if the RHS of the declaration is not an array \
                             constructor.
         :raises InternalError: if the parse tree for the array constructor \
                                does not have the expected structure.
         :raises ParseError: if the number of items in the array constructor \
                             does not match the extent of the array.
  
         '''
         # Ensure the classes are setup for the Fortran2008 parser
         _ = ParserFactory().create(std="f2008")
         # Fortran is not case sensitive so nor is our matching
         lower_name = name.lower()
  
         for statement, _ in fpapi.walk(self._ktype):
             if not isinstance(statement, fparser1.typedecl_statements.Integer):
                 # This isn't an integer declaration so skip it
                 continue
             # fparser only goes down to the statement level. We use fparser2 to
             # parse the statement itself.
             assign = Fortran2003.Assignment_Stmt(statement.entity_decls[0])
             names = walk(assign.children, Fortran2003.Name)
             if not names:
                 raise InternalError(f"Unsupported assignment statement: "
                                     f"'{assign}'")
  
             if str(names[0]).lower() != lower_name:
                 # This is not the variable declaration we're looking for
                 continue
  
             if not isinstance(assign.children[0], Fortran2003.Part_Ref):
                 # Not an array declaration
                 return []
  
             if not isinstance(assign.children[0].children[1],
                               Fortran2003.Section_Subscript_List):
                 raise InternalError(
                     f"get_integer_array: expected array declaration to have a "
                     f"Section_Subscript_List but found "
                     f"'{type(assign.children[0].children[1]).__name__}' "
                     f"for: '{assign}'")
  
             dim_stmt = assign.children[0].children[1]
             if len(dim_stmt.children) != 1:
                 raise ParseError(
                     f"get_integer_array: array must be 1D but found an array "
                     f"with {len(dim_stmt.children)} dimensions for name '"
                     f"{name}'")
             if not isinstance(dim_stmt.children[0],
                               Fortran2003.Int_Literal_Constant):
                 raise ParseError(
                     f"get_integer_array: array extent must be specified using "
                     f"an integer literal but found '{dim_stmt.children[0]}' "
                     f"for array '{name}'")
             # Get the declared size of the array
             array_extent = int(str(dim_stmt.children[0]))
  
             if not isinstance(assign.children[2],
                               Fortran2003.Array_Constructor):
                 raise ParseError(
                     f"get_integer_array: RHS of assignment is not "
                     f"an array constructor: '{assign}'")
             # fparser2 AST for Array_Constructor is:
             # Array_Constructor('[', Ac_Value_List(',', (Name('w0'),
             #                                      Name('w1'))), ']')
             # Construct a list of the names in the array constructor
             names = walk(assign.children[2].children, Fortran2003.Name)
             if not names:
                 raise InternalError(f"Failed to parse array constructor: "
                                     f"'{assign.items[2]}'")
             if len(names) != array_extent:
                 # Ideally fparser would catch this but it isn't yet mature
                 # enough.
                 raise ParseError(
                     f"get_integer_array: declared length of array '{name}' is "
                     f"{array_extent} but constructor only contains "
                     f"{len(names)} names: '{assign}'")
             return [str(name).lower() for name in names]
         # No matching declaration for the provided name was found
         return []

References psyclone.parse.algorithm.ParsedCall._ktype, and psyclone.parse.kernel.KernelType._ktype.

◆ get_integer_variable()

def psyclone.parse.kernel.KernelType.get_integer_variable	(	self,
		name
	)

 Parse the kernel meta-data and find the value of the
integer variable with the supplied name. Return None if no
matching variable is found. The search is not case sensitive.

:param str name: the name of the integer variable to find.

:return: value of the specified integer variable (lower case) or None.
:rtype: str

:raises ParseError: if the RHS of the assignment is not a Name.

Definition at line 906 of file kernel.py.

     def get_integer_variable(self, name):
         ''' Parse the kernel meta-data and find the value of the
         integer variable with the supplied name. Return None if no
         matching variable is found. The search is not case sensitive.
  
         :param str name: the name of the integer variable to find.
  
         :return: value of the specified integer variable (lower case) or None.
         :rtype: str
  
         :raises ParseError: if the RHS of the assignment is not a Name.
  
         '''
         # Ensure the Fortran2008 parser is initialised
         _ = ParserFactory().create(std="f2008")
         # Fortran is not case sensitive so nor is our matching
         lower_name = name.lower()
  
         for statement, _ in fpapi.walk(self._ktype):
             if isinstance(statement, fparser1.typedecl_statements.Integer):
                 # fparser only goes down to the statement level. We use
                 # fparser2 to parse the statement itself (eventually we'll
                 # use fparser2 to parse the whole thing).
                 assign = Fortran2003.Assignment_Stmt(
                     statement.entity_decls[0])
                 if str(assign.items[0]).lower() == lower_name:
                     if not isinstance(assign.items[2], Fortran2003.Name):
                         raise ParseError(
                             f"get_integer_variable: RHS of assignment is not "
                             f"a variable name: '{assign}'")
                     return str(assign.items[2]).lower()
         return None
  

References psyclone.parse.algorithm.ParsedCall._ktype, and psyclone.parse.kernel.KernelType._ktype.

◆ iterates_over()

def psyclone.parse.kernel.KernelType.iterates_over ( self )

:returns: the name of the iteration space supported by this kernel
:rtype: str

Definition at line 866 of file kernel.py.

     def iterates_over(self):
         '''
         :returns: the name of the iteration space supported by this kernel
         :rtype: str
  
         '''
         return self._iterates_over
  

References psyclone.domain.common.psylayer.psyloop.PSyLoop._iterates_over, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._iterates_over, psyclone.parse.kernel.KernelType._iterates_over, and psyclone.psyGen.Kern._iterates_over.

Here is the caller graph for this function:

◆ name()

def psyclone.parse.kernel.KernelType.name ( self )

:returns: the name of the kernel subroutine.
:rtype: str

Definition at line 857 of file kernel.py.

     def name(self):
         '''
         :returns: the name of the kernel subroutine.
         :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:

◆ nargs()

def psyclone.parse.kernel.KernelType.nargs ( self )

:returns: the number of arguments specified in the metadata.
:rtype: int

Reimplemented in psyclone.gocean1p0.GOKernelType1p0.

Definition at line 885 of file kernel.py.

     def nargs(self):
         '''
         :returns: the number of arguments specified in the metadata.
         :rtype: int
  
         '''
         return len(self._arg_descriptors)
  

References psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata._arg_descriptors, psyclone.gocean1p0.GOKernelType1p0._arg_descriptors, psyclone.parse.kernel.KernelType._arg_descriptors, psyclone.psyGen.Kern._arg_descriptors, and psyclone.psyGen.BuiltIn._arg_descriptors.

Here is the caller graph for this function:

◆ procedure()

def psyclone.parse.kernel.KernelType.procedure ( self )

:returns: a kernelprocedure instance which contains a parse tree \
of the kernel subroutine and its name.
:rtype: :py:class:`psyclone.parse.kernel.KernelProcedure`

Definition at line 875 of file kernel.py.

     def procedure(self):
         '''
         :returns: a kernelprocedure instance which contains a parse tree \
         of the kernel subroutine and its name.
         :rtype: :py:class:`psyclone.parse.kernel.KernelProcedure`
  
         '''
         return self._procedure
  

References psyclone.parse.kernel.KernelType._procedure.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ arg_descriptors()

◆ get_integer_array()

◆ get_integer_variable()

◆ iterates_over()

◆ name()

◆ nargs()

◆ procedure()