Skip to content

Commit

Permalink
updates for doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mvertens committed Jul 26, 2020
1 parent ca489f1 commit 6cf32f3
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 99 deletions.
9 changes: 0 additions & 9 deletions doc/source/addendum/req_attributes.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ Scalar attributes
-----------------

**ScalarFieldCount**

The maximum number of scalars that are going to be communicated
between the mediator and a component. Currently scalar values are
put into a field bundle that only contains an undistributed
Expand All @@ -39,11 +38,9 @@ Scalar attributes
component.

**ScalarFieldName** (required)

This is the name of the scalar field bundle. By default it is ``cpl_scalars``.

**ScalarFieldIdxGridNX**, **ScalarFieldIdxGridNY** (required)

The global number of longitude and latitude points. For unstructured grids::

ScalarFieldIdxGridNY = 1
Expand All @@ -53,7 +50,6 @@ Scalar attributes
is needed by the mediator for the history output.

**ScalarFieldIdxNextSwCday** (optional)

Send by the atmosphere component to specify the calendar day of its
next short wave computation. This is subsequently used by other
components (e.g. cesm-land and sea-ice) in determining the zenith
Expand All @@ -65,13 +61,8 @@ Mediator history and restart attributes
---------------------------------------

**history_option**, **history_n** (required)

Determines the write frequency for a mediator history file (see :ref:`mediator history writes<history_writes>`).

**restart_option**, **restart_n** (required)

Determines the write frequency for a mediator restart file (see :ref:`mediator restart writes<restart_writes>`).

**read_restart** (required)

Determines if a mediator restart file is read in.
129 changes: 39 additions & 90 deletions doc/source/addendum/req_attributes_cesm.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,17 @@ The following *additional* attributes are required for CESM model applications.
General
--------------

**diro**, **logfile** (required)

**diro**, **logfile**
Specifies the full pathname of the directory and filename of the directory and file name for mediator log output.
For CESM this is determine in the attribute group ``MED_modelio`` that is generated by the CIME case control system.

**flds_i2o_per_cat**

if true, select per ice thickness category fields are passed to the ocean.

Toggle for active compoenents
-----------------------------

**ATM_model**, **GLC_model**, **ICE_model**, **LND_model**, **ROF_model**, **OCN_model**, **WAV_model**

In CESM, stub components are still used. These attributes determine if the component is a stub component and sets the
mediator present flag for that component to ``false``.

Expand All @@ -31,118 +28,76 @@ Mediator Mapping file attributes

If a mapping file value is set to ``unset``, then CMEPS will create an online route handle instead.

**ice2atm_fmapname**, **ice2atm_smapname** (required)

ice -> atmosphere fluxes and state mapping files

**lnd2atm_fmapname**, **lnd2atm_smapname** (required)

land -> atmosphere fluxes and state mapping files

**ocn2atm_smapname**, **ocn2atm_fmapname** (required)

ocean -> atmosphere fluxes and state mapping files

**atm2lnd_fmapname**, **atm2lnd_smapname** (required)

ocean -> atmosphere fluxes and state mapping files

**atm2ice_fmapname**, **atm2ice_smapname**, **atm2ice_vmapname** (required)

**ice2atm_fmapname**, **ice2atm_smapname**
ice -> atm fluxes and state mapping files
**lnd2atm_fmapname**, **lnd2atm_smapname**
land -> atm fluxes and state mapping files
**ocn2atm_smapname**, **ocn2atm_fmapname**
ocean -> atm fluxes and state mapping files
**atm2lnd_fmapname**, **atm2lnd_smapname**
atm -> land fluxes and state mapping files
**atm2ice_fmapname**, **atm2ice_smapname**, **atm2ice_vmapname**
atmosphere -> sea-ice fluxes, state, and velocities

**atm2ocn_fmapname**, **atm2ocn_smapname**, **atm2ocn_vmapname** (required)

**atm2ocn_fmapname**, **atm2ocn_smapname**, **atm2ocn_vmapname**
atmosphere -> ocean fluxes, state, and velocities

**rof2lnd_fmapname** (required)

**rof2lnd_fmapname**
river -> land flux mapping file

**glc2lnd_fmapname**, **glc2lnd_smapname** (required)

**glc2lnd_fmapname**, **glc2lnd_smapname**
land-ice -> land fluxes and state mapping files

**glc2ice_rmapname** (required)

**glc2ocn_liq_rmapname**, **glc2ocn_ice_rmapname** (required)

land-ice -> ocean liquid and ice mapping files

*rof2ocn_liq_rmapname**, **rof2ocn_ice_rmapname** (required)

river -> ocean liquid and ice mapping file

**wav2ocn_smapname** (required)

**glc2ice_rmapname**
"smoothed" land-ice -> sea-ice liquid mapping file
**glc2ocn_liq_rmapname**, **glc2ocn_ice_rmapname**
"smoothed" land-ice -> ocean liquid and ice mapping files
**rof2ocn_liq_rmapname**, **rof2ocn_ice_rmapname**
"smoothed" river -> ocean liquid and ice mapping file
**wav2ocn_smapname**
wave -> ocean state mapping file

**lnd2rof_fmapname** (required)

**lnd2rof_fmapname**
land -> river flux mapping file

**lnd2glc_fmapname**, **lnd2glc_smapname** (required)

**lnd2glc_fmapname**, **lnd2glc_smapname**
land -> land-ice flux and state mapping file

**atm2wav_smapname**, **ice2wav_smapname**, **ocn2wav_smapname** (required)

**atm2wav_smapname**, **ice2wav_smapname**, **ocn2wav_smapname**
atmosphere -> wave, ice -> wave and ocean -> wave state mapping files

**mapuv_with_cart3d** (required)

**mapuv_with_cart3d**
used for atm->ocn and atm-ice mapping of u and v

if true, rotate u,v to 3d cartesian space, map from src->dest, then rotate back

Mediator ocean albedo attributes
--------------------------------

The following are used by CMEPS to calculate ocean albedoes in used in ``med_phases_ocnalb_mod.F90``

**start_type** (required)

**start_type**
Determines if start type of the run. The currently supported values are ``startup``, ``continue`` and ``branch``.
**orb_mode**
orbital model setting configured. The supported values are::

**orb_mode** (required)

orbital model setting configured

``fixed_year`` uses the orb_iyear and other orb inputs are ignored. In
this mode, the orbital parameters are constant and based on the year.
fixed_year: uses the orb_iyear and other orb inputs are ignored. In
this mode, the orbital parameters are constant and based on the year.

``variable_year`` uses the orb_iyear and orb_iyear_align. In this mode,
the orbital parameters vary as the model year advances and the model
year orb_iyear_align has the equivalent orbital year of orb_iyear.
variable_year: uses the orb_iyear and orb_iyear_align. In this mode,
the orbital parameters vary as the model year advances and the model
year orb_iyear_align has the equivalent orbital year of orb_iyear.

``fixed_parameters`` uses the orb_eccen, orb_mvelp, and orb_obliq to set
the orbital parameters which then remain constant through the model integration

**orb_iyear** (required)
fixed_parameters: uses the orb_eccen, orb_mvelp, and orb_obliq to set
the orbital parameters which then remain constant through the model integration

**orb_iyear**
year of orbit, used when orb_mode is fixed_year or variable_year

**orb_iyear_align** (required)

**orb_iyear_align**
model year associated with orb_iyear when orb_mode is variable_year

**orb_obliq** (required)

**orb_obliq**
obliquity of orbit in degrees, used when orb_mode is fixed_parameters

**orb_eccen** (required)

**orb_eccen**
eccentricity of orbit, used when orb_mode is fixed_parameters.

**orb_mvelp** (required)

**orb_mvelp**
location of vernal equinox in longitude degrees, used when orb_mode is fixed_parameters

Mediator land-ice component attribtes
-------------------------------------

**glc_renormalize_smb**

Whether to renormalize the surface mass balance (smb) sent from lnd to glc so that the
global integral on the glc grid agrees with the global integral on the lnd grid.

Expand All @@ -151,7 +106,6 @@ Mediator land-ice component attribtes
cases, since we often run glc as a diagnostic (one-way-coupled) component.

Allowable values are:

``on``: always do this renormalization

``off``: never do this renormalization (see WARNING below)
Expand All @@ -162,24 +116,19 @@ Mediator land-ice component attribtes
Does NOT do the renormalization if we're running a one-way-coupled glc, or if
we're running a glc-only compset (T compsets).
(In these cases, conservation is not important.)

Only used if running with a prognostic GLC component.
WARNING: Setting this to 'off' will break conservation when running with an
evolving, two-way-coupled glc.

**glc_avg_period**

Period at which coupler averages fields sent to GLC (the land-ice component).

This supports doing the averaging to GLC less frequently than GLC is called
(i.e., separating the averaging frequency from the calling frequency).
This is useful because there are benefits to only averaging the GLC inputs
as frequently as they are really needed (yearly for CISM), but GLC needs to
still be called more frequently than that in order to support mid-year restarts.

Setting glc_avg_period to 'glc_coupling_period' means that the averaging is
done exactly when the GLC is called (governed by GLC_NCPL).

**glc_cpl_dt**

glc coupling interval in seconds

0 comments on commit 6cf32f3

Please sign in to comment.