scalar_fielmatrix to scalar_field_matrix

Author: imreddyTeja

.buildkite/pipeline.yml

@@ -861,13 +861,13 @@ steps:
         agents:
           slurm_gpus: 1
 
-      - label: "Unit: scalar_fieldmatrix (CPU)"
-        key: cpu_scalar_fieldmatrix
-        command: "julia --color=yes --check-bounds=yes --project=.buildkite test/MatrixFields/scalar_fieldmatrix.jl"
+      - label: "Unit: scalar_field_matrix (CPU)"
+        key: cpu_scalar_field_matrix
+        command: "julia --color=yes --check-bounds=yes --project=.buildkite test/MatrixFields/scalar_field_matrix.jl"
 
-      - label: "Unit: mscalar_fieldmatrix (GPU)"
-        key: gpu_scalar_fieldmatrix
-        command: "julia --color=yes --project=.buildkite test/MatrixFields/scalar_fieldmatrix.jl"
+      - label: "Unit: scalar_field_matrix (GPU)"
+        key: gpu_scalar_field_matrix
+        command: "julia --color=yes --project=.buildkite test/MatrixFields/scalar_field_matrix.jl"
         env:
           CLIMACOMMS_DEVICE: "CUDA"
         agents:

docs/src/matrix_fields.md

@@ -100,7 +100,7 @@ column_field2array
 column_field2array_view
 field2arrays
 field2arrays_view
-scalar_fieldmatrix
+scalar_field_matrix
 ```
 
 ## Indexing a FieldMatrix

src/MatrixFields/field_name_dict.jl

@@ -498,7 +498,7 @@ end
 
 
 """
-    scalar_fieldmatrix(field_matrix::FieldMatrix)
+    scalar_field_matrix(field_matrix::FieldMatrix)
 
 Constructs a `FieldNameDict` where the keys and entries are views
 of the entries of `field_matrix`, which corresponding to the
@@ -520,7 +520,7 @@ A = MatrixFields.FieldMatrix(
     (@name(c.uₕ), @name(c.sgsʲs.:(1).ρa)) => ᶜᶜmat3_uₕ_scalar,
 )
 
-A_scalar = MatrixFields.scalar_fieldmatrix(A)
+A_scalar = MatrixFields.scalar_field_matrix(A)
 keys(A_scalar)
 # Output:
 # (@name(c.ρχ.ρq_liq), @name(f.u₃.:(1)))
@@ -529,7 +529,7 @@ keys(A_scalar)
 # (@name(c.uₕ.:(2)), @name(c.sgsʲs.:(1).ρa))
 ```
 """
-function scalar_fieldmatrix(field_matrix::FieldMatrix)
+function scalar_field_matrix(field_matrix::FieldMatrix)
     scalar_keys = get_scalar_keys(field_matrix)
     entries = unrolled_map(scalar_keys.values) do key
         field_matrix[key]

test/MatrixFields/scalar_fieldmatrix.jl test/MatrixFields/scalar_field_matrix.jltest/MatrixFields/scalar_fieldmatrix.jl renamed to test/MatrixFields/scalar_field_matrix.jl

@@ -113,27 +113,27 @@ end
             entry ->
                 entry isa MatrixFields.UniformScaling ||
                     eltype(eltype(entry)) <: FT,
-            MatrixFields.scalar_fieldmatrix(A).entries,
+            MatrixFields.scalar_field_matrix(A).entries,
         )
         test_get(A, entry, key) = A[key] === entry
-        for (key, entry) in MatrixFields.scalar_fieldmatrix(A)
+        for (key, entry) in MatrixFields.scalar_field_matrix(A)
             @test test_get(A, entry, key)
             @test (@allocated test_get(A, entry, key)) == 0
             @test_opt test_get(A, entry, key)
         end
 
-        function scalar_fieldmatrix_wrapper(field_matrix_of_tensors)
-            A_scalar = MatrixFields.scalar_fieldmatrix(field_matrix_of_tensors)
+        function scalar_field_matrix_wrapper(field_matrix_of_tensors)
+            A_scalar = MatrixFields.scalar_field_matrix(field_matrix_of_tensors)
             return nothing
         end
 
-        scalar_fieldmatrix_wrapper(A)
-        @test (@allocated scalar_fieldmatrix_wrapper(A)) == 0
-        @test_opt MatrixFields.scalar_fieldmatrix(A)
+        scalar_field_matrix_wrapper(A)
+        @test (@allocated scalar_field_matrix_wrapper(A)) == 0
+        @test_opt MatrixFields.scalar_field_matrix(A)
 
         A_with_tree =
             MatrixFields.replace_name_tree(A, MatrixFields.FieldNameTree(b))
-        @test MatrixFields.scalar_fieldmatrix(A_with_tree).keys.name_tree ==
+        @test MatrixFields.scalar_field_matrix(A_with_tree).keys.name_tree ==
               A_with_tree.keys.name_tree
     end
 end