(Towards #3398) move LFRicRedundantComputationTrans and update to use kwargs.

changelog

@@ -1,3 +1,6 @@
+   28) PR #3417 towards #3398. Move LFRicRedundantComputationTrans into the
+   LFRic transformations module.
+
    27) PR #3438 for #3435. Add support for sub_transformations in the kwargs
    documentation functionality.
 

doc/user_guide/lfric.rst

@@ -4160,7 +4160,7 @@ transformations have not yet been migrated to this directory.
     :members:
     :noindex:
 
-.. autoclass:: psyclone.transformations.LFRicRedundantComputationTrans
+.. autoclass:: psyclone.domain.lfric.transformations.LFRicRedundantComputationTrans
     :members:
     :noindex:
 

examples/lfric/eg11/async_script.py

@@ -40,21 +40,21 @@
 
 '''
 
+from psyclone.domain.lfric.transformations import (
+    LFRicRedundantComputationTrans)
+from psyclone.psyir.nodes import FileContainer
+from psyclone.psyir.transformations import MoveTrans
+from psyclone.transformations import LFRicAsyncHaloExchangeTrans
 
-def trans(psyir):
+
+def trans(psyir: FileContainer) -> None:
     '''A sample transformation script to demonstrate the use of asynchronous
     halo exchanges with overlapping compute and communication for the
     most costly halo exchanges in the (current version of the) LFRic model.
 
     :param psyir: the PSyIR of the PSy-layer.
-    :type psyir: :py:class:`psyclone.psyir.nodes.FileContainer`
 
     '''
-    from psyclone.transformations import \
-        LFRicRedundantComputationTrans, \
-        LFRicAsyncHaloExchangeTrans
-    from psyclone.psyir.transformations import MoveTrans
-
     # Get first subroutine of the first module
     schedule = psyir.children[0].children[0]
     print(schedule.view())

examples/lfric/eg8/redundant_script.py

@@ -45,18 +45,20 @@
 repository but an operator has been replaced with a field in one of
 the kernels to allow redundant computation'''
 
+from psyclone.domain.lfric.transformations import (
+    LFRicRedundantComputationTrans)
+from psyclone.psyir.nodes import FileContainer
+from psyclone.psyir.transformations import MoveTrans
 
-def trans(psyir):
+
+def trans(psyir: FileContainer) -> None:
     '''Removes the grad_p halo exchanges by redundant computation then
     moves the remaining halo exchanges to the beginning of the invoke
     call.
 
     :param psyir: the PSyIR of the PSy-layer.
-    :type psyir: :py:class:`psyclone.psyir.nodes.FileContainer`
 
     '''
-    from psyclone.transformations import LFRicRedundantComputationTrans
-    from psyclone.psyir.transformations import MoveTrans
     rc_trans = LFRicRedundantComputationTrans()
     m_trans = MoveTrans()
 

examples/lfric/scripts/everything_everywhere_all_at_once.py

@@ -42,14 +42,14 @@
 '''
 from psyclone.domain.common.transformations import KernelModuleInlineTrans
 from psyclone.domain.lfric import LFRicConstants
+from psyclone.domain.lfric.transformations import (
+    LFRicRedundantComputationTrans)
 from psyclone.lfric import LFRicHaloExchange, LFRicHaloExchangeStart
 from psyclone.psyir.transformations import Matmul2CodeTrans, OMPParallelTrans
 from psyclone.psyir.nodes import IntrinsicCall, KernelSchedule
 from psyclone.psyGen import InvokeSchedule
-from psyclone.transformations import LFRicColourTrans, \
-                                     LFRicOMPLoopTrans, \
-                                     LFRicRedundantComputationTrans, \
-                                     LFRicAsyncHaloExchangeTrans
+from psyclone.transformations import (
+    LFRicColourTrans, LFRicOMPLoopTrans, LFRicAsyncHaloExchangeTrans)
 from psyclone.psyir.transformations import MoveTrans, TransformationError
 
 ENABLE_REDUNDANT_COMPUTATION = True

examples/lfric/scripts/extract_script.py

@@ -7,15 +7,14 @@
 # Author: J. Henrichs, Bureau of Meteorology
 
 '''
-PSyclone transformation script for the LFRic (Dynamo0p3) API to apply
+PSyclone transformation script for the LFRic API to apply
 redundant computation and then extract all kernels.
 
 '''
 
 from psyclone.domain.lfric import LFRicLoop
-from psyclone.domain.lfric.transformations import LFRicExtractTrans
-
-from psyclone.transformations import LFRicRedundantComputationTrans
+from psyclone.domain.lfric.transformations import (
+    LFRicExtractTrans, LFRicRedundantComputationTrans)
 
 SETVAL_BUILTINS = ["setval_c"]
 

examples/lfric/scripts/gpu_offloading.py

@@ -46,14 +46,15 @@
 from psyclone.domain.common.transformations import KernelModuleInlineTrans
 from psyclone.domain.lfric import LFRicConstants
 from psyclone.domain.lfric.lfric_builtins import LFRicBuiltIn
+from psyclone.domain.lfric.transformations import (
+    LFRicRedundantComputationTrans)
 from psyclone.psyir.nodes import (
     Call, Directive, IntrinsicCall, Loop, Routine, Schedule)
 from psyclone.psyir.transformations import (
     ACCKernelsTrans, Matmul2CodeTrans, OMPTargetTrans, TransformationError,
     OMPDeclareTargetTrans, OMPParallelTrans, ACCLoopTrans)
 from psyclone.transformations import (
     LFRicColourTrans, LFRicOMPLoopTrans,
-    LFRicRedundantComputationTrans,
     ACCParallelTrans, ACCRoutineTrans,
     OMPLoopTrans)
 

examples/lfric/scripts/redundant_dofs.py

@@ -38,7 +38,8 @@
 iterate over dofs and do not contain a reduction.
 
 '''
-from psyclone.transformations import LFRicRedundantComputationTrans
+from psyclone.domain.lfric.transformations import (
+    LFRicRedundantComputationTrans)
 
 ITERATION_SPACES = ["dofs"]
 DEPTH = 1

examples/lfric/scripts/redundant_setval_c.py

@@ -38,7 +38,8 @@
 of loops that iterate over dofs and contain the setval_c builtin.
 
 '''
-from psyclone.transformations import LFRicRedundantComputationTrans
+from psyclone.domain.lfric.transformations import (
+    LFRicRedundantComputationTrans)
 
 # We don't include "owned_dofs" here as we only want loops that
 # are permitted to perform redundant computation.

src/psyclone/domain/lfric/transformations/__init__.py

@@ -38,15 +38,10 @@
 '''
 
 # pylint: disable=unused-import
-from psyclone.domain.lfric.transformations.lfric_alg_trans \
-    import LFRicAlgTrans
-from psyclone.domain.lfric.transformations.lfric_alg_invoke_2_psy_call_trans \
-    import LFRicAlgInvoke2PSyCallTrans
-from psyclone.domain.lfric.transformations.lfric_extract_trans \
-    import LFRicExtractTrans
-from psyclone.domain.lfric.transformations.raise_psyir_2_lfric_alg_trans \
-    import RaisePSyIR2LFRicAlgTrans
-from psyclone.domain.lfric.transformations.lfric_loop_fuse_trans \
-    import LFRicLoopFuseTrans
-from psyclone.domain.lfric.transformations.raise_psyir_2_lfric_kern_trans \
-    import RaisePSyIR2LFRicKernTrans
+from .lfric_alg_trans import LFRicAlgTrans
+from .lfric_alg_invoke_2_psy_call_trans import LFRicAlgInvoke2PSyCallTrans
+from .lfric_extract_trans import LFRicExtractTrans
+from .raise_psyir_2_lfric_alg_trans import RaisePSyIR2LFRicAlgTrans
+from .lfric_loop_fuse_trans import LFRicLoopFuseTrans
+from .lfric_redundant_computation_trans import LFRicRedundantComputationTrans
+from .raise_psyir_2_lfric_kern_trans import RaisePSyIR2LFRicKernTrans