@@ -29,20 +29,6 @@ struct StaticVerticalCoordinate{C, D, E, F} <: AbstractVerticalCoordinate
29
29
Δᵃᵃᶜ :: F
30
30
end
31
31
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.
46
32
struct ZStarVerticalCoordinate{C, D, E, F, H, CC, FC, CF, FF} <: AbstractVerticalCoordinate
47
33
cᵃᵃᶠ :: C
48
34
cᵃᵃᶜ :: D
@@ -57,7 +43,13 @@ struct ZStarVerticalCoordinate{C, D, E, F, H, CC, FC, CF, FF} <: AbstractVertica
57
43
∂t_σ :: CC
58
44
end
59
45
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
+ """
61
53
ZStarVerticalCoordinate (r_faces) = ZStarVerticalCoordinate (r_faces, r_faces, [nothing for i in 1 : 9 ]. .. )
62
54
63
55
# ###
0 commit comments