Skip to content

Commit

Permalink
Update descriptions of dcEdge and dvEdge
Browse files Browse the repository at this point in the history
The existing descriptions were not clear to developers.
  • Loading branch information
xylar committed May 13, 2024
1 parent 58238ce commit a4ea7f9
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
12 changes: 6 additions & 6 deletions components/mpas-albany-landice/src/Registry.xml
Original file line number Diff line number Diff line change
Expand Up @@ -234,11 +234,11 @@
/>
<nml_option name="config_grounded_von_Mises_threshold_stress_source" type="character" default_value="scalar" units="unitless"
description="Source of von MIses threshold stress value for calving from grounded ice."
possible_values="'data' (read from input file), 'scalar' (specified by config_grounded_von_Mises_threshold_stress)"
possible_values="'data' (read from input file), 'scalar' (specified by config_grounded_von_Mises_threshold_stress)"
/>
<nml_option name="config_floating_von_Mises_threshold_stress_source" type="character" default_value="scalar" units="unitless"
description="Source of von MIses threshold stress value for calving from floating ice."
possible_values="'data' (read from input file), 'scalar' (specified by config_floating_von_Mises_threshold_stress)"
possible_values="'data' (read from input file), 'scalar' (specified by config_floating_von_Mises_threshold_stress)"
/>
<nml_option name="config_finalize_damage_after_advection" type="logical" default_value=".true." units="unitless"
description="If true, then the 'li_finalize_damage_after_advection' subroutine is applied, doing the following: 1) set the value of damage at the grounding line based on the choice of 'config_damage_gl_setting', 2) reset the value of damage to its initial value (to avoid healing), based on choice of 'config_preserve_damage', 3) couple the updated damage value to the rheology if 'config_damage_rheology_coupling' is true."
Expand Down Expand Up @@ -1065,10 +1065,10 @@ is the value of that variable from the *previous* time level!
description="Reconstruction weights associated with each of the edgesOnEdge."
/>
<var name="dvEdge" type="real" dimensions="nEdges" units="m"
description="Length of each edge, computed as the distance between verticesOnEdge."
description="The great circle distance between vertices bordering a given edge. It is the length of the edge on the primal mesh."
/>
<var name="dcEdge" type="real" dimensions="nEdges" units="m"
description="Length of each edge, computed as the distance between cellsOnEdge."
description="The great circle distance between cell centers bordering a given edge. It is the length of the edge on the dual mesh."
/>
<var name="angleEdge" type="real" dimensions="nEdges" units="radians"
description="Angle the edge normal makes with local eastward direction."
Expand Down Expand Up @@ -1372,7 +1372,7 @@ is the value of that variable from the *previous* time level!
<var name="ismip6shelfMelt_TFdraft" type="real" dimensions="nCells Time" units="deg. C" packages="ismip6ShelfMelt"
description="thermal forcing at ice shelf draft used for ISMIP6 ice-shelf melting method, calculated by param."
/>
<var name="ismip6shelfMelt_3dThermalForcing" type="real" dimensions="nISMIP6OceanLayers nCells Time" units="deg. C"
<var name="ismip6shelfMelt_3dThermalForcing" type="real" dimensions="nISMIP6OceanLayers nCells Time" units="deg. C"
default_value="0.0" packages="ismip6ShelfMelt"
description="thermal forcing for ISMIP6 ice-shelf melting method, input to model"
/>
Expand Down Expand Up @@ -1411,7 +1411,7 @@ is the value of that variable from the *previous* time level!
description="thermal forcing for ISMIP6 retreat paramterization, from previous input time."
/>
<var name="ismip6RunoffPrevious" type="real" dimensions="nCells Time" units="kg m^{-2} s^{-1}" packages="ismip6GroundedFaceMelt" default_value="0.0"
description="Runoff forcing for ISMIP6 grounded ice melting method, from previous input time"
description="Runoff forcing for ISMIP6 grounded ice melting method, from previous input time"
/>
<var name="ismip6_2dThermalForcingCurrent" type="real" dimensions="nCells Time" units="deg. C" packages="ismip6GroundedFaceMelt" default_value="0.0"
description="thermal forcing for ISMIP6 retreat parameterization, at current input time."
Expand Down
4 changes: 2 additions & 2 deletions components/mpas-ocean/src/Registry.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2487,10 +2487,10 @@
description="Reconstruction weights associated with each of the edgesOnEdge, used to reconstruct the tangentialVelocity from normalVelocities on neighboring edges."
/>
<var name="dvEdge" type="real" dimensions="nEdges" units="m"
description="Length of each edge, computed as the distance between verticesOnEdge."
description="The great circle distance between vertices bordering a given edge. It is the length of the edge on the primal mesh."
/>
<var name="dcEdge" type="real" dimensions="nEdges" units="m"
description="Length of each edge, computed as the distance between cellsOnEdge."
description="The great circle distance between cell centers bordering a given edge. It is the length of the edge on the dual mesh."
/>
<var name="angleEdge" type="real" dimensions="nEdges" units="radians"
description="Angle the edge normal makes with local eastward direction."
Expand Down
6 changes: 3 additions & 3 deletions components/mpas-seaice/src/Registry.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1756,7 +1756,7 @@
icepack_name="kcatbound"
/>
</nml_record>

<nml_record name="floesize" in_defaults="true">
<nml_option name="config_floeshape" type="real" default_value="0.66" units="unitless"
description="Floe shape constant (noncircularity)."
Expand Down Expand Up @@ -2563,13 +2563,13 @@
type="real"
dimensions="nEdges"
units="m"
description="Length of each edge, computed as the distance between verticesOnEdge."
description="The great circle distance between vertices bordering a given edge. It is the length of the edge on the primal mesh."
/>
<var name="dcEdge"
type="real"
dimensions="nEdges"
units="m"
description="Length of each edge, computed as the distance between cellsOnEdge."
description="The great circle distance between cell centers bordering a given edge. It is the length of the edge on the dual mesh."
/>
<var name="areaCell"
type="real"
Expand Down

0 comments on commit a4ea7f9

Please sign in to comment.