Skip to content

Commit 5ed9282

Browse files
committed
Update developer's guide
1 parent a0316e1 commit 5ed9282

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

docs/developers_guide/ocean/api.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,11 @@
7272
analysis.Analysis.exact_solution
7373
analysis.Analysis.run
7474
75-
forward.compute_max_time_step
7675
forward.Forward
7776
forward.Forward.compute_cell_count
77+
forward.Forward.compute_max_time_step
7878
forward.Forward.dynamic_model_config
79+
forward.Forward.setup
7980
8081
init.Init
8182
init.Init.setup

docs/developers_guide/ocean/tasks/barotropic_gyre.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ defines a step for setting up the initial state for each test case.
2222
First, a mesh appropriate for the resolution is generated using
2323
{py:func}`mpas_tools.planar_hex.make_planar_hex_mesh()`. Then, the mesh is
2424
culled to remove periodicity in the x and y directions. A vertical grid is
25-
generated, with 1 layer by default. Next, the wind stress forcing field is
25+
generated, with 3 layers by default. Next, the wind stress forcing field is
2626
generated.
2727

2828
### forward
@@ -39,9 +39,10 @@ tasks have as their target and minimum (if the resources are not explicitly
3939
prescribed). For MPAS-Ocean, PIO namelist options are modified and a
4040
graph partition is generated as part of `runtime_setup()`. Next, the ocean
4141
model is run. If `run_time_steps` is provided then this determines the run
42-
duration, otherwise the duration is 3 years. Finally, validation of
43-
`layerThickness` and `normalVelocity` in the `output.nc` file are performed
44-
against a baseline if one is provided when calling {ref}`dev-polaris-setup`.
42+
duration, otherwise the duration is given by the config option `run_duration`.
43+
Finally, validation of `layerThickness` and `normalVelocity` in the `output.nc`
44+
file are performed against a baseline if one is provided when calling
45+
{ref}`dev-polaris-setup`.
4546

4647
### analysis
4748

@@ -51,9 +52,8 @@ the analytical solution for the linearized dynamics. This step also produces a
5152
figure with the model solution, the analytical solution, and the difference
5253
between the two.
5354

54-
(dev-ocean-baroclinic-gyre-default)=
55+
## barotropic_gyre
5556

56-
## default
57-
58-
The {py:class}`polaris.tasks.ocean.baroclinic_channel.default.Default`
59-
test performs a test of the linearized dynamics.
57+
The {py:class}`polaris.tasks.ocean.barotropic_gyre.BarotropicGyre`
58+
test performs either the Munk free-slip or the Munk no-slip cases depending
59+
on the `test_name` and `boundary_condition` parameters provided.

0 commit comments

Comments
 (0)