Merge pull request #3472 from stfc/3471_get_option_fix

(Closes #3471) get option sub transformation fix

Author: sergisiso

.github/workflows/lfric_test.yml

@@ -42,7 +42,7 @@ on:
   push
 
 env:
-  LFRIC_APPS_HASH: 299d4f786dd2d86a59a184c3e53384005a69eded
+  LFRIC_APPS_HASH: 56054ba955cc97a8529afc3844139ab58bd7d359
   PYTHON_VERSION: "3.14"
   GNU_TOOLCHAIN: gnu14_openmpi
   NVHPC_TOOLCHAIN: nvhpc26_3_openmpi
@@ -116,7 +116,7 @@ jobs:
         cp ${PSYCLONE_LFRIC_DIR}/does_nothing.py ${OPT_DIR}/global.py
         # Clean previous version and compile again
         rm -rf working-gh-passthrough
-        ./build/local_build.py -j ${NUM_PARALLEL} -v -p psyclone-test -w working-gh-passthrough gungho_model
+        ./build/local_build.py -j ${NUM_PARALLEL} -p psyclone-test -w working-gh-passthrough gungho_model
         # Run
         cd applications/gungho_model/example
         rm -f timer.txt gungho_model-checksums.txt  # In case there were from a previous run
@@ -148,7 +148,7 @@ jobs:
         # Clean previous version and compile again
         rm -rf working-gh-ompoffload
         export BUILD_START="${SECONDS}"
-        LFRIC_OFFLOAD_DIRECTIVES=omp ./build/local_build.py -v -j ${NUM_PARALLEL} -p psyclone-test \
+        LFRIC_OFFLOAD_DIRECTIVES=omp ./build/local_build.py -j ${NUM_PARALLEL} -p psyclone-test \
           -w working-gh-ompoffload gungho_model |& tee output.txt
         # Piping to tee ignores the errcode of the first command, make sure we account for it
         if [[ ${PIPESTATUS[0]} -ne 0 ]]; then
@@ -185,7 +185,7 @@ jobs:
         cp ${PSYCLONE_LFRIC_DIR}/gpu_offloading.py ${OPT_DIR}/global.py
         # Clean previous version and compile again
         rm -rf working-gh-accoffload
-        LFRIC_OFFLOAD_DIRECTIVES=acc ./build/local_build.py -v -j ${NUM_PARALLEL} -p psyclone-test \
+        LFRIC_OFFLOAD_DIRECTIVES=acc ./build/local_build.py -j ${NUM_PARALLEL} -p psyclone-test \
           -w working-gh-accoffload gungho_model
         cd applications/gungho_model/example
         rm -f timer.txt gungho_model-checksums.txt  # In case there were from a previous run
@@ -215,7 +215,7 @@ jobs:
         cp ${PSYCLONE_LFRIC_DIR}/everything_everywhere_all_at_once.py ${OPT_DIR}/global.py
         # Clean previous version and compile again
         rm -rf working-gh_alltrans
-        ./build/local_build.py -j ${NUM_PARALLEL} -p psyclone-test -v -w working-gh-alltrans gungho_model
+        ./build/local_build.py -j ${NUM_PARALLEL} -p psyclone-test -w working-gh-alltrans gungho_model
         # Run
         cd applications/gungho_model/example
         rm -f timer.txt gungho_model-checksums.txt  # In case there were from a previous run
@@ -244,7 +244,7 @@ jobs:
         cp ${PSYCLONE_LFRIC_DIR}/tiledcolouring_and_omp.py ${OPT_DIR}/global.py
         # Clean previous version and compile again
         rm -rf working-gh-omptiling
-        ./build/local_build.py -j ${NUM_PARALLEL} -p psyclone-test -v -w working-gh-omptiling gungho_model
+        ./build/local_build.py -j ${NUM_PARALLEL} -p psyclone-test -w working-gh-omptiling gungho_model
         # Run
         cd applications/gungho_model/example
         rm -f timer.txt gungho_model-checksums.txt  # In case there were from a previous run
@@ -269,7 +269,7 @@ jobs:
         # Build the 'meto-ex1a' platform, that includes psyclone-transmutation
         rm -rf working-atm-transmuted
         export BUILD_START="${SECONDS}"
-        ./build/local_build.py -v -p meto-ex1a -j 16 -w working-atm-transmuted lfric_atm
+        ./build/local_build.py -p meto-ex1a -j 16 -w working-atm-transmuted lfric_atm
         export BUILD_ELAPSED=$((${SECONDS}-${BUILD_START}))
 
         # Run the app with 8 threads and no MPI
@@ -300,7 +300,7 @@ jobs:
         # enabled, but we want to make sure we keep the nvfortran build working.
         rm -rf working-atm-gpu
         export BUILD_START="${SECONDS}"
-        ./build/local_build.py -v -p meto-ex1a -j 16 -w working-atm-gpu lfric_atm
+        ./build/local_build.py -p meto-ex1a -j 16 -w working-atm-gpu lfric_atm
         export BUILD_ELAPSED=$((${SECONDS}-${BUILD_START}))
 
 

changelog

@@ -1,3 +1,6 @@
+   1) PR #3472 for #3471. Let the transformations get_options method
+   account for sub-transformation options.
+  
 Release 3.3.1 7th July 2026
 
    5) PR #3431. Adds the force_private option to the OMPParallelTrans.

examples/lfric/scripts/KGOs/lfric_atm-checksums.txt

@@ -1,9 +1,9 @@
 Inner product checksum rho = 405F163A37CF0717
-Inner product checksum theta = 41B09B090C8AE887
-Inner product checksum u = 44035B926C8572D4
-Inner product checksum mr1 = 3F901037544354E5
-Inner product checksum mr2 = 3E3CF684EB2B8268
-Inner product checksum mr3 = 3DBDE2F11F7F42BD
+Inner product checksum theta = 41B09B081D579236
+Inner product checksum u = 44035AFB5E390BAB
+Inner product checksum mr1 = 3F900FB50435E6CE
+Inner product checksum mr2 = 3E3B00EEB3C82F38
+Inner product checksum mr3 = 3DC969B45C6D3EC0
 Inner product checksum mr4 =                0
 Inner product checksum mr5 =                0
 Inner product checksum mr6 =                0

examples/lfric/scripts/aggregate_gpu_stats.sh

@@ -95,6 +95,6 @@ count_uniq "Failed to offload"
 count_uniq "Added inner loop nested parallelism"
 count_uniq "Added OMP threading"
 
-check_above "Module-inline successful" 277
-check_above "Offload independent loop" 88
+check_above "Module-inline successful" 283
+check_above "Offload independent loop" 83
 check_above "Offload with cell colouring" 40

src/psyclone/psyGen.py

@@ -2428,7 +2428,12 @@ def get_option(self, option_name: str, **kwargs) -> Any:
         :raises ValueError: if option_name is not found in the valid options
                             for the Transformation.
         '''
-        valid_options = type(self).get_valid_options()
+        valid_options = {}
+        # dict.update keeps the last value if multiple dicts contain the
+        # same key, so we do the type(self) update last.
+        for subtrans in type(self)._SUB_TRANSFORMATIONS:
+            valid_options.update(subtrans.get_valid_options())
+        valid_options.update(type(self).get_valid_options())
         if option_name not in valid_options.keys():
             raise ValueError(f"option '{option_name}' is not a valid option "
                              f"for '{type(self).__name__}'. Valid options "

src/psyclone/tests/psyGen_test.py

@@ -206,6 +206,34 @@ def apply(self, node, valid: bool = True):
     assert ("option 'invalid' is not a valid option for 'TestTrans'. "
             "Valid options are '['valid']." in str(excinfo.value))
 
+    # Test that we allow _SUB_TRANSFORMATIONS_OPTIONS
+
+    class TestTrans2(Transformation):
+        '''Utility transformation to test methods of the abstract
+        Transformation class with _SUB_TRANSFORMATIONS.'''
+        _SUB_TRANSFORMATIONS = [TestTrans]
+
+        def apply(self, node, **kwargs):
+            ...
+
+    trans = TestTrans2()
+    # Check that we allow the fetching of the TestTrans option.
+    assert trans.get_option("valid", valid=True)
+
+    # Test that we use current transformations default value
+    # over an inherited value.
+    class TestTrans3(Transformation):
+        '''Utility transformation to test methods of the abstract
+        Transformation class with _SUB_TRANSFORMATIONS.'''
+        _SUB_TRANSFORMATIONS = [TestTrans]
+
+        def apply(self, node, valid=False, **kwargs):
+            ...
+    opts = {}
+    trans = TestTrans3()
+    # Check that we get the default False for the valid option.
+    assert not trans.get_option("valid", **opts)
+
 
 def test_transformation_split_kwargs():
     ''' Test that the kwargs can be split when they can be propagated to