MAPL3 generic: remove vector_component_names from specs and parser (#4956)

* MAPL3 generic: remove vector_component_names from specs and parser

Drop support for vector_component_names in YAML parsing and VariableSpec/VectorClassAspect construction, and update vector test inputs accordingly.

Also simplify vector component alias generation in RestartHandler.

* MAPL_Generic: stub out vector_component_names argument in gridcomp_add_spec

Add vector_component_names as an accepted but unused optional argument to gridcomp_add_spec to preserve API compatibility while the implementation is handled elsewhere in the vector spec pathway.

* RestartHandler: trim whitespace from integer-formatted vector bundle alias names

Author: pchakraborty

infrastructure/fields/field_bundle/FieldBundleGet.F90

@@ -44,11 +44,11 @@ subroutine bundle_get(fieldBundle, unusable, &
         bracket_updated, &
         has_deferred_aspects, &
         regridder_param_info, &
-       vector_basis_kind, &
-       quantity_type_metadata, &
-       normalization_metadata, &
-       conservation_metadata, &
-       rc)
+        vector_basis_kind, &
+        quantity_type_metadata, &
+        normalization_metadata, &
+        conservation_metadata, &
+        rc)
 
       type(ESMF_FieldBundle), intent(in) :: fieldBundle
       class(KeywordEnforcer), optional, intent(in) :: unusable
@@ -71,11 +71,11 @@ subroutine bundle_get(fieldBundle, unusable, &
       logical, optional, intent(out) :: bracket_updated
       logical, optional, intent(out) :: has_deferred_aspects
       type(esmf_Info), optional, allocatable, intent(out) :: regridder_param_info
-       type(VectorBasisKind), optional, intent(out) :: vector_basis_kind
-       type(QuantityTypeMetadata), optional, intent(out) :: quantity_type_metadata
-       type(NormalizationMetadata), optional, intent(out) :: normalization_metadata
-       type(ConservationMetadata), optional, intent(out) :: conservation_metadata
-       integer, optional, intent(out) :: rc
+      type(VectorBasisKind), optional, intent(out) :: vector_basis_kind
+      type(QuantityTypeMetadata), optional, intent(out) :: quantity_type_metadata
+      type(NormalizationMetadata), optional, intent(out) :: normalization_metadata
+      type(ConservationMetadata), optional, intent(out) :: conservation_metadata
+      integer, optional, intent(out) :: rc
 
       integer :: status
       integer :: fieldCount_

superstructure/generic/ComponentSpecParser.F90

@@ -74,7 +74,6 @@ module mapl_ComponentSpecParser
    character(*), parameter :: KEY_VERTICAL_STAGGER = 'vertical_dim_spec'
    character(*), parameter :: KEY_TIMESTEP = 'timestep'
    character(*), parameter :: KEY_RUN_TIME_OFFSET = 'run_time_offset'
-   character(*), parameter :: KEY_VECTOR_COMPONENT_NAMES = 'vector_component_names'
 
    !>
    ! Submodule declarations

superstructure/generic/ComponentSpecParser/parse_var_specs.F90

@@ -64,7 +64,6 @@ subroutine parse_state_specs(var_specs, hconfig, state_intent, component_name, r
          logical :: has_expression
          type(ESMF_HConfig) :: subcfg
          type(StringVector) :: dependencies
-         type(StringVector) :: vector_component_names
 
          type(GeometrySpec) :: geometry_spec
          type(MaplGeom), pointer :: mapl_geom
@@ -106,8 +105,6 @@ subroutine parse_state_specs(var_specs, hconfig, state_intent, component_name, r
                expression = ESMF_HConfigAsString(attributes,keyString='expression', _RC)
             end if
 
-            vector_component_names = get_vector_component_names(attributes, _RC)
-
             itemtype = to_itemtype(attributes, _RC)
             call to_service_items(service_items, attributes, _RC)
 
@@ -137,8 +134,7 @@ subroutine parse_state_specs(var_specs, hconfig, state_intent, component_name, r
                  dependencies=dependencies, &
                  expression=expression, &
                  geom=geom, &
-                 vertical_grid=vertical_grid, &
-                 vector_component_names=vector_component_names, _RC)
+                 vertical_grid=vertical_grid, _RC)
 
             if (allocated(units)) deallocate(units)
             if (allocated(standard_name)) deallocate(standard_name)
@@ -340,35 +336,6 @@ function to_dependencies(attributes, rc) result(dependencies)
          _RETURN(_SUCCESS)
       end function to_dependencies
 
-      function get_vector_component_names(attributes, rc) result(names)
-         type(StringVector) :: names
-         type(ESMF_HConfig), intent(in) :: attributes
-         integer, optional, intent(out) :: rc
-
-         integer :: status
-         logical :: has_vector_components
-         type(ESMF_HConfig) :: names_cfg
-         type(ESMF_HConfigIter) :: b, e, iter
-         character(:), allocatable :: name
-
-         names = StringVector()
-         has_vector_components = ESMF_HConfigIsDefined(attributes, keyString=KEY_VECTOR_COMPONENT_NAMES, _RC)
-         _RETURN_UNLESS(has_vector_components)
-
-         names_cfg = ESMF_HConfigCreateAt(attributes, keyString=KEY_VECTOR_COMPONENT_NAMES, _RC)
-         b = ESMF_HConfigIterBegin(names_cfg, _RC)
-         e = ESMF_HConfigIterEnd(names_cfg, _RC)
-         iter = b
-         do while (ESMF_HConfigIterLoop(iter,b,e))
-            name = ESMF_HConfigAsString(iter, _RC)
-            call names%push_back(name)
-         end do
-         call ESMF_HConfigDestroy(names_cfg, _RC)
-
-         _RETURN(_SUCCESS)
-      end function get_vector_component_names
-
-
    end function parse_var_specs
 
 end submodule parse_var_specs_smod

superstructure/generic/MAPL_Generic.F90

@@ -590,7 +590,6 @@ subroutine gridcomp_add_spec( &
       type(ComponentSpec), pointer :: component_spec
       character(len=:), allocatable :: units_
       type(UngriddedDims), allocatable :: dim_specs_vec
-      type(StringVector) :: vector_component_names_vec
       integer :: status
 
       _ASSERT((dims=="xyz") .or. (dims=="xy") .or. (dims=="z"), "dims can be one of xyz/xy/z")
@@ -602,14 +601,6 @@ subroutine gridcomp_add_spec( &
       ! If input units is present, override using input values
       if (present(units)) units_ = units
       if (present(ungridded_dims)) dim_specs_vec = UngriddedDims(ungridded_dims)
-      ! vector_component_names
-      if (present(vector_component_names)) then
-         _ASSERT(present(itemType), "itemType must be present if vector_component_names is present")
-         _ASSERT((itemType==MAPL_STATEITEM_VECTOR), "valid only for vector items")
-         _ASSERT((size(vector_component_names)==2), "vector_component_names must have 2 components")
-         call vector_component_names_vec%push_back(trim(vector_component_names(1)))
-         call vector_component_names_vec%push_back(trim(vector_component_names(2)))
-      end if
       var_spec = make_VariableSpec( &
            state_intent, &
            short_name, &
@@ -624,7 +615,6 @@ subroutine gridcomp_add_spec( &
            has_deferred_aspects=has_deferred_aspects, &
            service_items=service_items, &
            restart_mode=restart, &
-           vector_component_names=vector_component_names_vec, &
            _RC)
       call MAPL_GridCompGetOuterMeta(gridcomp, outer_meta, _RC)
       component_spec => outer_meta%get_component_spec()
@@ -645,6 +635,7 @@ subroutine gridcomp_add_spec( &
 
       _RETURN(_SUCCESS)
       _UNUSED_DUMMY(unusable)
+      _UNUSED_DUMMY(vector_component_names)
    end subroutine gridcomp_add_spec
 
    subroutine gridcomp_advertise_variable(gridcomp, var_spec, rc)

superstructure/generic/RestartHandler.F90

@@ -153,7 +153,8 @@ recursive function get_field_bundle_from_state_(this, state, rc) result(bundle)
       type(ESMF_FieldBundle) :: bundle2
       type (ESMF_StateItem_Flag), allocatable  :: item_types(:)
       character(len=ESMF_MAXSTR), allocatable :: item_names(:)
-      character(len=:), allocatable :: item_name, short_name
+      character(len=:), allocatable :: item_name
+      character(len=ESMF_MAXSTR) :: short_name
       integer :: idx, jdx, item_count, status
 
       bundle = ESMF_FieldBundleCreate(_RC)
@@ -169,10 +170,10 @@ recursive function get_field_bundle_from_state_(this, state, rc) result(bundle)
             call MAPL_FieldBundleAdd(bundle, [field], _RC)
          else if (item_types(idx) == ESMF_STATEITEM_FIELDBUNDLE) then
             call ESMF_StateGet(state, item_name, bundle2, _RC)
-            call MAPL_FieldBundleGet(bundle2, fieldList=field_list, _RC)
+            call MAPL_FieldBundleGet(bundle2, fieldList=field_list, _RC) ! addorder
             do jdx = 1, size(field_list)
-               call MAPL_FieldGet(field_list(jdx), short_name=short_name, _RC)
-               alias = ESMF_NamedAlias(field_list(jdx), name=item_name//"_"//short_name, _RC)
+               write(short_name, '(I0)') jdx
+               alias = ESMF_NamedAlias(field_list(jdx), name=item_name//"_"//trim(short_name), _RC)
                call MAPL_FieldBundleAdd(bundle, [alias], _RC)
             end do
          else

superstructure/generic/specs/VariableSpec.F90

@@ -81,7 +81,6 @@ module mapl_VariableSpec
       !---------------------
       ! Vector
       !---------------------
-      type(StringVector) :: vector_component_names ! default empty
       type(VectorBasisKind), allocatable :: vector_basis_kind
       real(kind=ESMF_KIND_R4), allocatable :: fill_value
       !---------------------
@@ -180,7 +179,6 @@ function make_VariableSpec( &
         dependencies, &
         regrid_param, &
         horizontal_dims_spec, &
-        vector_component_names, &
         vector_basis_kind, &
         has_deferred_aspects, &
         use_field_dictionary, &
@@ -210,7 +208,6 @@ function make_VariableSpec( &
       type(StringVector), optional, intent(in) :: dependencies
       type(EsmfRegridderParam), optional, intent(in) :: regrid_param
       type(HorizontalDimsSpec), optional, intent(in) :: horizontal_dims_spec
-      type(StringVector), optional, intent(in) :: vector_component_names
       character(*), optional, intent(in) :: vector_basis_kind
       logical, optional, intent(in) :: has_deferred_aspects
       logical, optional, intent(in) :: use_field_dictionary
@@ -247,7 +244,6 @@ function make_VariableSpec( &
       _SET_OPTIONAL(dependencies)
       _SET_OPTIONAL(regrid_param)
       _SET_OPTIONAL(horizontal_dims_spec)
-      _SET_OPTIONAL(vector_component_names)
       _SET_OPTIONAL(has_deferred_aspects)
       _SET_OPTIONAL(use_field_dictionary)
       _SET_OPTIONAL(restart_mode)
@@ -649,7 +645,6 @@ function make_ClassAspect(this, registry, rc) result(aspect)
 
       integer :: status
       character(:), allocatable :: std_name_1, std_name_2
-      type(StringVector) :: vector_component_names
       type(VectorBasisKind) :: basis_kind
 
       select case (this%itemType%ot)
@@ -668,18 +663,12 @@ function make_ClassAspect(this, registry, rc) result(aspect)
          if (allocated(this%standard_name)) then
             call split_name(this%standard_name, std_name_1, std_name_2, _RC)
          end if
-         if (this%vector_component_names%size() == 0) then
-            call vector_component_names%push_back("unknown1")
-            call vector_component_names%push_back("unknown2")
-         else
-            vector_component_names = this%vector_component_names
-         end if
          if (allocated(this%vector_basis_kind)) then
             basis_kind = this%vector_basis_kind
          else
             basis_kind = VECTOR_BASIS_KIND_NS
          end if
-         aspect = VectorClassAspect(vector_component_names, &
+         aspect = VectorClassAspect( &
               [ &
               FieldClassAspect(standard_name=std_name_1, fill_value=this%fill_value), &
               FieldClassAspect(standard_name=std_name_2, fill_value=this%fill_value) &

superstructure/generic/specs/VectorClassAspect.F90

@@ -50,7 +50,6 @@ module mapl_VectorClassAspect
    type, extends(ClassAspect) :: VectorClassAspect
       private
       type(ESMF_FieldBundle) :: payload
-      type(StringVector) :: short_names
       type(FieldClassAspect) :: component_specs(2)
       type(VectorBasisKind) :: basis_kind
    contains
@@ -78,13 +77,11 @@ module mapl_VectorClassAspect
 
 contains
 
-   function new_VectorClassAspect_basic(short_names, component_specs, basis_kind) result(aspect)
+   function new_VectorClassAspect_basic(component_specs, basis_kind) result(aspect)
       type(VectorClassAspect) :: aspect
-      type(StringVector), intent(in) :: short_names
       type(FieldClassAspect), intent(in) :: component_specs(2)
       type(VectorBasisKind), intent(in) :: basis_kind
 
-      aspect%short_names = short_names
       aspect%component_specs = component_specs
       aspect%basis_kind = basis_kind
    end function new_VectorClassAspect_basic
@@ -163,9 +160,6 @@ subroutine allocate(this, other_aspects, rc)
          call update_payload(this%component_specs(i), other_aspects, _RC)
          call this%component_specs(i)%allocate(other_aspects, _RC)
          call this%component_specs(i)%add_to_bundle(this%payload, _RC)
-         ! update the name of the component
-         call this%component_specs(i)%get_payload(field=field, _RC)
-         call ESMF_FieldSet(field, name=trim(this%short_names%at(i)), _RC)
       end do
 
       _RETURN(ESMF_SUCCESS)
@@ -239,9 +233,6 @@ subroutine connect_to_export(this, export, actual_pt, rc)
       call this%destroy(_RC) ! import is replaced by export/extension
       this%payload = export_%payload
 
-      ! mirror short names since they are required in add_to_state routine
-      this%short_names = export_%short_names
-
       _RETURN(_SUCCESS)
       _UNUSED_DUMMY(actual_pt)
    end subroutine connect_to_export

superstructure/generic/tests/scenarios/vector_1/child_A.yaml

@@ -19,7 +19,6 @@ mapl:
       uv:
         class: vector
         standard_name: '(eastward,northward) horizontal velocity'
-        vector_component_names: [u, v]
         units: 'm s-1'
         fill_value: 1
         vertical_dim_spec: center

superstructure/generic/tests/scenarios/vector_1/child_B.yaml

@@ -17,7 +17,6 @@ mapl:
       uv:
         class: vector
         standard_name: '(eastward,northward) horizontal velocity'
-        vector_component_names: [u, v]
         units: 'm s-1'
         fill_value: 1
         vertical_dim_spec: center

tests/MAPL3G_Component_Testing_Framework/test_cases/case18/GCM1.yaml

@@ -18,7 +18,6 @@ mapl:
       UV:
         class: vector
         standard_name: '(eastward_wind, northward_wind) horizontal velocity'
-        vector_component_names: [U, V]
         units: "m s-1"
         typekind: R4
         fill_value: 17.