@@ -739,14 +739,21 @@ def get_dimension_info(hvar):
739739 - The local variable name of the vertical dimension (or None)
740740 - True if <hvar> has one dimension which is a horizontal dimension or
741741 if <hvar> has two dimensions (horizontal and vertical)
742+ - Flag if any dimensions are number_of_ccpp_constituents and needs
743+ reading separate variables by constituent and reassembled into
744+ host model indices.
742745 """
743746 vdim_name = None
744747 legal_dims = False
745748 fail_reason = ""
749+
746750 dims = hvar .get_dimensions ()
747751 levnm = hvar .has_vertical_dimension ()
752+ has_constituent_dim = any ('number_of_ccpp_constituents' in dim for dim in dims )
753+
748754 # <hvar> is only 'legal' for 2 or 3 dimensional fields (i.e., 1 or 2
749- # dimensional variables). The second dimension must be vertical.
755+ # dimensional variables).
756+ # The second dimension must either be vertical or number of constituents.
750757 # XXgoldyXX: If we ever need to read scalars, it would have to be
751758 # done using global attributes, not 'infld'.
752759 ldims = len (dims )
@@ -758,7 +765,17 @@ def get_dimension_info(hvar):
758765 fail_reason += f"{ suff } { lname }
759766 suff = "; "
760767 # end if
761- if (ldims > 2 ) or ((ldims > 1 ) and (not levnm )):
768+
769+ if has_constituent_dim :
770+ # A special case where any dimensions include number_of_ccpp_constituents,
771+ # in this case the variable needs to be suffixed by an underscore plus the constituent name
772+ # and read and reassembled separately into host model constituent indices
773+ # based on constituent name.
774+ # This case will be handled separately.
775+ legal_dims = True
776+ elif (ldims > 2 ) or ((ldims > 1 ) and (not levnm )):
777+ # The regular case where the second dimension must be vertical,
778+ # and higher dimensions are unsupported.
762779 legal_dims = False
763780 unsupp = []
764781 for dim in dims :
@@ -785,6 +802,7 @@ def get_dimension_info(hvar):
785802 # end if
786803 suff = "; "
787804 # end if
805+
788806 if legal_dims and levnm :
789807 # <hvar> should be legal, find the correct local name for the
790808 # vertical dimension
@@ -808,7 +826,8 @@ def get_dimension_info(hvar):
808826 raise ValueError (f"Vertical dimension, '{ levnm } )
809827 # end if
810828 # end if
811- return vdim_name , legal_dims , fail_reason
829+
830+ return vdim_name , legal_dims , fail_reason , has_constituent_dim
812831
813832def write_phys_read_subroutine (outfile , host_dict , host_vars , host_imports ,
814833 phys_check_fname_str , constituent_set ,
@@ -850,7 +869,7 @@ def write_phys_read_subroutine(outfile, host_dict, host_vars, host_imports,
850869 call_string_key = f"case ('{ var_stdname }
851870
852871 # Extract vertical level variable:
853- levnm , call_read_field , reason = get_dimension_info (hvar )
872+ levnm , call_read_field , reason , has_constituent_read = get_dimension_info (hvar )
854873 if hvar .get_prop_value ('protected' ):
855874 call_read_field = False
856875 if reason :
@@ -860,14 +879,23 @@ def write_phys_read_subroutine(outfile, host_dict, host_vars, host_imports,
860879 # end if
861880 lvar = hvar .get_prop_value ('local_name' )
862881 reason += f"{ suff } { lvar }
882+ # end if
883+
863884 # Set "read_field" call string:
864885 if call_read_field :
865- # Replace vertical dimension with local name
866- call_str = "call read_field(file, " + \
867- f"'{ var_stdname }
886+ if has_constituent_read :
887+ # Special case for constituent-dimension variables.
888+ call_str = f"call read_constituent_dimensioned_field(const_props, file, '{ var_stdname }
889+ else :
890+ # Replace vertical dimension with local name
891+ call_str = "call read_field(file, " + \
892+ f"'{ var_stdname }
893+ # end if
894+
868895 if levnm is not None :
869896 call_str += f"'{ levnm }
870897 # end if
898+
871899 err_on_not_found_string = ""
872900 if var_stdname in vars_init_value :
873901 # if initial value is available, do not throw error when not found in initial condition file.
@@ -903,7 +931,8 @@ def write_phys_read_subroutine(outfile, host_dict, host_vars, host_imports,
903931 ["shr_kind_mod" , ["SHR_KIND_CS, SHR_KIND_CL, SHR_KIND_CX" ]],
904932 ["physics_data" , ["read_field" , "find_input_name_idx" ,
905933 "no_exist_idx" , "init_mark_idx" ,
906- "prot_no_init_idx" , "const_idx" ]],
934+ "prot_no_init_idx" , "const_idx" ,
935+ "read_constituent_dimensioned_field" ]],
907936 ["cam_ccpp_cap" , ["ccpp_physics_suite_variables" ,
908937 "cam_constituents_array" ,
909938 "cam_model_const_properties" ]],
@@ -967,8 +996,13 @@ def write_phys_read_subroutine(outfile, host_dict, host_vars, host_imports,
967996 outfile .write ("logical :: use_init_variables" , 2 )
968997 outfile .blank_line ()
969998
999+ # Prepare constituent properties pointer for later usage:
1000+ outfile .comment ("Get constituent properties pointer:" , 2 )
1001+ outfile .write ("const_props => cam_model_const_properties()" , 2 )
1002+ outfile .blank_line ()
1003+
9701004 # Initialize variables:
971- outfile .comment ("Initalize missing and non-initialized variables strings:" ,
1005+ outfile .comment ("Initialize missing and non-initialized variables strings:" ,
9721006 2 )
9731007 outfile .write ("missing_required_vars = ' '" , 2 )
9741008 outfile .write ("protected_non_init_vars = ' '" , 2 )
@@ -1103,7 +1137,6 @@ def write_phys_read_subroutine(outfile, host_dict, host_vars, host_imports,
11031137 # Read in constituent data
11041138 outfile .comment ("Read in constituent variables if not using init variables" , 2 )
11051139 outfile .write ("field_data_ptr => cam_constituents_array()" , 2 )
1106- outfile .write ("const_props => cam_model_const_properties()" , 2 )
11071140 outfile .blank_line ()
11081141 outfile .comment ("Iterate over all registered constituents" , 2 )
11091142 outfile .write ("do constituent_idx = 1, size(const_props)" , 2 )
@@ -1138,7 +1171,7 @@ def write_phys_read_subroutine(outfile, host_dict, host_vars, host_imports,
11381171 outfile .write ("call const_props(constituent_idx)%minimum(constituent_min_value, constituent_errflg, constituent_errmsg)" , 5 )
11391172 outfile .write ("field_data_ptr(:,:,constituent_idx) = constituent_min_value" , 5 )
11401173 outfile .write ("if (masterproc) then" , 5 )
1141- outfile .write ("write(iulog,*) 'Constituent ', trim(std_name), ' default value not configured. Setting to 0.' " , 6 )
1174+ outfile .write ("write(iulog,*) 'Constituent ', trim(std_name), ' default value not configured. Setting to min value of ', constituent_min_value " , 6 )
11421175 outfile .write ("end if" , 5 )
11431176 outfile .write ("end if" , 4 )
11441177 outfile .write ("end if" , 3 )
@@ -1191,7 +1224,12 @@ def write_phys_check_subroutine(outfile, host_dict, host_vars, host_imports,
11911224 call_string_key = f"case ('{ var_stdname }
11921225
11931226 # Extract vertical level variable:
1194- levnm , call_check_field , reason = get_dimension_info (hvar )
1227+ levnm , call_check_field , reason , has_constituent_read = get_dimension_info (hvar )
1228+
1229+ # If this is a constituent-indexed field, do not check it for now.
1230+ if has_constituent_read :
1231+ continue
1232+ # end if
11951233
11961234 # Set "check_field" call string:
11971235 if call_check_field :
0 commit comments