Skip to content

Commit

Permalink
Fixing malformatted metadata tables, correcting units and rank inform…
Browse files Browse the repository at this point in the history 
…ation in metadata tables
  • Loading branch information
@DomHeinzeller
DomHeinzeller committed Jan 3, 2018
1 parent d197652 commit 0851e00
Show file tree
Hide file tree
Showing 25 changed files with 439 additions and 434 deletions.
2 changes: 1 addition & 1 deletion physics/GFS_DCNV_generic.f90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ end subroutine GFS_DCNV_generic_post_finalize
!! | Model | FV3-GFS_Control_type | Fortran DDT containing FV3-GFS model control parameters | DDT | 0 | GFS_typedefs%GFS_control_type | | in | F |
!! | Stateout | FV3-GFS_Stateout_type | Fortran DDT containing FV3-GFS prognostic state to return to dycore | DDT | 0 | GFS_typedefs%GFS_stateout_type| | in | F |
!! | frain | dynamics_to_physics_timestep_ratio | ratio of dynamics timestep to physics timestep | none | 0 | real | kind_phys | in | F |
!! | rain1 | rainfall_amount_on_dynamics_timestep | convective rainfall amount on dynamics timestep | m | 1 | real | kind_phys | in | F |
!! | rain1 | rainfall_amount_on_physics_timestep | convective rainfall amount on physics timestep | m | 1 | real | kind_phys | in | F |
!! | cld1d | cloud_work_function | cloud work function | m2 s-2 | 1 | real | kind_phys | in | F |
!! | save_u | x_wind_save | x-wind before entering a physics scheme | m s-1 | 2 | real | kind_phys | in | F |
!! | save_v | y_wind_save | y-wind before entering a physics scheme | m s-1 | 2 | real | kind_phys | in | F |
Expand Down
50 changes: 25 additions & 25 deletions physics/GFS_MP_generic_post.f90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,35 +11,35 @@ module GFS_MP_generic_post

!> \defgroup GFS_MP_generic_post GFS MP generic post
!! @{
!!\section arg_table_GFS_MP_generic_post_init Argument Table
!! \section arg_table_GFS_MP_generic_post_init Argument Table
!!
subroutine GFS_MP_generic_post_init
end subroutine GFS_MP_generic_post_init


!!\section arg_table_GFS_MP_generic_post_run Argument Table
!!| local var name | longname | description | units | rank | type | kind | intent | optional |
!!|----------------|------------------------------------------------------------|----------------------------------------------------------------|-------------|------|---------|-----------|--------|----------|
!!| im | horizontal_loop_extent | horizontal loop extent, start at 1 | index | 0 | integer | | in | F |
!!| ix | horizontal_dimension | horizontal dimension | index | 0 | integer | | in | F |
!!| levs | vertical_dimension | vertical layer dimension | index | 0 | integer | | in | F |
!!| dtf | time_step_for_dynamics | dynamics time step | s | 0 | real | kind_phys | in | F |
!!| del | air_pressure_difference_between_midlayers | air pressure difference between midlayers | Pa | 2 | real | kind_phys | in | F |
!!| lssav | flag_diagnostics | logical flag for model physics diagnostics | flag | 0 | logical | | in | F |
!!| ldiag3d | flag_diagnostics_3D | logical flag for 3D diagnostics | flag | 0 | logical | | in | F |
!!| rain | timestep_total_rainfall_amount | total precipitation at surface (APCP) | m | 1 | real | kind_phys | in | F |
!!| frain | dynamics_to_physics_timestep_ratio | dtf/dtp, dynamics to physics timestep ratio | none | 0 | real | kind_phys | in | F |
!!| ntcw | index_for_liquid_cloud_condensate | cloud condensate index in tracer array(3) | index | 0 | integer | | in | F |
!!| ncld | number_of_hydrometeors | number_of_hydrometeors(1 for Z-C) | none | 0 | integer | | in | F |
!!| cwm | cloud_condensed_water_specific_humidity_updated_by_physics | cloud condensed water specific humidity | kg kg-1 | 2 | real | kind_phys | in | F |
!!| t | air_temperature_updated_by_physics | layer mean air temperature | K | 2 | real | kind_phys | in | F |
!!| q | water_vapor_specific_humidity_updated_by_physics | water vapor specific humidity | kg kg-1 | 2 | real | kind_phys | in | F |
!!| save_t | air_temperature_save | air temperature before entering a physics scheme | K | 2 | real | kind_phys | in | F |
!!| save_qv | water_vapor_specific_humidity_save | water vapor specific humidity before entering a physics scheme | kg kg-1 | 2 | real | kind_phys | in | F |
!!| totprcp | precipitation_rate_at_surface | precipitation rate at surface | kg m-2 s-1 | 1 | real | kind_phys | inout | F |
!!| dt3dt6 | large_scale_condensate_heating_rate_at_model_layers | large scale condensate heating rate at model layers | K s-1 | 2 | real | kind_phys | inout | F |
!!| dq3dt4 | large_scale_condensate_moistening_rate_at_model_layers | large scale condensate moistening rate at model layers | kg kg-1 s-1 | 2 | real | kind_phys | inout | F |
!!| pwat | column_precipitable_water | column integrated precipitable water | kg m-2 | 1 | real | kind_phys | out | F |
!! \section arg_table_GFS_MP_generic_post_run Argument Table
!! | local var name | longname | description | units | rank | type | kind | intent | optional |
!! |----------------|------------------------------------------------------------|----------------------------------------------------------------|-------------|------|---------|-----------|--------|----------|
!! | im | horizontal_loop_extent | horizontal loop extent, start at 1 | index | 0 | integer | | in | F |
!! | ix | horizontal_dimension | horizontal dimension | index | 0 | integer | | in | F |
!! | levs | vertical_dimension | vertical layer dimension | index | 0 | integer | | in | F |
!! | dtf | time_step_for_dynamics | dynamics time step | s | 0 | real | kind_phys | in | F |
!! | del | air_pressure_difference_between_midlayers | air pressure difference between midlayers | Pa | 2 | real | kind_phys | in | F |
!! | lssav | flag_diagnostics | logical flag for model physics diagnostics | flag | 0 | logical | | in | F |
!! | ldiag3d | flag_diagnostics_3D | logical flag for 3D diagnostics | flag | 0 | logical | | in | F |
!! | rain | timestep_total_rainfall_amount | total precipitation at surface (APCP) | m | 1 | real | kind_phys | in | F |
!! | frain | dynamics_to_physics_timestep_ratio | dtf/dtp, dynamics to physics timestep ratio | none | 0 | real | kind_phys | in | F |
!! | ntcw | index_for_liquid_cloud_condensate | cloud condensate index in tracer array(3) | index | 0 | integer | | in | F |
!! | ncld | number_of_hydrometeors | number_of_hydrometeors(1 for Z-C) | count | 0 | integer | | in | F |
!! | cwm | cloud_condensed_water_specific_humidity_updated_by_physics | cloud condensed water specific humidity | kg kg-1 | 2 | real | kind_phys | in | F |
!! | t | air_temperature_updated_by_physics | layer mean air temperature | K | 2 | real | kind_phys | in | F |
!! | q | water_vapor_specific_humidity_updated_by_physics | water vapor specific humidity | kg kg-1 | 2 | real | kind_phys | in | F |
!! | save_t | air_temperature_save | air temperature before entering a physics scheme | K | 2 | real | kind_phys | in | F |
!! | save_qv | water_vapor_specific_humidity_save | water vapor specific humidity before entering a physics scheme | kg kg-1 | 2 | real | kind_phys | in | F |
!! | totprcp | precipitation_rate_at_surface | precipitation rate at surface | kg m-2 s-1 | 1 | real | kind_phys | inout | F |
!! | dt3dt6 | large_scale_condensate_heating_rate_at_model_layers | large scale condensate heating rate at model layers | K s-1 | 2 | real | kind_phys | inout | F |
!! | dq3dt4 | large_scale_condensate_moistening_rate_at_model_layers | large scale condensate moistening rate at model layers | kg kg-1 s-1 | 2 | real | kind_phys | inout | F |
!! | pwat | column_precipitable_water | column integrated precipitable water | kg m-2 | 1 | real | kind_phys | out | F |
!!
subroutine GFS_MP_generic_post_run(im, ix, levs,dtf,del, &
lssav,ldiag3d,rain,frain,ntcw,ncld,cwm, & !input
Expand Down Expand Up @@ -112,7 +112,7 @@ subroutine GFS_MP_generic_post_run(im, ix, levs,dtf,del, &

end subroutine GFS_MP_generic_post_run

!!\setction arg_table_GFS_MP_generic_post_finalize Argument Table
!! \section arg_table_GFS_MP_generic_post_finalize Argument Table
!!
subroutine GFS_MP_generic_post_finalize
end subroutine GFS_MP_generic_post_finalize
Expand Down
40 changes: 20 additions & 20 deletions physics/GFS_MP_generic_pre.f90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,29 @@ module GFS_MP_generic_pre

!> \defgroup GFS_MP_generic_pre GFS MP generic pre
!! @{
!!\section arg_table_GFS_MP_generic_pre_init Argument Table
!! \section arg_table_GFS_MP_generic_pre_init Argument Table
!!
subroutine GFS_MP_generic_pre_init
subroutine GFS_MP_generic_pre_init
end subroutine GFS_MP_generic_pre_init


!!\section arg_table_GFS_MP_generic_pre_run Argument Table
!!| local var name | longname |description | units | rank | type | kind | intent | optional |
!!|----------------|------------------------------------------------------------|--------------------------------------------------------------------------|-------------|------|---------|-----------|--------|----------|
!!| im | horizontal_loop_extent | horizontal loop extent, start at 1 | index | 0 | integer | | in | F |
!!| ix | horizontal_dimension | horizontal dimension | index | 0 | integer | | in | F |
!!| levs | vertical_dimension | vertical layer dimension | index | 0 | integer | | in | F |
!!| clw1 | cloud_ice_specific_humidity | cloud ice specific humidity | kg kg-1 | 2 | real | kind_phys | in | F |
!!| clw2 | cloud_liquid_water_specific_humidity | cloud water specific humidity | kg kg-1 | 2 | real | kind_phys | in | F |
!!| ldiag3d | flag_diagnostics_3D | logical flag for 3D diagnostics | flag | 0 | logical | | in | F |
!!| ntcw | index_for_liquid_cloud_condensate | cloud condensate index in tracer array(3) | none | 0 | integer | | in | F |
!!| ncld | number_of_hydrometeors | number of hydrometeors(1 for Z-C) | none | 0 | integer | | in | F |
!!| num_p3d | array_dimension_of_microphysics | number of 3D arrays needed for microphysics | none | 0 | integer | | in | F |
!!| t | air_temperature_updated_by_physics | layer mean air temperature | K | 2 | real | kind_phys | in | F |
!!| q | water_vapor_specific_humidity_updated_by_physics | water vapor specific humidity | kg kg-1 | 2 | real | kind_phys | in | F |
!!| save_t | air_temperature_save | air temperature before entering a physics scheme | K | 2 | real | kind_phys | out | F |
!!| save_qv | water_vapor_specific_humidity_save | water vapor specific humidity before entering a physics scheme | kg kg-1 | 2 | real | kind_phys | out | F |
!!| save_qcw | cloud_condensed_water_specific_humidity_save | cloud condensed water specific humidity before entering a physics scheme | kg kg-1 | 2 | real | kind_phys | out | F |
!> \section arg_table_GFS_MP_generic_pre_run Argument Table
!! | local var name | longname |description | units | rank | type | kind | intent | optional |
!! |----------------|------------------------------------------------------------|--------------------------------------------------------------------------|-------------|------|---------|-----------|--------|----------|
!! | im | horizontal_loop_extent | horizontal loop extent, start at 1 | index | 0 | integer | | in | F |
!! | ix | horizontal_dimension | horizontal dimension | index | 0 | integer | | in | F |
!! | levs | vertical_dimension | vertical layer dimension | index | 0 | integer | | in | F |
!! | clw1 | cloud_ice_specific_humidity | cloud ice specific humidity | kg kg-1 | 2 | real | kind_phys | in | F |
!! | clw2 | cloud_liquid_water_specific_humidity | cloud water specific humidity | kg kg-1 | 2 | real | kind_phys | in | F |
!! | ldiag3d | flag_diagnostics_3D | logical flag for 3D diagnostics | flag | 0 | logical | | in | F |
!! | ntcw | index_for_liquid_cloud_condensate | cloud condensate index in tracer array(3) | index | 0 | integer | | in | F |
!! | ncld | number_of_hydrometeors | number of hydrometeors(1 for Z-C) | count | 0 | integer | | in | F |
!! | num_p3d | array_dimension_of_microphysics | number of 3D arrays needed for microphysics | count | 0 | integer | | in | F |
!! | t | air_temperature_updated_by_physics | layer mean air temperature | K | 2 | real | kind_phys | in | F |
!! | q | water_vapor_specific_humidity_updated_by_physics | water vapor specific humidity | kg kg-1 | 2 | real | kind_phys | in | F |
!! | save_t | air_temperature_save | air temperature before entering a physics scheme | K | 2 | real | kind_phys | out | F |
!! | save_qv | water_vapor_specific_humidity_save | water vapor specific humidity before entering a physics scheme | kg kg-1 | 2 | real | kind_phys | out | F |
!! | save_qcw | cloud_condensed_water_specific_humidity_save | cloud condensed water specific humidity before entering a physics scheme | kg kg-1 | 2 | real | kind_phys | out | F |
!!
subroutine GFS_MP_generic_pre_run(im, ix, levs, clw1, clw2, &
ldiag3d, ntcw, ncld, num_p3d, t, q, & !input
Expand Down Expand Up @@ -75,7 +75,7 @@ subroutine GFS_MP_generic_pre_run(im, ix, levs, clw1, clw2, &

end subroutine GFS_MP_generic_pre_run

!!\setction arg_table_GFS_MP_generic_pre_finalize Argument Table
!> \section arg_table_GFS_MP_generic_pre_finalize Argument Table
!!
subroutine GFS_MP_generic_pre_finalize
end subroutine GFS_MP_generic_pre_finalize
Expand Down
Loading

0 comments on commit 0851e00

Please sign in to comment.