Skip to content

Commit e7581dc

Browse files
committed
fix suggestions
1 parent 3b24609 commit e7581dc

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

docs/src/examples.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The 1D Column advection example in [`examples/column/advect.jl`](https://github.
66

77
#### Equations and Discretizations
88

9-
Follows the continuity equation
9+
Follows the advection equation
1010

1111
```math
1212
\begin{equation}
@@ -18,7 +18,7 @@ This is discretized using the following
1818

1919
```math
2020
\begin{equation}
21-
\frac{\partial \theta}{\partial t} \approx - D(V, \theta)
21+
\frac{\partial \theta}{\partial t} \approx - D(v, \theta)
2222
\label{eq:1d-column-advection-discrete}
2323
\end{equation}
2424
```
@@ -32,22 +32,24 @@ This is discretized using the following
3232

3333
The example code solves the equation for 4 different tendencies with the following discretizations:
3434

35-
* Tendency 1: ``D = \partial(UB),`` where ``\partial`` is the [`face-to-center divergence`](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.DivergenceF2C) and $UB$ is the [`center-to-face upwind product operator`](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.UpwindBiasedProductC2F)
36-
* Tendenct 2: Follows tendency 1 with the addition of flux correction `fcc`
37-
* Tendency 3: $D = A$, where $A$ is the [`discrete vertical advection`](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.AdvectionC2C)
38-
* Tendency 4: Follows tendency 3 with the addition of flux correction `fcc`
35+
* Tendency 1: ``D = \partial(UB)``, where ``\partial`` is the [`face-to-center divergence`](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.DivergenceF2C) and $UB$ is the [`center-to-face upwind biased product`](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.UpwindBiasedProductC2F) operator.
36+
* Tendency 2: Follows tendency 1, where ``D = \partial(UB)``. Similarly, ``\partial`` is the [`face-to-center divergence`](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.DivergenceF2C) and $UB$ is the [`center-to-face upwind biased product`](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.UpwindBiasedProductC2F) operator. Tendency 2 also includes the [`center-to-center flux correction`](https://github.com/CliMA/ClimaCore.jl/blob/main/src/Operators/finitedifference.jl#L2617), `fcc`.
37+
* Tendency 3: $D = A$, where $A$ is the [`center-to-center vertical advection`](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.AdvectionC2C) operator.
38+
* Tendency 4: Follows tendency 3, where $D = A$, the [`center-to-center vertical advection`](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.AdvectionC2C). Tendency 4 also includes the [`center-to-center flux correction`](https://github.com/CliMA/ClimaCore.jl/blob/main/src/Operators/finitedifference.jl#L2617), `fcc`.
3939

4040
#### Set Up
4141

42-
This test case is set up in a 1D column domain ``z \in [0, 4\pi]``.
42+
This test case is set up in a 1D column domain ``z \in [0, 4\pi]``, discretized into a mesh of 128 elements. The velocity field is defined as a sinusoidal wave. The boundary conditions are operator dependent, so they depend on the tendency.
43+
* For tendencies 1 and 2 where the upwind biased operator ``UB`` is used, the left boundary is defined as ``sin(a - t)``. The right boundary is ``sin(b - t)``. Here ``a`` and ``b`` are the left and right bounds of the domain.
44+
* For tendencies 3 and 4, where the advection operator ``A`` is used, the left boundary is defined as ``sin(-t)``. The right boundary is extrapolated, meaning its value is set to the closest interior point.
4345

4446
### Heat
4547

4648
The 1D Column heat example in [`examples/column/heat.jl`](https://github.com/CliMA/ClimaCore.jl/blob/main/examples/column/heat.jl).
4749

4850
#### Equations and discretizations
4951

50-
Follows the continuity equation
52+
Follows the heat equation
5153

5254
```math
5355
\begin{equation}
@@ -72,13 +74,12 @@ This is discretized using the following
7274

7375
#### Differentiation Operators
7476

75-
* ``D`` is the [face-to-center divergence](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.DivergenceF2C), called `divf2c` in the example code
76-
* ``G`` is the [center-to-face gradient](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.GradientC2F), called `gradc2f` in the example code
77+
* ``D`` is the [face-to-center divergence](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.DivergenceF2C) operator, called `divf2c` in the example code
78+
* ``G`` is the [center-to-face gradient](https://clima.github.io/ClimaCore.jl/dev/operators/#ClimaCore.Operators.GradientC2F) operator, called `gradc2f` in the example code
7779

7880
#### Set Up
7981

80-
This test case is set up in a 1D column domain ``z \in [0, 1]``.
81-
82+
This test case is set up in a 1D column domain ``z \in [0, 1]`` and discretized into a mesh of 10 elements. A homogeneous Dirichlet boundary condition is set at the bottom boundary, `bcs_bottom`, setting the temperature to 0. A Neumann boundary condition is applied to the top boundary, `bcs_top`, setting the temperature gradient to 1.
8283

8384
## 2D Cartesian examples
8485

0 commit comments

Comments
 (0)