Skip to content

Commit 4802870

Browse files
ali-ramadhanali-ramadhan
authored
Fix and improve show methods for CATKEEquation and CATKEMixingLength (#4895)
1 parent 9f10f5e commit 4802870

File tree

2 files changed

+33
-32
lines changed

2 files changed

+33
-32
lines changed

‎src/TurbulenceClosures/turbulence_closure_implementations/TKEBasedVerticalDiffusivities/catke_equation.jl‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ isotropic turbulence and diapycnal mixing.
77
Base.@kwdef struct CATKEEquation{FT}
88
CʰⁱD :: FT = 0.579 # Dissipation length scale shear coefficient for high Ri
99
CˡᵒD :: FT = 1.604 # Dissipation length scale shear coefficient for low Ri
10-
CᵘⁿD :: FT = 0.923 # Dissipation length scale shear coefficient for high Ri
10+
CᵘⁿD :: FT = 0.923 # Dissipation length scale shear coefficient for negative Ri
1111
CᶜD :: FT = 3.254 # Dissipation length scale convecting layer coefficient
1212
CᵉD :: FT = 0.0 # Dissipation length scale penetration layer coefficient
1313
Cᵂu★ :: FT = 3.179 # Surface shear-driven TKE flux coefficient
@@ -156,12 +156,12 @@ end
156156

157157
Base.summary(::CATKEEquation) = "TKEBasedVerticalDiffusivities.CATKEEquation"
158158
Base.show(io::IO, tke::CATKEEquation) =
159-
print(io, "TKEBasedVerticalDiffusivities.CATKEEquation parameters:", '\n',
160-
"├── CʰⁱD: ", tke.CʰⁱD, '\n',
161-
"├── CˡᵒD: ", tke.CˡᵒD, '\n',
162-
"├── CᵘⁿD: ", tke.CᵘⁿD, '\n',
163-
"├── CᶜD: ", tke.CᶜD, '\n',
164-
"├── CᵉD: ", tke.CᵉD, '\n',
165-
"├── Cᵂu★: ", tke.Cᵂu★, '\n',
166-
"└── CᵂwΔ: ", tke.CᵂwΔ)
167-
159+
print(io, "TKEBasedVerticalDiffusivities.CATKEEquation parameters:\n",
160+
"├── Dissipation length scale shear coefficient for high Ri: CʰⁱD = $(tke.CʰⁱD)\n",
161+
"├── Dissipation length scale shear coefficient for low Ri: CˡᵒD = $(tke.CˡᵒD)\n",
162+
"├── Dissipation length scale shear coefficient for negative Ri: CᵘⁿD = $(tke.CᵘⁿD)\n",
163+
"├── Dissipation length scale convecting layer coefficient: CᶜD = $(tke.CᶜD)\n",
164+
"├── Dissipation length scale penetration layer coefficient: CᵉD = $(tke.CᵉD)\n",
165+
"├── Surface shear-driven TKE flux coefficient: Cᵂu★ = $(tke.Cᵂu★)\n",
166+
"├── Surface convective TKE flux coefficient: CᵂwΔ = $(tke.CᵂwΔ)\n",
167+
"└── Dissipative near-bottom TKE flux coefficient: Cᵂϵ = $(tke.Cᵂϵ)")

‎src/TurbulenceClosures/turbulence_closure_implementations/TKEBasedVerticalDiffusivities/catke_mixing_length.jl‎

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Base.@kwdef struct CATKEMixingLength{FT}
2121
Cʰⁱu :: FT = 0.242 # Shear mixing length coefficient for momentum at high Ri
2222
Cˡᵒu :: FT = 0.361 # Shear mixing length coefficient for momentum at low Ri
2323
Cᵘⁿu :: FT = 0.370 # Shear mixing length coefficient for momentum at negative Ri
24-
Cᶜu :: FT = 3.705 # Convective mixing length coefficient for tracers
25-
Cᵉu :: FT = 0.0 # Convective penetration mixing length coefficient for tracers
24+
Cᶜu :: FT = 3.705 # Convective mixing length coefficient for momentum
25+
Cᵉu :: FT = 0.0 # Convective penetration mixing length coefficient for momentum
2626
Cʰⁱc :: FT = 0.098 # Shear mixing length coefficient for tracers at high Ri
2727
Cˡᵒc :: FT = 0.369 # Shear mixing length coefficient for tracers at low Ri
2828
Cᵘⁿc :: FT = 0.572 # Shear mixing length coefficient for tracers at negative Ri
@@ -279,23 +279,24 @@ end
279279
Base.summary(::CATKEMixingLength) = "TKEBasedVerticalDiffusivities.CATKEMixingLength"
280280

281281
Base.show(io::IO, ml::CATKEMixingLength) =
282-
print(io, "TKEBasedVerticalDiffusivities.CATKEMixingLength parameters:", '\n',
283-
" ├── Cˢ: ", ml.Cˢ, '\n',
284-
" ├── Cᵇ: ", ml.Cᵇ, '\n',
285-
" ├── Cʰⁱu: ", ml.Cʰⁱu, '\n',
286-
" ├── Cʰⁱc: ", ml.Cʰⁱc, '\n',
287-
" ├── Cʰⁱe: ", ml.Cʰⁱe, '\n',
288-
" ├── Cˡᵒu: ", ml.Cˡᵒu, '\n',
289-
" ├── Cˡᵒc: ", ml.Cˡᵒc, '\n',
290-
" ├── Cˡᵒe: ", ml.Cˡᵒe, '\n',
291-
" ├── Cᵘⁿu: ", ml.Cᵘⁿu, '\n',
292-
" ├── Cᵘⁿc: ", ml.Cᵘⁿc, '\n',
293-
" ├── Cᵘⁿe: ", ml.Cᵘⁿe, '\n',
294-
" ├── Cᶜu: ", ml.Cᶜu, '\n',
295-
" ├── Cᶜc: ", ml.Cᶜc, '\n',
296-
" ├── Cᶜe: ", ml.Cᶜe, '\n',
297-
" ├── Cᵉc: ", ml.Cᵉc, '\n',
298-
" ├── Cᵉe: ", ml.Cᵉe, '\n',
299-
" ├── Cˢᵖ: ", ml.Cˢᵖ, '\n',
300-
" ├── CRiᵟ: ", ml.CRiᵟ, '\n',
301-
" └── CRi⁰: ", ml.CRi⁰)
282+
print(io, "TKEBasedVerticalDiffusivities.CATKEMixingLength parameters:\n",
283+
" ├── Surface distance coefficient for shear length scale: Cˢ = $(ml.Cˢ)\n",
284+
" ├── Bottom distance coefficient for shear length scale: Cᵇ = $(ml.Cᵇ)\n",
285+
" ├── Shear mixing length coefficient for momentum at high Ri: Cʰⁱu = $(ml.Cʰⁱu)\n",
286+
" ├── Shear mixing length coefficient for tracers at high Ri: Cʰⁱc = $(ml.Cʰⁱc)\n",
287+
" ├── Shear mixing length coefficient for TKE at high Ri: Cʰⁱe = $(ml.Cʰⁱe)\n",
288+
" ├── Shear mixing length coefficient for momentum at low Ri: Cˡᵒu = $(ml.Cˡᵒu)\n",
289+
" ├── Shear mixing length coefficient for tracers at low Ri: Cˡᵒc = $(ml.Cˡᵒc)\n",
290+
" ├── Shear mixing length coefficient for TKE at low Ri: Cˡᵒe = $(ml.Cˡᵒe)\n",
291+
" ├── Shear mixing length coefficient for momentum at negative Ri: Cᵘⁿu = $(ml.Cᵘⁿu)\n",
292+
" ├── Shear mixing length coefficient for tracers at negative Ri: Cᵘⁿc = $(ml.Cᵘⁿc)\n",
293+
" ├── Shear mixing length coefficient for TKE at negative Ri: Cᵘⁿe = $(ml.Cᵘⁿe)\n",
294+
" ├── Convective mixing length coefficient for momentum: Cᶜu = $(ml.Cᶜu)\n",
295+
" ├── Convective mixing length coefficient for tracers: Cᶜc = $(ml.Cᶜc)\n",
296+
" ├── Convective mixing length coefficient for TKE: Cᶜe = $(ml.Cᶜe)\n",
297+
" ├── Convective penetration mixing length coefficient for momentum: Cᵉu = $(ml.Cᵉu)\n",
298+
" ├── Convective penetration mixing length coefficient for tracers: Cᵉc = $(ml.Cᵉc)\n",
299+
" ├── Convective penetration mixing length coefficient for TKE: Cᵉe = $(ml.Cᵉe)\n",
300+
" ├── Sheared convective plume coefficient: Cˢᵖ = $(ml.Cˢᵖ)\n",
301+
" ├── Stability function width: CRiᵟ = $(ml.CRiᵟ)\n",
302+
" └── Stability function lower Ri: CRi⁰ = $(ml.CRi⁰)")

0 commit comments

Comments
 (0)