Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix some formatting in MPAS-Ocean Registry for generating docs #6293

Merged
merged 3 commits into from
Mar 28, 2024
Merged

Fix some formatting in MPAS-Ocean Registry for generating docs #6293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e3a1f1f
Fix some formatting in Registry for generating docs
xylar Feb 29, 2024
271b548
Update namelist definitions
xylar Mar 20, 2024
87e358b
Remove trailing space in description
xylar Mar 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions components/mpas-ocean/bld/namelist_files/namelist_definition_mpaso.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ Default: Defined in namelist_defaults.xml

<entry id="config_hmix_ref_cell_width" type="real"
category="hmix" group="hmix">
Reference cell width. If config_hmix_use_ref_cell_width = .true., then hmix coefficients are set to be nu_{2h} = config_mom_del2*(cellWidth / config_hmix_use_ref_cell_width) and nu_{4h} = config_mom_del4*(cellWidth / config_hmix_use_ref_cell_width)^3 where cellWidth is the effective cell width computed as 2*sqrt(areaCell/pi). See Hoch et al 2020 JAMES eq 1,2. This relation applies within a simulation, but also generally among multiple simulations, so the parameters config_mom_del2, config_mom_del4, and config_hmix_use_ref_cell_width can generally remain at their standard values, and just be adjusted for fine tuning.
Reference cell width. If config_hmix_use_ref_cell_width = .true., then hmix coefficients are set to be $nu_{2h}$ = config_mom_del2*(cellWidth / config_hmix_use_ref_cell_width) and $nu_{4h}$ = config_mom_del4*(cellWidth / config_hmix_use_ref_cell_width)$^3$ where cellWidth is the effective cell width computed as 2*sqrt(areaCell/pi). See Hoch et al 2020 JAMES eq 1,2. This relation applies within a simulation, but also generally among multiple simulations, so the parameters config_mom_del2, config_mom_del4, and config_hmix_use_ref_cell_width can generally remain at their standard values, and just be adjusted for fine tuning.

Valid values: Any positive real number, but typically a resolution number such as 30km.
Default: Defined in namelist_defaults.xml
Expand Down Expand Up @@ -307,7 +307,7 @@ Default: Defined in namelist_defaults.xml

<entry id="config_mom_del4" type="real"
category="hmix_del4" group="hmix_del4">
Coefficient for horizontal biharmonic operator on momentum. If config_hmix_use_ref_cell_width = .true. then $\nu_{4h}$ = config_mom_del4*(cellWidth / config_hmix_use_ref_cell_width)^3. If config_hmix_use_ref_cell_width = .false. then it is referenced to the smallest cell.
Coefficient for horizontal biharmonic operator on momentum. If config_hmix_use_ref_cell_width = .true. then $\nu_{4h}$ = config_mom_del4*(cellWidth / config_hmix_use_ref_cell_width)$^3$. If config_hmix_use_ref_cell_width = .false. then it is referenced to the smallest cell.

Valid values: any positive real
Default: Defined in namelist_defaults.xml
Expand All @@ -331,7 +331,7 @@ Default: Defined in namelist_defaults.xml

<entry id="config_tracer_del4" type="real"
category="hmix_del4" group="hmix_del4">
Coefficient for horizontal biharmonic operator on tracers. If config_hmix_use_ref_cell_width = .true. then $\nu_{4h}$ = config_tracer_del4*(cellWidth / config_hmix_use_ref_cell_width)^3. If config_hmix_use_ref_cell_width = .false. then it is referenced to the smallest cell.
Coefficient for horizontal biharmonic operator on tracers. If config_hmix_use_ref_cell_width = .true. then $\nu_{4h}$ = config_tracer_del4*(cellWidth / config_hmix_use_ref_cell_width)$^3$. If config_hmix_use_ref_cell_width = .false. then it is referenced to the smallest cell.

Valid values: any positive real
Default: Defined in namelist_defaults.xml
Expand Down Expand Up @@ -1188,7 +1188,7 @@ Default: Defined in namelist_defaults.xml

<entry id="config_sw_absorption_type" type="char*1024"
category="shortwaveRadiation" group="shortwaveRadiation">
Name of shortwave absorption type used in simulation.
Name of shortwave absorption type used in simulation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may have to be fixed in Registry instead of by hand in this generated file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed this in the registry as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I use an editor that automatically trims trailing whitespace (which I wish more folks would do). It seems easier to fix this than to revert it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to revert it if you fixed it in Registry as well. Thanks for taking that on


Valid values: 'jerlov' or 'ohlmann00' or 'none'
Default: Defined in namelist_defaults.xml
Expand Down Expand Up @@ -1809,7 +1809,7 @@ Default: Defined in namelist_defaults.xml

<entry id="config_Rayleigh_damping_depth_variable" type="logical"
category="Rayleigh_damping" group="Rayleigh_damping">
If true applies r h^-1 instead of just r.
If true applies r h$^-1$ instead of just r.

Valid values: .true. or .false.
Default: Defined in namelist_defaults.xml
Expand Down
12 changes: 6 additions & 6 deletions components/mpas-ocean/src/Registry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@
possible_values=".true. or .false."
/>
<nml_option name="config_hmix_ref_cell_width" type="real" default_value="30.0e3" units="m"
description="Reference cell width. If config_hmix_use_ref_cell_width = .true., then hmix coefficients are set to be nu_{2h} = config_mom_del2*(cellWidth / config_hmix_use_ref_cell_width) and nu_{4h} = config_mom_del4*(cellWidth / config_hmix_use_ref_cell_width)^3 where cellWidth is the effective cell width computed as 2*sqrt(areaCell/pi). See Hoch et al 2020 JAMES eq 1,2. This relation applies within a simulation, but also generally among multiple simulations, so the parameters config_mom_del2, config_mom_del4, and config_hmix_use_ref_cell_width can generally remain at their standard values, and just be adjusted for fine tuning."
description="Reference cell width. If config_hmix_use_ref_cell_width = .true., then hmix coefficients are set to be $nu_{2h}$ = config_mom_del2*(cellWidth / config_hmix_use_ref_cell_width) and $nu_{4h}$ = config_mom_del4*(cellWidth / config_hmix_use_ref_cell_width)$^3$ where cellWidth is the effective cell width computed as 2*sqrt(areaCell/pi). See Hoch et al 2020 JAMES eq 1,2. This relation applies within a simulation, but also generally among multiple simulations, so the parameters config_mom_del2, config_mom_del4, and config_hmix_use_ref_cell_width can generally remain at their standard values, and just be adjusted for fine tuning."
possible_values="Any positive real number, but typically a resolution number such as 30km."
/>
<nml_option name="config_apvm_scale_factor" type="real" default_value="0.0"
Expand Down Expand Up @@ -255,7 +255,7 @@
possible_values=".true. or .false."
/>
<nml_option name="config_mom_del4" type="real" default_value="1.2e11" units="m^4 s^-1"
description="Coefficient for horizontal biharmonic operator on momentum. If config_hmix_use_ref_cell_width = .true. then $\nu_{4h}$ = config_mom_del4*(cellWidth / config_hmix_use_ref_cell_width)^3. If config_hmix_use_ref_cell_width = .false. then it is referenced to the smallest cell."
description="Coefficient for horizontal biharmonic operator on momentum. If config_hmix_use_ref_cell_width = .true. then $\nu_{4h}$ = config_mom_del4*(cellWidth / config_hmix_use_ref_cell_width)$^3$. If config_hmix_use_ref_cell_width = .false. then it is referenced to the smallest cell."
possible_values="any positive real"
/>
<nml_option name="config_mom_del4_div_factor" type="real" default_value="1.0" units="non-dimensional"
Expand All @@ -267,7 +267,7 @@
possible_values=".true. or .false."
/>
<nml_option name="config_tracer_del4" type="real" default_value="0.0" units="m^4 s^-1"
description="Coefficient for horizontal biharmonic operator on tracers. If config_hmix_use_ref_cell_width = .true. then $\nu_{4h}$ = config_tracer_del4*(cellWidth / config_hmix_use_ref_cell_width)^3. If config_hmix_use_ref_cell_width = .false. then it is referenced to the smallest cell."
description="Coefficient for horizontal biharmonic operator on tracers. If config_hmix_use_ref_cell_width = .true. then $\nu_{4h}$ = config_tracer_del4*(cellWidth / config_hmix_use_ref_cell_width)$^3$. If config_hmix_use_ref_cell_width = .false. then it is referenced to the smallest cell."
possible_values="any positive real"
/>
</nml_record>
Expand Down Expand Up @@ -762,7 +762,7 @@
</nml_record>
<nml_record name="shortwaveRadiation" mode="init;forward">
<nml_option name="config_sw_absorption_type" type="character" default_value="none"
description="Name of shortwave absorption type used in simulation. "
description="Name of shortwave absorption type used in simulation."
possible_values="'jerlov' or 'ohlmann00' or 'none'"
/>
<nml_option name="config_jerlov_water_type" type="integer" default_value="3"
Expand Down Expand Up @@ -1123,7 +1123,7 @@
possible_values="Any positive real value."
/>
<nml_option name="config_Rayleigh_damping_depth_variable" type="logical" default_value=".false."
description="If true applies r h^-1 instead of just r."
description="If true applies r h$^-1$ instead of just r."
possible_values=".true. or .false."
/>
<nml_option name="config_Rayleigh_bottom_friction" type="logical" default_value=".false."
Expand Down Expand Up @@ -3878,7 +3878,7 @@
packages="tidalPotentialForcingPKG"
/>
<var name="tidalPotentialLatitudeFunction" type="real" dimensions="nCells R3 Time" units="1"
description="Latitude function for tidal constituents: long-period = 3\sin^2(\phi)-1, diurnal = \sin(2\phi), semi-diurnal = \cos^2(\phi)"
description="Latitude function for tidal constituents: long-period = $3\sin^2(\phi)-1$, diurnal = $\sin(2\phi)$, semi-diurnal = $\cos^2(\phi)$"
packages="tidalPotentialForcingPKG"
/>
<var name="sshSubcycleCurWithTides" type="real" dimensions="nCells Time" units="m"
Expand Down