Skip to content

Commit 292e842

Browse files
committed
WIP Update user's guide: missing updated fig
1 parent d2588b7 commit 292e842

File tree

1 file changed

+54
-20
lines changed

1 file changed

+54
-20
lines changed

docs/users_guide/ocean/tasks/barotropic_gyre.md

Lines changed: 54 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -100,11 +100,14 @@ where `tau_0` is given by a config option.
100100
:width: 500 px
101101
```
102102

103-
### config options
103+
## config options
104104

105105
```cfg
106106
[barotropic_gyre]
107107
108+
# time integrator
109+
time_integrator = split_explicit_ab2
110+
108111
# distance in kilometers between cell centers
109112
resolution = 20
110113
@@ -117,24 +120,21 @@ ly = 1200
117120
# Maximum amplitude of the zonal wind stress [N m-2]
118121
tau_0 = 0.1
119122
120-
# Horizontal visocity [m2 s-1]
121-
nu_2 = 4e2
122-
123-
# [s-1 m-1]
124-
beta = 10e-11
125-
126-
# [s-1]
127-
f_0 = 10e-4
123+
# Horizontal gradient in coriolis parameter [s-1 m-1]
124+
beta = 1.0e-10
128125
129126
# homogenous fluid density [kg m-3]
130127
rho_0 = 1000
128+
129+
# Duration of forward step if run_time_steps not given [years]
130+
run_duration = 2.
131131
```
132132

133133
The config option `nu_2` specifies the del2 horizontal viscosity. This value
134134
will be compared against the resolution to check for stability at set-up. All
135135
other config options are explained further in previous sections.
136136

137-
### cores
137+
## cores
138138

139139
The number of cores is determined by `goal_cells_per_core` and
140140
`max_cells_per_core` in the `ocean` section of the config file.
@@ -143,15 +143,7 @@ The number of cores is determined by `goal_cells_per_core` and
143143

144144
## supported models
145145

146-
These tasks support only MPAS-Ocean.
147-
148-
## default
149-
150-
The default case is designed such that only a short forward run is performed.
151-
However, when users set up the default case, a long forward run is also set
152-
up and may be run along with the analysis step to compare the numerical
153-
solution with an analytical solution. The user should change the
154-
`barotropic_gyre: steps_to_run` config option to include desired steps.
146+
These tasks support both MPAS-Ocean and Omega.
155147

156148
### time step and run duration
157149

@@ -160,5 +152,47 @@ condition assuming a maximum velocity of 1 m/s and a function of the coriolis
160152
parameter `f_0`. The stability parameter is set to 0.25 based on the stability
161153
of MPAS-Ocean for this test case.
162154

163-
The run duration is 3 time steps for the `short_forward` step and 3 years for
155+
The run duration is 3 time steps for the `short_forward` step and 2 years for
164156
the `long_forward` step.
157+
158+
## munk free-slip
159+
160+
The Munk free-slip test case uses its own set of default horizontal viscosity
161+
and coriolis parameter values. It also automatically compares against the
162+
analytic solution for the free-slip case during the `analysis` step.
163+
164+
The case is designed such that only a short forward run is performed.
165+
However, when users set up the default case, a long forward run and analysis
166+
step are also set up and may be run together to compare the numerical
167+
solution with an analytical solution. The user should change the
168+
`barotropic_gyre_munk_free-slip: steps_to_run` config option to include desired
169+
steps.
170+
171+
### config options
172+
173+
```cfg
174+
[barotropic_gyre_munk_free-slip]
175+
176+
# Horizontal visocity [m2 s-1]
177+
nu_2 = 1e2
178+
179+
# Coriolis parameter [s-1]
180+
f_0 = 1.0e-4
181+
```
182+
183+
## munk no-slip
184+
185+
This case has the same attributes described in munk free-slip except the no-
186+
slip solution and a separate cfg section are used.
187+
188+
### config options
189+
190+
```cfg
191+
[barotropic_gyre_munk_no-slip]
192+
193+
# Horizontal visocity [m2 s-1]
194+
nu_2 = 4e2
195+
196+
# Coriolis parameter [s-1]
197+
f_0 = 1.0e-3
198+
```

0 commit comments

Comments
 (0)