Skip to content

Commit 9825ef8

Browse files
add a docstring
1 parent 92414e5 commit 9825ef8

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

src/Grids/vertical_coordinates.jl

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,20 +29,6 @@ struct StaticVerticalCoordinate{C, D, E, F} <: AbstractVerticalCoordinate
2929
Δᵃᵃᶜ :: F
3030
end
3131

32-
# Represents a z-star three-dimensional vertical coordinate.
33-
#
34-
# # Fields
35-
# - `cᶠ::C`: Face-centered coordinate.
36-
# - `cᶜ::C`: Cell-centered coordinate.
37-
# - `Δᶠ::D`: Face-centered grid spacing.
38-
# - `Δᶜ::D`: Cell-centered grid spacing.
39-
# - `ηⁿ::E`: Surface elevation at the current time step.
40-
# - `σᶜᶜⁿ::CC`: Vertical grid scaling at center-center at the current time step.
41-
# - `σᶠᶜⁿ::FC`: Vertical grid scaling at face-center at the current time step.
42-
# - `σᶜᶠⁿ::CF`: Vertical grid scaling at center-face at the current time step.
43-
# - `σᶠᶠⁿ::FF`: Vertical grid scaling at face-face at the current time step.
44-
# - `σᶜᶜ⁻::CC`: Vertical grid scaling at center-center at the previous time step.
45-
# - `∂t_σ::CC`: Time derivative of the vertical grid scaling at cell centers.
4632
struct ZStarVerticalCoordinate{C, D, E, F, H, CC, FC, CF, FF} <: AbstractVerticalCoordinate
4733
cᵃᵃᶠ :: C
4834
cᵃᵃᶜ :: D
@@ -57,7 +43,13 @@ struct ZStarVerticalCoordinate{C, D, E, F, H, CC, FC, CF, FF} <: AbstractVertica
5743
∂t_σ :: CC
5844
end
5945

60-
# Convenience constructors for z-star vertical coordinate for use in grid constructors
46+
"""
47+
ZStarVerticalCoordinate(r_faces)
48+
49+
Construct a `ZStarVerticalCoordinate` from `r_faces` that can be a `Tuple`, a function of an index `k`,
50+
or an `AbstractArray`. A `ZStarVerticalCoordinate` is a vertical coordinate that evolves in time
51+
following the surface.
52+
"""
6153
ZStarVerticalCoordinate(r_faces) = ZStarVerticalCoordinate(r_faces, r_faces, [nothing for i in 1:9]...)
6254

6355
####

0 commit comments

Comments
 (0)