Default momentum advection for the HydrostaticFreeSurfaceModel (#3842)

* new default * force build * vector invariant default * fix the tests * Update src/Models/HydrostaticFreeSurfaceModels/hydrostatic_free_surface_model.jl Co-authored-by: Gregory L. Wagner <[email protected]> --------- Co-authored-by: Gregory L. Wagner <[email protected]>
CliMA · Oct 13, 2024 · efb8b71 · efb8b71
1 parent 0210e66
commit efb8b71
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 35 deletions.
diff --git a/docs/src/model_setup/buoyancy_and_equation_of_state.md b/docs/src/model_setup/buoyancy_and_equation_of_state.md
@@ -64,7 +64,7 @@ HydrostaticFreeSurfaceModel{CPU, RectilinearGrid}(time = 0 seconds, iteration =
 ├── free surface: ImplicitFreeSurface with gravitational acceleration 9.80665 m s⁻²
 │   └── solver: FFTImplicitFreeSurfaceSolver
 ├── advection scheme: 
-│   └── momentum: Centered reconstruction order 2
+│   └── momentum: Vector Invariant, Dimension-by-dimension reconstruction
 └── coriolis: Nothing
 ```
 
@@ -98,7 +98,7 @@ HydrostaticFreeSurfaceModel{CPU, RectilinearGrid}(time = 0 seconds, iteration =
 ├── free surface: ImplicitFreeSurface with gravitational acceleration 9.80665 m s⁻²
 │   └── solver: FFTImplicitFreeSurfaceSolver
 ├── advection scheme:
-│   ├── momentum: Centered reconstruction order 2
+│   ├── momentum: Vector Invariant, Dimension-by-dimension reconstruction
 │   └── b: Centered reconstruction order 2
 └── coriolis: Nothing
 ```
@@ -139,7 +139,7 @@ HydrostaticFreeSurfaceModel{CPU, RectilinearGrid}(time = 0 seconds, iteration =
 ├── free surface: ImplicitFreeSurface with gravitational acceleration 9.80665 m s⁻²
 │   └── solver: FFTImplicitFreeSurfaceSolver
 ├── advection scheme:
-│   ├── momentum: Centered reconstruction order 2
+│   ├── momentum: Vector Invariant, Dimension-by-dimension reconstruction
 │   ├── T: Centered reconstruction order 2
 │   └── S: Centered reconstruction order 2
 └── coriolis: Nothing

diff --git a/src/Models/HydrostaticFreeSurfaceModels/hydrostatic_free_surface_model.jl b/src/Models/HydrostaticFreeSurfaceModels/hydrostatic_free_surface_model.jl
@@ -55,22 +55,22 @@ default_free_surface(grid; gravitational_acceleration=g_Earth) =
 
 """
     HydrostaticFreeSurfaceModel(; grid,
-                                             clock = Clock{eltype(grid)}(time = 0),
-                                momentum_advection = CenteredSecondOrder(),
-                                  tracer_advection = CenteredSecondOrder(),
-                                          buoyancy = SeawaterBuoyancy(eltype(grid)),
-                                          coriolis = nothing,
-                                      free_surface = default_free_surface(grid, gravitational_acceleration=g_Earth),
-                               forcing::NamedTuple = NamedTuple(),
-                                           closure = nothing,
-                   boundary_conditions::NamedTuple = NamedTuple(),
-                                           tracers = (:T, :S),
-                     particles::ParticlesOrNothing = nothing,
-             biogeochemistry::AbstractBGCOrNothing = nothing,
-                                        velocities = nothing,
-                                          pressure = nothing,
-                                diffusivity_fields = nothing,
-                                  auxiliary_fields = NamedTuple(),
+                                clock = Clock{eltype(grid)}(time = 0),
+                   momentum_advection = VectorInvariant(),
+                     tracer_advection = CenteredSecondOrder(),
+                             buoyancy = SeawaterBuoyancy(eltype(grid)),
+                             coriolis = nothing,
+                         free_surface = default_free_surface(grid, gravitational_acceleration=g_Earth),
+                  forcing::NamedTuple = NamedTuple(),
+                              closure = nothing,
+      boundary_conditions::NamedTuple = NamedTuple(),
+                              tracers = (:T, :S),
+        particles::ParticlesOrNothing = nothing,
+biogeochemistry::AbstractBGCOrNothing = nothing,
+                           velocities = nothing,
+                             pressure = nothing,
+                   diffusivity_fields = nothing,
+                     auxiliary_fields = NamedTuple(),
     )
 
 Construct a hydrostatic model with a free surface on `grid`.
@@ -103,22 +103,22 @@ Keyword arguments
   - `auxiliary_fields`: `NamedTuple` of auxiliary fields. Default: `nothing`.
 """
 function HydrostaticFreeSurfaceModel(; grid,
-                                             clock = Clock{eltype(grid)}(time = 0),
-                                momentum_advection = CenteredSecondOrder(),
-                                  tracer_advection = CenteredSecondOrder(),
-                                          buoyancy = nothing,
-                                          coriolis = nothing,
-                                      free_surface = default_free_surface(grid, gravitational_acceleration=g_Earth),
-                                           tracers = nothing,
-                                      forcing::NamedTuple = NamedTuple(),
-                                           closure = nothing,
-                   boundary_conditions::NamedTuple = NamedTuple(),
-                     particles::ParticlesOrNothing = nothing,
-             biogeochemistry::AbstractBGCOrNothing = nothing,
-                                        velocities = nothing,
-                                          pressure = nothing,
-                                diffusivity_fields = nothing,
-                                  auxiliary_fields = NamedTuple()
+                                          clock = Clock{eltype(grid)}(time = 0),
+                             momentum_advection = VectorInvariant(),
+                               tracer_advection = CenteredSecondOrder(),
+                                       buoyancy = nothing,
+                                       coriolis = nothing,
+                                   free_surface = default_free_surface(grid, gravitational_acceleration=g_Earth),
+                                        tracers = nothing,
+                            forcing::NamedTuple = NamedTuple(),
+                                        closure = nothing,
+                boundary_conditions::NamedTuple = NamedTuple(),
+                  particles::ParticlesOrNothing = nothing,
+          biogeochemistry::AbstractBGCOrNothing = nothing,
+                                     velocities = nothing,
+                                       pressure = nothing,
+                             diffusivity_fields = nothing,
+                               auxiliary_fields = NamedTuple()
     )
 
     # Check halos and throw an error if the grid's halo is too small