Skip to content

Commit bb73dff

Browse files
xylarsbrus89
authored andcommitted
Fix some lint
1 parent 7715d0a commit bb73dff

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

components/omega/doc/design/PGrad.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ This means that Omega will need to compute both the pressure and geopotential gr
1313

1414
### 2.1 Requirement: Support for tilted pressure coordinates for the non-Boussinesq primitive equations
1515

16-
The pressure gradient will compute the horizontal gradients of both the pressure and geopotential to support tilted pressure coordinates in the non-Boussinesq model.
16+
The pressure gradient will compute the horizontal gradients of both the pressure and geopotential to support tilted pressure coordinates in the non-Boussinesq model.
1717
This will allow for the use of a $p^\star$ coordinate, which functions similarly to the $z^\star$ in the Boussinesq MPAS-Ocean model.
1818

1919
### 2.2 Requirement: Initial support for a simple centered pressure gradient
2020

21-
For initial global cases without ice shelf cavities, the pressure and geopotential gradients will be computed with a simple centered difference approximation. In later versions of Omega, one ore more high-order pressure gradients will be implemented and will replace the centered approach in production runs.
21+
For initial global cases without ice shelf cavities, the pressure and geopotential gradients will be computed with a simple centered difference approximation. In later versions of Omega, one ore more high-order pressure gradients will be implemented and will replace the centered approach in production runs.
2222
However, the centered pressure gradient will remain an option for use in idealized testing.
2323

2424
### 2.3 Requirement: Flexibility to support a high-order pressure gradient
@@ -28,7 +28,7 @@ The pressure gradient framework should be flexible enough to support a high-orde
2828
### 2.4 Requirement: Flexibility to support tidal forcing and sea level change
2929
In later versions of Omega, the pressure gradient will need to be able to include tidal forcing in the geopotential term.
3030
These tidal forcings include both the tidal potential and the self attraction and loading terms.
31-
Additionally, other changes to the geoid
31+
Additionally, other changes to the geoid
3232

3333
### 2.5 Requirement: Pressure gradient for barotropic mode
3434

@@ -106,8 +106,8 @@ The user will select a pressure gradient option at runtime in the input yaml fil
106106
An `enum class` will be used to specify options for the pressure gradient used for an Omega simulation:
107107
```c++
108108
enum class PressureGradType{
109-
Centered,
110-
HighOrder
109+
Centered,
110+
HighOrder
111111
}
112112
```
113113
The functions to compute the centered and high order pressure gradient terms will be implemented as functors and the pressure gradient class will have private instances of these classes.
@@ -156,7 +156,7 @@ PressureGrad *PressureGrad::get(const std::string &Name);
156156
157157
The public `computePressureGrad` method will rely on private methods for each specific pressure gradient option (centered and high order).
158158
```c++
159-
void PressureGrad::computePressureGrad(const Array2DReal &Tend,
159+
void PressureGrad::computePressureGrad(const Array2DReal &Tend,
160160
const Array2DReal &Pressure,
161161
const Array2DReal &Geopotential,
162162
const Array2DReal &SpecVol) {
@@ -167,7 +167,7 @@ OMEGA_SCOPE(LocHighOrderPGrad, HighOrderPGrad)
167167
KOKKOS_LAMBDA(int ICell, int KChunk) {
168168
LocCenteredPGrad(Tend, Pressure, Geopotential, SpecVol);
169169
});
170-
}
170+
}
171171
else if (PressureGradChoice == PressureGradType::HighOrder){
172172
parallelFor("pgrad-highorder", {NCellsAll, NChunks},
173173
KOKKOS_LAMBDA(int ICell, int KChunk) {
@@ -180,7 +180,7 @@ OMEGA_SCOPE(LocHighOrderPGrad, HighOrderPGrad)
180180

181181
No operations are needed in the destructor.
182182
The erase method will remove a named pressure gradient instance, whereas the clear method will remove all of
183-
them.
183+
them.
184184
Both will call the destructor in the process.
185185
```c++
186186
void PressureGrad::erase(const std::string &Name);
@@ -194,4 +194,3 @@ For a given analytical $v$, $h$, and $b$, the spatial convergence of the pressu
194194
195195
### Test: Baroclinic gyre
196196
The baroclinic gyre test case will test the pressure gradient term in the full non-Boussinesq equations.
197-

0 commit comments

Comments
 (0)