2091: renaming and moving DynKern to LFRicKern

doc/developer_guide/APIs.rst

@@ -634,7 +634,7 @@ requires a check that any loop which includes a kernel that reads from
 an operator is limited to iterating in the halo up to
 depth-1. PSyclone will raise an exception if an optimisation attempts
 to increase the iteration space beyond this (see the ``gen_code()``
-method in the ``DynKern`` class).
+method in the ``LFRicKern`` class).
 
 To alleviate the above restriction one could add a configurable depth with
 which to compute operators e.g. operators are always computed up to
@@ -883,8 +883,8 @@ target spaces.
 When constructing a ``DynKernMetadata`` object from the parsed kernel
 metadata, the list of target function-space names (as they appear in
 the meta-data) is stored in ``DynKernMetadata._eval_targets``. This
-information is then used in the ``DynKern._setup()`` method which
-populates ``DynKern._eval_targets``. This is an ``OrderedDict`` which has
+information is then used in the ``LFRicKern._setup()`` method which
+populates ``LFRicKern._eval_targets``. This is an ``OrderedDict`` which has
 the (mangled) names of the target function spaces as keys and 2-tuples
 consisting of ``FunctionSpace`` and ``DynKernelArgument`` objects as
 values. The ``DynKernelArgument`` object provides the kernel argument
@@ -894,7 +894,7 @@ holds full information on the target function space.
 The ``DynInvokeBasisFunctions`` class is responsible for managing the
 evaluators required by all of the kernels called from an Invoke.
 ``DynInvokeBasisFunctions._eval_targets`` collects all of the unique target
-function spaces from the ``DynKern._eval_targets`` of each kernel.
+function spaces from the ``LFRicKern._eval_targets`` of each kernel.
 
 ``DynInvokeBasisFunctions._basis_fns`` is a list holding information on
 each basis/differential basis function required by a kernel within the

doc/developer_guide/modules.rst

@@ -293,6 +293,6 @@ This class is then sub-classed in order to support the generation of
 argument lists when *calling* kernels (``KernCallArgList``) and when
 *creating* kernel stubs (``KernStubArgList``).  ``KernCallArgList`` is
 only used in ``DynKernelArguments.raw_arg_list()``.
-``KernStubArgList`` is only used in ``DynKern.gen_stub()``. These
+``KernStubArgList`` is only used in ``LFRicKern.gen_stub()``. These
 classes make use of ``LFRicCollection`` sub-classes in order
 to ensure that argument naming is consistent.

doc/developer_guide/psyir.rst

@@ -1025,7 +1025,7 @@ correspond to and how the arguments relate to each other (they just
 output strings).
 
 The logic and declaration of kernel variables is handled separately by
-the ``gen_stub`` method in ``DynKern`` and the ``gen_code`` method in
+the ``gen_stub`` method in ``LFRicKern`` and the ``gen_code`` method in
 ``LFRicInvoke``. In both cases these methods make use of the subclasses
 of ``LFRicCollection`` to declare variables.
 

src/psyclone/domain/lfric/__init__.py

@@ -50,7 +50,6 @@
 from psyclone.domain.lfric.kern_call_acc_arg_list import KernCallAccArgList
 from psyclone.domain.lfric.kern_call_invoke_arg_list import \
     KernCallInvokeArgList
-from psyclone.domain.lfric.lfric_kern_call_factory import LFRicKernCallFactory
 from psyclone.domain.lfric.kernel_interface import KernelInterface
 from psyclone.domain.lfric.lfric_extract_driver_creator import \
     LFRicExtractDriverCreator
@@ -62,6 +61,8 @@
     MetadataToArgumentsRules
 from psyclone.domain.lfric.arg_index_to_metadata_index import \
     ArgIndexToMetadataIndex
+from psyclone.domain.lfric.lfric_kern import LFRicKern
+from psyclone.domain.lfric.lfric_kern_call_factory import LFRicKernCallFactory
 from psyclone.domain.lfric.lfric_collection import LFRicCollection
 from psyclone.domain.lfric.lfric_run_time_checks import LFRicRunTimeChecks
 from psyclone.domain.lfric.lfric_invokes import LFRicInvokes
@@ -82,6 +83,8 @@
     'LFRicExtractDriverCreator',
     'LFRicInvoke',
     'LFRicInvokes',
+    'LFRicKern',
+    'LFRicKernCallFactory',
     'LFRicLoopBounds',
     'LFRicRunTimeChecks',
     'LFRicScalarArgs',

src/psyclone/domain/lfric/algorithm/lfric_alg.py

@@ -33,6 +33,7 @@
 # -----------------------------------------------------------------------------
 # Author: A. R. Porter, STFC Daresbury Laboratory.
 # Modified by: R. W. Ford, STFC Daresbury Laboratory.
+#              L. Turner, Met Office
 
 '''This module contains the LFRicAlg class which encapsulates tools for
    creating standalone LFRic algorithm-layer code.
@@ -43,7 +44,7 @@
                                    LFRicSymbolTable, LFRicTypes)
 from psyclone.domain.lfric.algorithm.psyir import (
     LFRicAlgorithmInvokeCall, LFRicBuiltinFunctorFactory, LFRicKernelFunctor)
-from psyclone.dynamo0p3 import DynKern
+from psyclone.domain.lfric import LFRicKern
 from psyclone.errors import InternalError
 from psyclone.parse.kernel import get_kernel_parse_tree, KernelTypeFactory
 from psyclone.parse.utils import ParseError
@@ -406,15 +407,15 @@ def initialise_quadrature(prog, qr_sym, shape):
     def kernel_from_metadata(parse_tree, kernel_name):
         '''
         Given an fparser1 parse tree for an LFRic kernel, creates and returns
-        a DynKern object.
+        a LFRicKern object.
 
         :param parse_tree: the fparser1 parse tree for the LFRic kernel.
         :type parse_tree: :py:class:`fparser.one.block_statements.BeginSource`
         :param str kernel_name: the name of the kernel contained in the \
-            supplied parse tree for which a DynKern is to be created.
+            supplied parse tree for which a LFRicKern is to be created.
 
-        :returns: a DynKern object describing the LFRic kernel.
-        :rtype: :py:class:`psyclone.dynamo0p3.DynKern`
+        :returns: a LFRicKern object describing the LFRic kernel.
+        :rtype: :py:class:`psyclone.domain.lfric.LFRicKern`
 
         :raises ValueError: if an LFRic kernel with the specified name cannot \
                             be found in the supplied parse tree.
@@ -427,8 +428,8 @@ def kernel_from_metadata(parse_tree, kernel_name):
                 f"Failed to find kernel '{kernel_name}' in supplied "
                 f"code: '{parse_tree}'. Is it a valid LFRic kernel? Original "
                 f"error was '{err}'.") from err
-        # Construct a DynKern using the metadata.
-        kern = DynKern()
+        # Construct a LFRicKern using the metadata.
+        kern = LFRicKern()
         kern.load_meta(ktype)
         return kern
 
@@ -440,7 +441,7 @@ def construct_kernel_args(self, prog, kern):
         :param prog: the routine to which to add the declarations etc.
         :type prog: :py:class:`psyclone.psyir.nodes.Routine`
         :param kern: the kernel for which we are to create arguments.
-        :type kern: :py:class:`psyclone.dynamo0p3.DynKern`
+        :type kern: :py:class:`psyclone.domain.lfric.LFRicKern`
 
         :returns: object capturing all of the kernel arguments.
         :rtype: :py:class:`psyclone.domain.lfric.KernCallInvokeArgList`

src/psyclone/domain/lfric/arg_ordering.py

@@ -32,7 +32,7 @@
 # POSSIBILITY OF SUCH DAMAGE.
 # -----------------------------------------------------------------------------
 # Authors R. W. Ford, A. R. Porter and S. Siso, STFC Daresbury Lab
-# Modified I. Kavcic and A. Coughtrie, Met Office
+# Modified I. Kavcic, A. Coughtrie and L. Turner, Met Office
 # Modified J. Henrichs, Bureau of Meteorology
 
 '''This module implements the base class for managing arguments to
@@ -65,7 +65,7 @@ class ArgOrdering:
     a list.
 
     :param kern: the kernel call object to use.
-    :type kern: :py:class:`psyclone.dynamo0p3.DynKern`
+    :type kern: :py:class:`psyclone.domain.lfric.LFRicKern`
 
     '''
     def __init__(self, kern):

src/psyclone/domain/lfric/kern_call_arg_list.py

@@ -32,7 +32,7 @@
 # POSSIBILITY OF SUCH DAMAGE.
 # -----------------------------------------------------------------------------
 # Authors R. W. Ford, A. R. Porter and S. Siso, STFC Daresbury Lab
-# Modified I. Kavcic and A. Coughtrie, Met Office
+# Modified I. Kavcic, A. Coughtrie and L. Turner, Met Office
 # Modified J. Henrichs, Bureau of Meteorology
 
 '''This module implements a class that manages the argument for a kernel
@@ -70,7 +70,7 @@ class KernCallArgList(ArgOrdering):
     captured by the base class.
 
     :param kern: The kernel that is being called.
-    :type kern: :py:class:`psyclone.dynamo0p3.DynKern`
+    :type kern: :py:class:`psyclone.domain.lfric.LFRicKern`
 
     '''
     NdfInfo = namedtuple("NdfInfo", ["position", "function_space"])

src/psyclone/domain/lfric/kern_call_invoke_arg_list.py

@@ -32,7 +32,7 @@
 # POSSIBILITY OF SUCH DAMAGE.
 # -----------------------------------------------------------------------------
 # Authors R. W. Ford, A. R. Porter and S. Siso, STFC Daresbury Lab
-# Modified I. Kavcic and A. Coughtrie, Met Office
+# Modified I. Kavcic, A. Coughtrie and L. Turner, Met Office
 # Modified J. Henrichs, Bureau of Meteorology
 
 '''
@@ -53,7 +53,7 @@ class KernCallInvokeArgList(ArgOrdering):
     kernel, according to that kernel's metadata.
 
     :param kern: the kernel object for which to determine arguments.
-    :type kern: :py:class:`psyclone.dynamo0p3.DynKern`
+    :type kern: :py:class:`psyclone.domain.lfric.LFRicKern`
     :param symbol_table: the symbol table associated with the routine that \
         contains the `invoke` of this kernel.
     :type symbol_table: :py:class:`psyclone.psyir.symbols.SymbolTable`

src/psyclone/domain/lfric/kern_stub_arg_list.py

@@ -32,7 +32,7 @@
 # POSSIBILITY OF SUCH DAMAGE.
 # -----------------------------------------------------------------------------
 # Authors R. W. Ford, A. R. Porter and S. Siso, STFC Daresbury Lab
-# Modified I. Kavcic and A. Coughtrie, Met Office
+# Modified I. Kavcic, A. Coughtrie and L. Turner, Met Office
 # Modified J. Henrichs, Bureau of Meteorology
 
 '''This module implements a class that creates the argument list
@@ -51,7 +51,7 @@ class KernStubArgList(ArgOrdering):
     of the arguments is captured by the base class.
 
     :param kern: Kernel for which to create argument list.
-    :type kern: :py:class:`psyclone.dynamo0p3.DynKern`
+    :type kern: :py:class:`psyclone.domain.lfric.LFRicKern`
 
     :raises NotImplementedError: if the kernel is inter-grid.
     :raises NotImplementedError: if the kernel requires properties of the \

src/psyclone/domain/lfric/kernel_interface.py

@@ -32,7 +32,7 @@
 # POSSIBILITY OF SUCH DAMAGE.
 # -----------------------------------------------------------------------------
 # Author R. W. Ford, STFC Daresbury Lab
-# Modified: I. Kavcic, Met Office
+# Modified: I. Kavcic and L. Turner, Met Office
 #           A. R. Porter and N. Nobre, STFC Daresbury Lab
 # Modified: J. Henrichs, Bureau of Meteorology
 
@@ -71,7 +71,7 @@ class KernelInterface(ArgOrdering):
     code when all of its methods are implemented.
 
     :param kern: the kernel for which to create arguments.
-    :type kern: :py:class:`psyclone.dynamo0p3.DynKern`
+    :type kern: :py:class:`psyclone.domain.lfric.LFRicKern`
 
     '''
     #: Mapping from a generic PSyIR datatype to the equivalent

src/psyclone/domain/lfric/lfric_collection.py

@@ -42,7 +42,8 @@
 
 # Imports
 import abc
-from psyclone.domain.lfric import LFRicSymbolTable, LFRicInvoke
+from psyclone.domain.lfric import (LFRicSymbolTable, LFRicInvoke,
+                                   LFRicKern)
 from psyclone.errors import InternalError
 
 
@@ -54,24 +55,21 @@ class LFRicCollection():
     :param node: the Kernel or Invoke for which to manage variable \
                  declarations and initialisation.
     :type node: :py:class:`psyclone.domain.lfric.LFRicInvoke` or \
-                :py:class:`psyclone.dynamo0p3.DynKern`
+                :py:class:`psyclone.domain.lfric.LFRicKern`
 
-    :raises InternalError: if the supplied node is not an LFRicInvoke or a \
-                           DynKern.
+    :raises InternalError: if the supplied node is not an LFRicInvoke or an \
+                           LFRicKern.
 
     '''
     def __init__(self, node):
-        # Import here to avoid circular dependency
-        # pylint: disable=import-outside-toplevel
-        from psyclone.dynamo0p3 import DynKern
         if isinstance(node, LFRicInvoke):
             # We are handling declarations/initialisations for an Invoke
             self._invoke = node
             self._kernel = None
             self._symbol_table = self._invoke.schedule.symbol_table
             # The list of Kernel calls we are responsible for
             self._calls = node.schedule.kernels()
-        elif isinstance(node, DynKern):
+        elif isinstance(node, LFRicKern):
             # We are handling declarations for a Kernel stub
             self._invoke = None
             self._kernel = node
@@ -82,7 +80,7 @@ def __init__(self, node):
             self._calls = [node]
         else:
             raise InternalError(f"LFRicCollection takes only an LFRicInvoke "
-                                f"or a DynKern but got: {type(node)}")
+                                f"or an LFRicKern but got: {type(node)}")
 
         # Whether or not the associated Invoke contains only Kernels that
         # operate on DoFs.