From 76264702b3c5e07e294adbc5f7d5b29b4d874ce5 Mon Sep 17 00:00:00 2001 From: Tammas Loughran Date: Fri, 14 Jul 2023 13:26:29 +1000 Subject: [PATCH] Removed some redundant entries from namelist documentation and added some more descriptions. --- .../docs/user_guide/inputs/cable_nml.md | 49 +++++++++---------- 1 file changed, 23 insertions(+), 26 deletions(-) diff --git a/documentation/docs/user_guide/inputs/cable_nml.md b/documentation/docs/user_guide/inputs/cable_nml.md index 71343bee3..45d871ffd 100644 --- a/documentation/docs/user_guide/inputs/cable_nml.md +++ b/documentation/docs/user_guide/inputs/cable_nml.md @@ -115,7 +115,7 @@ applications. The following are annotated examples of cable.nml: | output%veg | logical | .TRUE. .FALSE. | .FALSE. | Output vegetation states when .TRUE. | | output%params | logical | .TRUE. .FALSE. | .FALSE. | Output the input parameters used to produce run then .TRUE. | | output%balances | logical | .TRUE. .FALSE. | .FALSE. | Output energy and water balances when .TRUE. | -| output%grid | character(len=7) | 'default' 'land' 'mask' 'ALMA' | 'default' | Output grid convention. `land` outputs land-only points, `'mask'` outputs masked spatial grids. `'ALMA'` uses the Assistance for Land-surface Modelling Activities convention. `'default'` uses the whichever convention the input meteorological file is using. | +| output%grid | character(len=7) | 'default' 'land' 'mask' 'ALMA' | 'default' | Output grid convention. `'land'` outputs land-only points, `'mask'` outputs masked spatial grids. `'ALMA'` uses the Assistance for Land-surface Modelling Activities convention. `'default'` uses the whichever convention the input meteorological file is using. | | output%averaging | character(len=7) | 'all' 'daily' 'monthly' 'user6' | 'all' | Output averaging. | | check%ranges | logical | .TRUE. .FALSE. | uninitialised | Check input and output variables against valid ranges | | check%energy_bal | logical | .TRUE. .FALSE. | uninitialised | Check the energy balance | @@ -162,44 +162,41 @@ applications. The following are annotated examples of cable.nml: | cable_user%GS_SWITCH | character(len=20) | 'medlyn' 'leuning' | 'medlyn' | Stomatal conductance model. | | cable_user%l_revised_coupling | logical | .TRUE. .FALSE. | .FALSE. | Revised coupling on implicit step of ACCESS-CM2. | | cable_user%l_rev_corr | logical | .TRUE. .FALSE. | .FALSE. | Apply revised sensitvity/correction terms to soilsnow energy balance. | -| cable_user%soil_thermal_fix | logical | .TRUE. .FALSE. | .FALSE. | Snow capping depth? | +| cable_user%soil_thermal_fix | logical | .TRUE. .FALSE. | .FALSE. | Use alternative soil conductivity implementation. | | cable_user%phenology_switch | character(len=20) | 'MODIS' 'climate' | 'MODIS' | Use prescribed MODIS phenology or climate dependant phenology. | | cable_user%RunIden | character(len=10) | any string of max. 10 characters | 'STANDARD' | Run identifier string for input/output files. | | cable_user%MetType | character(len=6) | '' 'gswp' 'gswp3' 'gpgs' 'plum' 'cru' 'site' 'bios' | ' ' | Type of input meteorological data. | | cable_user%soil_struc | character(len=20) | 'default' 'sli' | 'default' | Use default or soil-litter-iso soil model. | -| cable_user%POP_out | character(len=3) | 'epi' 'rst' 'ini' | 'rst' | POP restart file type. `epi` is end of year state `'rst'` is a standard restart file, `'ini'` is an initialisation restart file. | -| cable_user%POP_rst | character(len=50) | any string of max. 50 characters | ' ' | POP restart file directory. | -| cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | CASA output frequency | -| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | ? | -| cable_user%POPLUC_RunType | character(len=10) | 'static' 'init' 'restart' | 'static' | ? | -| cable_user%call_pop | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%POP_fromZero | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%call_climate | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%climate_fromzero | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%CASA_fromzero | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%POPLUC | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%POP_out | character(len=3) | 'epi' 'rst' 'ini' | 'rst' | POP restart file type. `'epi'` is end of year state `'rst'` is a standard restart file, `'ini'` is an initialisation restart file. | +| cable_user%POP_rst | character(len=50) | any string of max. 50 characters | ' ' | POP restart file directory. | +| cable_user%casa_out_freq | character(len=8) | 'daily' 'monthly' 'annually' | 'annually' | CASA output frequency. | +| cable_user%vcmax | character(len=10) | 'standard' 'Walker2014' | 'standard' | Alternative functional form of $V_{cmax}$ (maximum RuBP carboxylation rate). For `'Walker2014'` see https://doi.org/10.1002/ece3.1173 . | +| cable_user%POPLUC_RunType | character(len=10) | 'static' 'init' 'restart' | 'static' | Type of POP-LUC run. `'init'` is initial POP-LUC run, `'restart'` is a restart run, `'static'` disables dynamic vegetation and sets `cable_user%POPLUC = .FALSE.`.| +| cable_user%call_pop | logical | .TRUE. .FALSE. | .FALSE., | Enable POP. | +| cable_user%POP_fromZero | logical | .TRUE. .FALSE. | .FALSE., | Run POP initialisation. | +| cable_user%call_climate | logical | .TRUE. .FALSE. | .FALSE., | Track climate variables for use in phenology and potential plant functional type modules. | +| cable_user%climate_fromzero | logical | .TRUE. .FALSE. | .FALSE., | Initialise climate variables with 0. | +| cable_user%CASA_fromzero | logical | .TRUE. .FALSE. | .FALSE., | Initialize CASA from 0 without restart files. | +| cable_user%POPLUC | logical | .TRUE. .FALSE. | .FALSE., | Enable POP-LUC. | | cable_user%casa_spin_startyear | integer | any integer | 1950 | CASA spinup start year. | | cable_user%casa_spin_endyear | integer | any integer | 1960 | CASA spinup end year. | -| cable_user%yearstart | integer | any integer | 0 | ? | -| cable_user%yearend | integer | any integer | 0 | ? | -| cable_user%casa_nrep | integer | any integer | 1 | ? | -| cable_user%smrf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil Moist Respiration Function. | -| cable_user%strf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil Temp Respiration Function. | -| cable_user%initialize_mapping | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%cable_runtime_coupled | logical | .TRUE. .FALSE. | .TRUE., | ? | +| cable_user%yearstart | integer | any integer | 0 | Start year of run. | +| cable_user%yearend | integer | any integer | 0 | End year of run. | +| cable_user%casa_nrep | integer | any integer | 1 | Number of repetitions of CASA spinup. | +| cable_user%smrf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil moisture respiration function. | +| cable_user%strf_name | character(len=10) | 'CASA-CNP' 'SOILN' 'TRIFFID' | uninitialised | Soil temperature respiration function. | | cable_user%LogWorker | logical | .TRUE. .FALSE. | .TRUE., | Write output of each worker | -| cable_user%l_new_roughness_soil | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%l_new_runoff_speed | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%l_new_reduce_soilevp | logical | .TRUE. .FALSE. | .FALSE., | ? | +| cable_user%l_new_roughness_soil | logical | .TRUE. .FALSE. | .FALSE., | Use alternative roughness and flux resistance scheme. | +| cable_user%l_new_runoff_speed | logical | .TRUE. .FALSE. | .FALSE., | Use alternative soil water drainage scheme. | +| cable_user%l_new_reduce_soilevp | logical | .TRUE. .FALSE. | .FALSE., | Use alternative soil evaporation scheme. | | cable_user%srf | logical | .TRUE. .FALSE. | .FALSE., | Switch for customized soil respiration | | cable_user%litter | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%gw_model | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%alt_forcing | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%gswp3 | logical | .TRUE. .FALSE. | .FALSE., | Use GSWP3 forcing. | | cable_user%or_evap | logical | .TRUE. .FALSE. | .FALSE., | ? | | cable_user%test_new_gw | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%sync_nc_file | logical | .TRUE. .FALSE. | .FALSE., | ? | -| cable_user%max_spins | integer | any integer | 1 | Maximum number of iterations for a spinup. CABLE will act as if convergence has been reached after max_spins iterations even if it was not reached. | +| cable_user%sync_nc_file | logical | .TRUE. .FALSE. | .FALSE., | Write netCDF output to file without closing during run. | +| cable_user%max_spins | integer | any integer | 1 | Maximum number of iterations for a spinup. CABLE will act as if convergence has been reached after max_spins iterations even if it was not reached. | | cable_user%fix_access_roots | logical | .TRUE. .FALSE. | .FALSE., | Use pft dependent roots in ACCESS | | cable_user%access13roots | logical | .TRUE. .FALSE. | .FALSE., | Switch to use ACCESS1.3 %froot. | | cable_user%l_limit_labile | logical | .TRUE. .FALSE. | .FALSE., | Limit Labile in spinup |