Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Show method for HydrostaticFreeSurfaceModel summarizes advection schemes #3504

Merged
merged 2 commits into from
Mar 11, 2024
Merged

Show method for HydrostaticFreeSurfaceModel summarizes advection schemes #3504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6008ac5
show(io, ::HydrostaticFreeSurfaceModel) summarizes advection schemes
navidcy Mar 11, 2024
7f4def0
fix doctests
navidcy Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/src/model_setup/buoyancy_and_equation_of_state.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ HydrostaticFreeSurfaceModel{CPU, RectilinearGrid}(time = 0 seconds, iteration =
├── buoyancy: Nothing
├── free surface: ImplicitFreeSurface with gravitational acceleration 9.80665 m s⁻²
│ └── solver: FFTImplicitFreeSurfaceSolver
├── advection scheme:
│ └── momentum: Centered reconstruction order 2
└── coriolis: Nothing
```

Expand Down Expand Up @@ -94,6 +96,9 @@ HydrostaticFreeSurfaceModel{CPU, RectilinearGrid}(time = 0 seconds, iteration =
├── buoyancy: BuoyancyTracer with ĝ = NegativeZDirection()
├── free surface: ImplicitFreeSurface with gravitational acceleration 9.80665 m s⁻²
│ └── solver: FFTImplicitFreeSurfaceSolver
├── advection scheme:
│ ├── momentum: Centered reconstruction order 2
│ └── b: Centered reconstruction order 2
└── coriolis: Nothing
```

Expand Down Expand Up @@ -131,6 +136,10 @@ HydrostaticFreeSurfaceModel{CPU, RectilinearGrid}(time = 0 seconds, iteration =
├── buoyancy: SeawaterBuoyancy with g=9.80665 and LinearEquationOfState(thermal_expansion=0.000167, haline_contraction=0.00078) with ĝ = NegativeZDirection()
├── free surface: ImplicitFreeSurface with gravitational acceleration 9.80665 m s⁻²
│ └── solver: FFTImplicitFreeSurfaceSolver
├── advection scheme:
│ ├── momentum: Centered reconstruction order 2
│ ├── T: Centered reconstruction order 2
│ └── S: Centered reconstruction order 2
└── coriolis: Nothing
```

Expand All @@ -146,6 +155,10 @@ HydrostaticFreeSurfaceModel{CPU, RectilinearGrid}(time = 0 seconds, iteration =
├── buoyancy: SeawaterBuoyancy with g=9.80665 and LinearEquationOfState(thermal_expansion=0.000167, haline_contraction=0.00078) with ĝ = NegativeZDirection()
├── free surface: ImplicitFreeSurface with gravitational acceleration 9.80665 m s⁻²
│ └── solver: FFTImplicitFreeSurfaceSolver
├── advection scheme:
│ ├── momentum: Centered reconstruction order 2
│ ├── T: Centered reconstruction order 2
│ └── S: Centered reconstruction order 2
└── coriolis: Nothing
```

Expand Down
10 changes: 10 additions & 0 deletions src/Models/HydrostaticFreeSurfaceModels/show_hydrostatic_free_surface_model.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,16 @@ function Base.show(io::IO, model::HydrostaticFreeSurfaceModel)
end
end

if model.advection !== nothing
print(io, "├── advection scheme: ", "\n")
names = keys(model.advection)
for name in names[1:end-1]
print(io, "│ ├── " * string(name) * ": " * summary(model.advection[name]), "\n")
end
name = names[end]
print(io, "│ └── " * string(name) * ": " * summary(model.advection[name]), "\n")
end

if isnothing(model.particles)
print(io, "└── coriolis: $(typeof(model.coriolis))")
else
Expand Down