2091: renaming and moving DynKern to LFRicKern

src/psyclone/domain/lfric/__init__.py

@@ -82,6 +82,7 @@
     'LFRicConstants',
     'LFRicExtractDriverCreator',
     'LFRicInvoke',
+    'LFRicInvokes',
     'LFRicKern',
     'LFRicKernCallFactory',
     'LFRicLoopBounds',

src/psyclone/domain/lfric/lfric_kern.py

@@ -254,9 +254,9 @@ def _setup(self, ktype, module_name, args, parent, check=True):
         # pylint: disable=import-outside-toplevel
         from psyclone.dynamo0p3 import DynKernelArguments, FSDescriptors
         # pylint: disable=too-many-branches, too-many-locals
-        CodedKern.__init__(self, DynKernelArguments,
-                           KernelCall(module_name, ktype, args),
-                           parent, check)
+        super().__init__(DynKernelArguments,
+                         KernelCall(module_name, ktype, args),
+                         parent, check)
         # Remove "_code" from the name if it exists to determine the
         # base name which (if LFRic naming conventions are
         # followed) is used as the root for the module and subroutine
@@ -385,28 +385,33 @@ def is_intergrid(self):
     def colourmap(self):
         '''
         Getter for the name of the colourmap associated with this kernel call.
-
         :returns: name of the colourmap (Fortran array).
         :rtype: str
-
         :raises InternalError: if this kernel is not coloured or the \
                                dictionary of inter-grid kernels and \
                                colourmaps has not been constructed.
-
         '''
         if not self.is_coloured():
             raise InternalError(f"Kernel '{self.name}' is not inside a "
                                 f"coloured loop.")
+        sched = self.ancestor(InvokeSchedule)
         if self._is_intergrid:
-            invoke = self.ancestor(InvokeSchedule).invoke
+            invoke = sched.invoke
             if id(self) not in invoke.meshes.intergrid_kernels:
                 raise InternalError(
                     f"Colourmap information for kernel '{self.name}' has "
                     f"not yet been initialised")
             cmap = invoke.meshes.intergrid_kernels[id(self)].\
                 colourmap_symbol.name
         else:
-            cmap = self.scope.symbol_table.lookup_with_tag("cmap").name
+            try:
+                cmap = sched.symbol_table.lookup_with_tag("cmap").name
+            except KeyError:
+                # We have to do this here as _init_colourmap (which calls this
+                # method) is only called at code-generation time.
+                cmap = sched.symbol_table.find_or_create_array(
+                    "cmap", 2, ScalarType.Intrinsic.INTEGER,
+                    tag="cmap").name
 
         return cmap
 
@@ -415,30 +420,29 @@ def last_cell_all_colours_symbol(self):
         '''
         Getter for the symbol of the array holding the index of the last
         cell of each colour.
-
         :returns: name of the array.
         :rtype: str
-
         :raises InternalError: if this kernel is not coloured or the \
                                dictionary of inter-grid kernels and \
                                colourmaps has not been constructed.
         '''
         if not self.is_coloured():
             raise InternalError(f"Kernel '{self.name}' is not inside a "
                                 f"coloured loop.")
+
         if self._is_intergrid:
             invoke = self.ancestor(InvokeSchedule).invoke
             if id(self) not in invoke.meshes.intergrid_kernels:
                 raise InternalError(
                     f"Colourmap information for kernel '{self.name}' has "
                     f"not yet been initialised")
-            return invoke.meshes.intergrid_kernels[id(self)].\
-                last_cell_var_symbol
+            return (invoke.meshes.intergrid_kernels[id(self)].
+                    last_cell_var_symbol)
 
+        ubnd_name = self.ancestor(Loop).upper_bound_name
         const = LFRicConstants()
 
-        if (self.ancestor(Loop).upper_bound_name in
-                const.HALO_ACCESS_LOOP_BOUNDS):
+        if (ubnd_name in const.HALO_ACCESS_LOOP_BOUNDS):
             return self.scope.symbol_table.find_or_create_array(
                 "last_halo_cell_all_colours", 2,
                 ScalarType.Intrinsic.INTEGER,
@@ -543,9 +547,6 @@ def all_updates_are_writes(self):
         :rtype: bool
 
         '''
-        if self.is_intergrid:
-            # This is not a special kernel
-            return False
         accesses = set(arg.access for arg in self.args)
         all_writes = AccessType.all_write_accesses()
         all_writes.remove(AccessType.WRITE)
@@ -605,10 +606,11 @@ def gen_stub(self):
         # pylint: disable=import-outside-toplevel
         from psyclone.dynamo0p3 import (DynCellIterators, DynDofmaps,
                                         DynFunctionSpaces, DynCMAOperators,
-                                        LFRicScalarArgs, DynBoundaryConditions,
+                                        DynBoundaryConditions,
                                         DynLMAOperators, LFRicMeshProperties,
                                         DynBasisFunctions, LFRicFields,
                                         DynReferenceElement, DynStencils)
+        from psyclone.domain.lfric import LFRicScalarArgs
         for entities in [DynCellIterators, DynDofmaps, DynFunctionSpaces,
                          DynCMAOperators, LFRicScalarArgs, LFRicFields,
                          DynLMAOperators, DynStencils, DynBasisFunctions,
@@ -729,6 +731,25 @@ class creates the PSyIR schedule on first invocation which is
 
         # Get the PSyIR Kernel Schedule(s)
         routines = Fparser2Reader().get_routine_schedules(self.name, self.ast)
+        for routine in routines:
+            # If one of the symbols is not declared in a routine then
+            # this is only picked up when writing out the routine
+            # (raising a VisitorError), so we check here so that
+            # invalid code is not inlined. We use debug_string() to
+            # minimise the overhead.
+
+            # TODO #2271 could potentially avoid the need for
+            # debug_string() within. Sergi suggests that we may be
+            # missing the traversal of the declaration init
+            # expressions and that might solve the problem. I'm not so
+            # sure as we are talking about unknown symbols that will
+            # only be resolved in the back-end (or not). If I am right
+            # then one option would be to use the FortranWriter, but
+            # that would be bigger overhead, or perhaps just the
+            # declarations part of FortranWriter if that is possible.
+            # Also see TODO issue #2336 which captures the specific
+            # problem in LFRic that this fixes.
+            routine.debug_string()
 
         if len(routines) == 1:
             sched = routines[0]

src/psyclone/domain/lfric/lfric_scalar_args.py

@@ -62,7 +62,7 @@ class LFRicScalarArgs(LFRicCollection):
 
     :param node: the Invoke or Kernel stub for which to manage the scalar \
                  arguments.
-    :type node: :py:class:`psyclone.dynamo0p3.DynKern` or \
+    :type node: :py:class:`psyclone.domain.lfric.LFRicKern` or \
                 :py:class:`psyclone.domain.lfric.LFRicInvoke`
 
     '''

src/psyclone/dynamo0p3.py

@@ -57,31 +57,28 @@
                                                   LFRicBuiltIn, BUILTIN_MAP)
 from psyclone.domain.common.psylayer import PSyLoop
 from psyclone.domain.lfric import (FunctionSpace, KernCallAccArgList,
-                                   KernCallArgList, KernStubArgList,
-                                   LFRicArgDescriptor, KernelInterface,
+                                   KernCallArgList, LFRicArgDescriptor,
                                    LFRicCollection, LFRicConstants,
-                                   LFRicSymbolTable, LFRicInvoke,
-                                   LFRicKernCallFactory, LFRicScalarArgs,
-                                   LFRicKern)
+                                   LFRicSymbolTable, LFRicKernCallFactory,
+                                   LFRicKern, LFRicInvokes, LFRicTypes)
 from psyclone.errors import GenerationError, InternalError, FieldNotFoundError
 from psyclone.f2pygen import (AllocateGen, AssignGen, CallGen, CommentGen,
                               DeallocateGen, DeclGen, DoGen, IfThenGen,
                               ModuleGen, TypeDeclGen, UseGen, PSyIRGen)
 from psyclone.parse.kernel import KernelType, getkerneldescriptors
 from psyclone.parse.utils import ParseError
-
-from psyclone.psyGen import (PSy, Invokes, InvokeSchedule, Arguments,
+from psyclone.psyGen import (PSy, InvokeSchedule, Arguments,
                              KernelArgument, HaloExchange, GlobalSum,
                              DataAccess)
 from psyclone.psyir.frontend.fortran import FortranReader
 from psyclone.psyir.nodes import (Loop, Literal, Schedule, Reference,
                                   ArrayReference, ACCEnterDataDirective,
                                   ACCRegionDirective, OMPRegionDirective,
-                                  Routine, ScopingNode, StructureReference)
+                                  Routine, ScopingNode)
 from psyclone.psyir.symbols import (INTEGER_TYPE, DataSymbol, ScalarType,
                                     DeferredType, DataTypeSymbol,
                                     ContainerSymbol, ImportInterface,
-                                    SymbolError)
+                                    ArrayType, UnknownFortranType)
 
 # pylint: disable=too-many-lines
 # --------------------------------------------------------------------------- #

src/psyclone/tests/domain/lfric/dyn_proxies_test.py

@@ -32,13 +32,14 @@
 # POSSIBILITY OF SUCH DAMAGE.
 # -----------------------------------------------------------------------------
 # Author A. R. Porter, STFC Daresbury Lab
+# Modified L. Turner, Met Office
 
 ''' This module tests the DynProxies class using pytest. '''
 
 import os
 import pytest
-from psyclone.domain.lfric import LFRicConstants
-from psyclone.dynamo0p3 import DynKern, DynProxies
+from psyclone.domain.lfric import LFRicConstants, LFRicKern
+from psyclone.dynamo0p3 import DynProxies
 from psyclone.errors import InternalError
 from psyclone.f2pygen import ModuleGen, SubroutineGen
 from psyclone.parse.algorithm import parse
@@ -127,7 +128,7 @@ def test_initialise_errors(monkeypatch):
                     api=TEST_API)
     psy = PSyFactory(TEST_API, distributed_memory=True).create(info)
     invoke = psy.invokes.invoke_list[0]
-    kern = invoke.schedule.walk(DynKern)[0]
+    kern = invoke.schedule.walk(LFRicKern)[0]
     proxies = DynProxies(invoke)
     amod = ModuleGen("test_mod")
     node = SubroutineGen(amod, name="a_sub")

src/psyclone/tests/domain/lfric/kern_call_acc_arg_list_test.py

@@ -31,9 +31,10 @@
 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 # -----------------------------------------------------------------------------
-# Authors: J. Henrichs, Bureau of Meteorology
-#          R. W. Ford and A. R. Porter, STFC Daresbury Lab
-#          I. Kavcic, Met Office
+# Authors:  J. Henrichs, Bureau of Meteorology
+#           R. W. Ford and A. R. Porter, STFC Daresbury Lab
+#           I. Kavcic, Met Office
+# Modified: L. Turner, Met Office
 
 ''' This module tests the LFric KernCallAccArgList class.'''
 
@@ -42,8 +43,8 @@
 import pytest
 
 from psyclone.core import VariablesAccessInfo
-from psyclone.domain.lfric import FunctionSpace, KernCallAccArgList
-from psyclone.dynamo0p3 import DynKern
+from psyclone.domain.lfric import (FunctionSpace, KernCallAccArgList,
+                                   LFRicKern)
 from psyclone.errors import InternalError
 from psyclone.parse.algorithm import parse
 from psyclone import psyGen
@@ -57,14 +58,14 @@
 
 def test_acc_arg_list_cell_map(dist_mem, monkeypatch):
     '''Test the cell_map() method.'''
-    # We need a DynKern in order to construct an instance of KernCallAccArgList
+    # We need a LFRicKern in order to construct an instance of KernCallAccArgList
     _, invoke_info = parse(os.path.join(BASE_PATH,
                                         "22.0_intergrid_prolong.f90"),
                            api=TEST_API)
     psy = psyGen.PSyFactory(TEST_API,
                             distributed_memory=dist_mem).create(invoke_info)
     schedule = psy.invokes.invoke_list[0].schedule
-    kern = schedule.walk(DynKern)[0]
+    kern = schedule.walk(LFRicKern)[0]
     arg_list = KernCallAccArgList(kern)
     # Check that the cell_map method works as expected.
     arg_list.cell_map()
@@ -85,7 +86,7 @@ def test_stencil_2d():
                            name="invoke_0_testkern_stencil_multi_type",
                            dist_mem=False)
     sched = invoke.schedule
-    kern = sched.walk(DynKern)[0]
+    kern = sched.walk(LFRicKern)[0]
     arg_list = KernCallAccArgList(kern)
     arg_list.stencil_2d(kern.arguments._args[1])
     # This should result in the whole stencil dofmap being added as an arg.
@@ -102,7 +103,7 @@ def test_fs_compulsory_field_no_cell_column():
                            name="invoke_0_testkern_domain_type",
                            dist_mem=False)
     sched = invoke.schedule
-    kern = sched.walk(DynKern)[0]
+    kern = sched.walk(LFRicKern)[0]
     arg_list = KernCallAccArgList(kern)
     fspace = FunctionSpace("w3", kern.arguments)
     arg_list.fs_compulsory_field(fspace)
@@ -114,7 +115,7 @@ def test_fs_intergrid():
     _, invoke = get_invoke("22.2_intergrid_3levels.f90", TEST_API,
                            name="invoke_0", dist_mem=False)
     sched = invoke.schedule
-    kernels = sched.walk(DynKern)
+    kernels = sched.walk(LFRicKern)
     prolong_kern = kernels[0]
     restrict_kern = kernels[2]
     fspace = FunctionSpace("any_space_1", restrict_kern.arguments)

src/psyclone/tests/domain/lfric/lfric_scalar_mdata_test.py

@@ -35,7 +35,6 @@
 #         I. Kavcic, A. Coughtrie, L. Turner and O. Brunt, Met Office;
 #         C. M. Maynard, Met Office/University of Reading;
 #         J. Henrichs, Bureau of Meteorology.
-# Modified by L. Turner, Met Office
 
 '''
 Module containing pytest tests for the general LFRic scalar arguments
@@ -48,8 +47,8 @@
 from fparser import api as fpapi
 
 from psyclone.domain.lfric import (LFRicKern, LFRicArgDescriptor,
-                                   LFRicScalarArgs)
-from psyclone.dynamo0p3 import DynKernMetadata, LFRicConstants
+                                   LFRicScalarArgs, LFRicConstants)
+from psyclone.dynamo0p3 import DynKernMetadata
 from psyclone.errors import InternalError, GenerationError
 from psyclone.f2pygen import ModuleGen
 from psyclone.parse.algorithm import parse

src/psyclone/tests/dynamo0p3_test.py

@@ -1485,7 +1485,7 @@ def test_dynkernelargument_psyir_expression(monkeypatch):
                            api=TEST_API)
     psy = PSyFactory(TEST_API, distributed_memory=True).create(invoke_info)
     first_invoke = psy.invokes.invoke_list[0]
-    kern = first_invoke.schedule.walk(DynKern)[0]
+    kern = first_invoke.schedule.walk(LFRicKern)[0]
     psyir = kern.arguments.args[0].psyir_expression()
     assert isinstance(psyir, Reference)
     assert psyir.symbol.name == "mm_w0_local_stencil"
@@ -1498,7 +1498,7 @@ def test_dynkernelargument_psyir_expression(monkeypatch):
                            api=TEST_API)
     psy = PSyFactory(TEST_API, distributed_memory=True).create(invoke_info)
     first_invoke = psy.invokes.invoke_list[0]
-    kern = first_invoke.schedule.walk(DynKern)[0]
+    kern = first_invoke.schedule.walk(LFRicKern)[0]
     psyir = kern.arguments.args[1].psyir_expression()
     assert isinstance(psyir, Reference)
     assert psyir.symbol.name == "cma_op1_cma_matrix"
@@ -3670,12 +3670,9 @@ def test_haloex_not_required(monkeypatch):
 
 def test_lfriccollection_err1():
     ''' Check that the LFRicCollection constructor raises the expected
-    error if it is not provided with a LFRicKern or LFRicInvoke. '''
-    _, info = parse(os.path.join(BASE_PATH, "1_single_invoke.f90"),
-                    api=TEST_API)
-    psy = PSyFactory(TEST_API, distributed_memory=True).create(info)
+    error if it is not provided with an LFRicKern or LFRicInvoke. '''
     with pytest.raises(InternalError) as err:
-        _ = DynProxies(psy)
+        _ = DynProxies(None)
     assert ("LFRicCollection takes only an LFRicInvoke or an LFRicKern but"
             in str(err.value))
 

src/psyclone/transformations.py

@@ -34,8 +34,7 @@
 # Authors R. W. Ford, A. R. Porter, S. Siso and N. Nobre, STFC Daresbury Lab
 #         A. B. G. Chalk STFC Daresbury Lab
 #         J. Henrichs, Bureau of Meteorology
-# Modified I. Kavcic, J. G. Wallwork and L. Turner, Met Office
-
+# Modified I. Kavcic, J. G. Wallwork, O. Brunt and L. Turner, Met Office
 
 ''' This module provides the various transformations that can be applied to
     PSyIR nodes. There are both general and API-specific transformation
@@ -48,11 +47,10 @@
 
 from psyclone import psyGen
 from psyclone.configuration import Config
-from psyclone.domain.lfric import KernCallArgList, LFRicConstants
 from psyclone.core import Signature, VariablesAccessInfo
 from psyclone.domain.lfric import KernCallArgList, LFRicConstants, LFRicKern
-from psyclone.dynamo0p3 import DynHaloExchangeEnd, DynHaloExchangeStart, \
-    DynInvokeSchedule
+from psyclone.dynamo0p3 import LFRicHaloExchangeEnd, LFRicHaloExchangeStart, \
+    DynInvokeSchedule, DynLoop
 from psyclone.errors import InternalError
 from psyclone.gocean1p0 import GOInvokeSchedule
 from psyclone.nemo import NemoInvokeSchedule