Add optional metadata field for dynamic constituent routine #13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@nusbaume currently, the only way to determine if a constituent is moist/dry and what type of mixing ratio it is is by parsing the standard name. Is this something we'll need to add setters for for MICM? |
|
@peverwhee Thanks for doing this! In terms of your moist/dry question I think that is worth a discussion, so I've added it to our Wednesday meeting (and after we come up with our preferred method we'll probably need to at least run it by NOAA in the Monday meeting as well). |
nusbaume
requested changes
Feb 19, 2024
|
Updated generated code with new error handling logic in place: subroutine test_host_ccpp_register_constituents(suite_list, host_constituents, &
dynamic_constituents , errflg, errmsg)
! Create constituent object for suites in
use ccpp_constituent_prop_mod, only: ccpp_constituent_properties_t
! Suite constituent interfaces
use ccpp_cld_suite_cap, only: cld_suite_constituents_num_consts
use ccpp_cld_suite_cap, only: cld_suite_constituents_const_name
use ccpp_cld_suite_cap, only: cld_suite_constituents_copy_const
! Dynamic constituent routines
use cld_liq, only: cld_liq_dynamic_constituents
use cld_ice, only: cld_ice_dynamic_constituents
! Dummy arguments
character(len=*), intent(in) :: suite_list(:)
type(ccpp_constituent_properties_t), target, intent(in) :: host_constituents(:)
type(ccpp_constituent_properties_t), allocatable, target, intent(inout) :: &
dynamic_constituents(:)
character(len=512), intent(out) :: errmsg ! ccpp_error_message
integer, intent(out) :: errflg ! ccpp_error_code
! Local variables
integer :: num_suite_consts
integer :: num_consts
integer :: num_dyn_consts
integer :: index, index_start
integer :: field_ind
type(ccpp_constituent_properties_t), pointer :: const_prop
! dynamic constituent props variable for cld_ice
type(ccpp_constituent_properties_t), allocatable, target :: dyn_const_prop_0(:)
! dynamic constituent props variable for cld_liq
type(ccpp_constituent_properties_t), allocatable, target :: dyn_const_prop_1(:)
errflg = 0
num_consts = size(host_constituents, 1)
num_dyn_consts = 0
! Number of suite constants for cld_suite
num_suite_consts = cld_suite_constituents_num_consts(errflg=errflg, errmsg=errmsg)
if (errflg /= 0) then
return
end if
num_consts = num_consts + num_suite_consts
! Add in dynamic constituents
call cld_ice_dynamic_constituents(dyn_const_prop_0, errcode=errflg, errmsg=errmsg)
if (errflg /= 0) then
return
end if
num_dyn_consts = num_dyn_consts + size(dyn_const_prop_0)
call cld_liq_dynamic_constituents(dyn_const_prop_1, errcode=errflg, errmsg=errmsg)
if (errflg /= 0) then
return
end if
num_dyn_consts = num_dyn_consts + size(dyn_const_prop_1)
num_consts = num_consts + num_dyn_consts
! Pack dynamic_constituents array
allocate(dynamic_constituents(num_dyn_consts), stat=errflg)
if (errflg /= 0) then
errmsg = 'failed to allocate dynamic_constituents'
return
end if
index_start = 0
do index = 1, size(dyn_const_prop_0, 1)
dynamic_constituents(index + index_start) = dyn_const_prop_0(index)
end do
index_start = size(dyn_const_prop_0, 1)
deallocate(dyn_const_prop_0)
do index = 1, size(dyn_const_prop_1, 1)
dynamic_constituents(index + index_start) = dyn_const_prop_1(index)
end do
index_start = size(dyn_const_prop_1, 1)
deallocate(dyn_const_prop_1)
! Initialize constituent data and field object
call test_host_constituents_obj%initialize_table(num_consts)
! Add host model constituent metadata
do index = 1, size(host_constituents, 1)
const_prop => host_constituents(index)
call test_host_constituents_obj%new_field(const_prop, errcode=errflg, errmsg=errmsg)
nullify(const_prop)
if (errflg /= 0) then
return
end if
end do
! Add dynamic constituent properties
do index = 1, size(dynamic_constituents, 1)
const_prop => dynamic_constituents(index)
call test_host_constituents_obj%new_field(const_prop, errcode=errflg, errmsg=errmsg)
nullify(const_prop)
if (errflg /= 0) then
return
end if
end do
! Add cld_suite constituent metadata
num_suite_consts = cld_suite_constituents_num_consts(errflg=errflg, errmsg=errmsg)
if (errflg /= 0) then
return
end if
do index = 1, num_suite_consts
allocate(const_prop, stat=errflg)
if (errflg /= 0) then
errmsg = "ERROR allocating const_prop"
return
end if
call cld_suite_constituents_copy_const(index, const_prop, errflg=errflg, errmsg=errmsg)
if (errflg /= 0) then
return
end if
call test_host_constituents_obj%new_field(const_prop, errcode=errflg, errmsg=errmsg)
nullify(const_prop)
if (errflg /= 0) then
return
end if
end do
call test_host_constituents_obj%lock_table(errcode=errflg, errmsg=errmsg)
if (errflg /= 0) then
return
end if
! Set the index for each active constituent
do index = 1, SIZE(test_host_model_const_indices)
call test_host_constituents_obj%const_index(field_ind, &
test_host_model_const_stdnames(index), errcode=errflg, errmsg=errmsg)
if (errflg /= 0) then
return
end if
if (field_ind > 0) then
test_host_model_const_indices(index) = field_ind
else
errflg = 1
errmsg = 'No field index for '//trim(test_host_model_const_stdnames(index))
return
end if
end do
|
nusbaume
approved these changes
Mar 1, 2024
There was a problem hiding this comment.
Everything looks good to me now, thanks @peverwhee! I just had one last (completely optional) suggestion.
scripts/ccpp_datafile.py
Outdated
| 'banana' | ||
|
|
||
| # Test no table found (expect None) | ||
| >>> _find_var_dictionary(table, dict_name='apple') |
There was a problem hiding this comment.
Does this test still work if you explicitly write None as the answer? If so then I might do so just to make it clear that is what will be returned by the function.
There was a problem hiding this comment.
ooh i learned another thing today - doctests ignore Nones. Added an is None check (& expected result = True)
mwaxmonsky
approved these changes
Mar 1, 2024
There was a problem hiding this comment.
Great work @peverwhee! Just had one or two things that might be of interest but by no means any reason to hold this up. Thanks!
scripts/ccpp_capgen.py
Outdated
| routine_name = scheme_tdict[table].dyn_const_routine | ||
| if routine_name is not None: | ||
| if routine_name not in dyn_const_dict.values(): | ||
| dyn_const_dict[table] = scheme_tdict[table].dyn_const_routine |
There was a problem hiding this comment.
Suggested change
| dyn_const_dict[table] = scheme_tdict[table].dyn_const_routine | |
| dyn_const_dict[table] = routine_name |
scripts/ccpp_datafile.py
Outdated
Comment on lines
434
to
440
| for routine in routines: | ||
| routine_name = routine.text | ||
| if routine_name is not None: | ||
| result.add(routine_name) | ||
| # end if | ||
| # end for | ||
| return sorted(result) |
There was a problem hiding this comment.
Suggested change
| for routine in routines: | |
| routine_name = routine.text | |
| if routine_name is not None: | |
| result.add(routine_name) | |
| # end if | |
| # end for | |
| return sorted(result) | |
| routine_names = [routine.text for routine in routines if routine.text] | |
| return sorted(routine_names) |
Typically, list comprehensions are more optimized for generating lists but if the current code is more readable for everyone, please disregard!
Also, if we want to add the routine_name even if it is an empty string, this is perfectly fine. But if we want to exclude empty strings, we might want to change this to the check in the list comprehension if routine.text as empty strings are considered False.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR brings in the optional metadata header field
dynamic_constituent_routine, which specifies the name of a routine (contained within the module in question) that returns a run-time configurable array of constituent properties.Code Changes
Testing
Test added: Added dynamic constituents routines to both advection test schemes; added checks to confirm properties are accessible by host model; confirmed that the routines are written to the datatable xml file; confirmed that the values at the end of the run are still the default values (no operations done to the dynamic constituents in the test...)
User interface changes
User can now (optionally) specify a dynamic constituent routine in the header for a module's metadata file like:
User must also provide the (public) dynamic_constituent_routine within the .F90 file associated with the metadata file (in the above example: cld_liq.F90). The routine must include the following calling list (variable names may vary, of course):
And the routine must allocate dyn_const to the number of dynamic constituents for that scheme and then instantiate them as such:
Generated Code Snippet
The folllowing code is generated when a user specifies dynamic constituent routines for two schemes (bolded code is new with this PR)
subroutine test_host_ccpp_register_constituents(suite_list, host_constituents, & dynamic_constituents , errflg, errmsg) ! Create constituent object for suites in < suite_list > use ccpp_constituent_prop_mod, only: ccpp_constituent_properties_t ! Suite constituent interfaces use ccpp_cld_suite_cap, only: cld_suite_constituents_num_consts use ccpp_cld_suite_cap, only: cld_suite_constituents_const_name use ccpp_cld_suite_cap, only: cld_suite_constituents_copy_const ! Dynamic constituent routines use cld_liq, only: cld_liq_dynamic_constituents use cld_ice, only: cld_ice_dynamic_constituents ! Dummy arguments character(len=*), intent(in) :: suite_list(:) type(ccpp_constituent_properties_t), target, intent(in) :: host_constituents(:) type(ccpp_constituent_properties_t), allocatable, target, intent(inout) :: & dynamic_constituents(:) character(len=512), intent(out) :: errmsg ! ccpp_error_message integer, intent(out) :: errflg ! ccpp_error_code ! Local variables integer :: num_suite_consts integer :: num_consts integer :: num_dyn_consts integer :: index, index_start integer :: field_ind type(ccpp_constituent_properties_t), pointer :: const_prop ! dynamic constituent props variable for cld_ice type(ccpp_constituent_properties_t), allocatable, target :: dyn_const_prop_0(:) ! dynamic constituent props variable for cld_liq type(ccpp_constituent_properties_t), allocatable, target :: dyn_const_prop_1(:) errflg = 0 num_consts = size(host_constituents, 1) num_dyn_consts = 0 ! Number of suite constants for cld_suite num_suite_consts = cld_suite_constituents_num_consts(errflg=errflg, errmsg=errmsg) num_consts = num_consts + num_suite_consts ! Add in dynamic constituents if (errflg == 0) then call cld_ice_dynamic_constituents(dyn_const_prop_0, errcode=errflg, errmsg=errmsg) num_dyn_consts = num_dyn_consts + size(dyn_const_prop_0) end if if (errflg == 0) then call cld_liq_dynamic_constituents(dyn_const_prop_1, errcode=errflg, errmsg=errmsg) num_dyn_consts = num_dyn_consts + size(dyn_const_prop_1) end if num_consts = num_consts + num_dyn_consts ! Pack dynamic_constituents array allocate(dynamic_constituents(num_dyn_consts), stat=errflg) if (errflg /= 0) then errmsg = 'failed to allocate dynamic_constituents' else index_start = 1 do index = 1, size(dyn_const_prop_0, 1) dynamic_constituents(index + index_start - 1) = dyn_const_prop_0(index) end do index_start = size(dyn_const_prop_0, 1) + 1 deallocate(dyn_const_prop_0) do index = 1, size(dyn_const_prop_1, 1) dynamic_constituents(index + index_start - 1) = dyn_const_prop_1(index) end do index_start = size(dyn_const_prop_1, 1) + 1 deallocate(dyn_const_prop_1) end if if (errflg == 0) then ! Initialize constituent data and field object call test_host_constituents_obj%initialize_table(num_consts) ! Add host model constituent metadata do index = 1, size(host_constituents, 1) if (errflg == 0) then const_prop => host_constituents(index) call test_host_constituents_obj%new_field(const_prop, errcode=errflg, & errmsg=errmsg) end if nullify(const_prop) if (errflg /= 0) then exit end if end do end if ! Add dynamic constituent properties if (errflg == 0) then do index = 1, size(dynamic_constituents, 1) if (errflg == 0) then const_prop => dynamic_constituents(index) call test_host_constituents_obj%new_field(const_prop, errcode=errflg, & errmsg=errmsg) end if nullify(const_prop) if (errflg /= 0) then exit end if end do end if if (errflg == 0) then ! Add cld_suite constituent metadata num_suite_consts = cld_suite_constituents_num_consts(errflg=errflg, errmsg=errmsg) end if if (errflg == 0) then do index = 1, num_suite_consts if (errflg == 0) then allocate(const_prop, stat=errflg) end if if (errflg /= 0) then errmsg = "ERROR allocating const_prop" exit end if if (errflg == 0) then call cld_suite_constituents_copy_const(index, const_prop, errflg=errflg, & errmsg=errmsg) end if if (errflg == 0) then call test_host_constituents_obj%new_field(const_prop, errcode=errflg, & errmsg=errmsg) end if nullify(const_prop) if (errflg /= 0) then exit end if end do end if if (errflg == 0) then call test_host_constituents_obj%lock_table(errcode=errflg, errmsg=errmsg) end if if (errflg == 0) then ! Set the index for each active constituent do index = 1, SIZE(test_host_model_const_indices) call test_host_constituents_obj%const_index(field_ind, & test_host_model_const_stdnames(index), errcode=errflg, errmsg=errmsg) if (field_ind > 0) then test_host_model_const_indices(index) = field_ind else errflg = 1 errmsg = 'No field index for '//trim(test_host_model_const_stdnames(index)) end if if (errflg /= 0) then exit end if end do end if end subroutine test_host_ccpp_register_constituents