Skip to content

Fix and improve show methods for CATKEEquation and CATKEMixingLength #4895

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

Merged
merged 3 commits into from
Oct 31, 2025
Merged

Fix and improve show methods for CATKEEquation and CATKEMixingLength #4895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc6f4d4
Fix and improve show methods for `CATKEEquation` and `CATKEMixingLength`
ali-ramadhan Oct 30, 2025
ebb2b82
Empty commit to trigger Buildkite
ali-ramadhan Oct 30, 2025
d85fb94
Empty commit to trigger Buildkite again
ali-ramadhan Oct 31, 2025
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
20 changes: 10 additions & 10 deletions ...osures/turbulence_closure_implementations/TKEBasedVerticalDiffusivities/catke_equation.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ isotropic turbulence and diapycnal mixing.
Base.@kwdef struct CATKEEquation{FT}
CʰⁱD :: FT = 0.579 # Dissipation length scale shear coefficient for high Ri
CˡᵒD :: FT = 1.604 # Dissipation length scale shear coefficient for low Ri
CᵘⁿD :: FT = 0.923 # Dissipation length scale shear coefficient for high Ri
CᵘⁿD :: FT = 0.923 # Dissipation length scale shear coefficient for negative Ri
CᶜD :: FT = 3.254 # Dissipation length scale convecting layer coefficient
CᵉD :: FT = 0.0 # Dissipation length scale penetration layer coefficient
Cᵂu★ :: FT = 3.179 # Surface shear-driven TKE flux coefficient
Expand Down Expand Up @@ -156,12 +156,12 @@ end

Base.summary(::CATKEEquation) = "TKEBasedVerticalDiffusivities.CATKEEquation"
Base.show(io::IO, tke::CATKEEquation) =
print(io, "TKEBasedVerticalDiffusivities.CATKEEquation parameters:", '\n',
"├── CʰⁱD: ", tke.CʰⁱD, '\n',
"├── CˡᵒD: ", tke.CˡᵒD, '\n',
"├── CᵘⁿD: ", tke.CᵘⁿD, '\n',
"├── CᶜD: ", tke.CᶜD, '\n',
"├── CᵉD: ", tke.CᵉD, '\n',
"├── Cᵂu★: ", tke.Cᵂu★, '\n',
"└── CᵂwΔ: ", tke.CᵂwΔ)

print(io, "TKEBasedVerticalDiffusivities.CATKEEquation parameters:\n",
"├── Dissipation length scale shear coefficient for high Ri: CʰⁱD = $(tke.CʰⁱD)\n",
"├── Dissipation length scale shear coefficient for low Ri: CˡᵒD = $(tke.CˡᵒD)\n",
"├── Dissipation length scale shear coefficient for negative Ri: CᵘⁿD = $(tke.CᵘⁿD)\n",
"├── Dissipation length scale convecting layer coefficient: CᶜD = $(tke.CᶜD)\n",
"├── Dissipation length scale penetration layer coefficient: CᵉD = $(tke.CᵉD)\n",
"├── Surface shear-driven TKE flux coefficient: Cᵂu★ = $(tke.Cᵂu★)\n",
"├── Surface convective TKE flux coefficient: CᵂwΔ = $(tke.CᵂwΔ)\n",
"└── Dissipative near-bottom TKE flux coefficient: Cᵂϵ = $(tke.Cᵂϵ)")
45 changes: 23 additions & 22 deletions ...s/turbulence_closure_implementations/TKEBasedVerticalDiffusivities/catke_mixing_length.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Base.@kwdef struct CATKEMixingLength{FT}
Cʰⁱu :: FT = 0.242 # Shear mixing length coefficient for momentum at high Ri
Cˡᵒu :: FT = 0.361 # Shear mixing length coefficient for momentum at low Ri
Cᵘⁿu :: FT = 0.370 # Shear mixing length coefficient for momentum at negative Ri
Cᶜu :: FT = 3.705 # Convective mixing length coefficient for tracers
Cᵉu :: FT = 0.0 # Convective penetration mixing length coefficient for tracers
Cᶜu :: FT = 3.705 # Convective mixing length coefficient for momentum
Cᵉu :: FT = 0.0 # Convective penetration mixing length coefficient for momentum
Cʰⁱc :: FT = 0.098 # Shear mixing length coefficient for tracers at high Ri
Cˡᵒc :: FT = 0.369 # Shear mixing length coefficient for tracers at low Ri
Cᵘⁿc :: FT = 0.572 # Shear mixing length coefficient for tracers at negative Ri
Expand Down Expand Up @@ -279,23 +279,24 @@ end
Base.summary(::CATKEMixingLength) = "TKEBasedVerticalDiffusivities.CATKEMixingLength"

Base.show(io::IO, ml::CATKEMixingLength) =
print(io, "TKEBasedVerticalDiffusivities.CATKEMixingLength parameters:", '\n',
" ├── Cˢ: ", ml.Cˢ, '\n',
" ├── Cᵇ: ", ml.Cᵇ, '\n',
" ├── Cʰⁱu: ", ml.Cʰⁱu, '\n',
" ├── Cʰⁱc: ", ml.Cʰⁱc, '\n',
" ├── Cʰⁱe: ", ml.Cʰⁱe, '\n',
" ├── Cˡᵒu: ", ml.Cˡᵒu, '\n',
" ├── Cˡᵒc: ", ml.Cˡᵒc, '\n',
" ├── Cˡᵒe: ", ml.Cˡᵒe, '\n',
" ├── Cᵘⁿu: ", ml.Cᵘⁿu, '\n',
" ├── Cᵘⁿc: ", ml.Cᵘⁿc, '\n',
" ├── Cᵘⁿe: ", ml.Cᵘⁿe, '\n',
" ├── Cᶜu: ", ml.Cᶜu, '\n',
" ├── Cᶜc: ", ml.Cᶜc, '\n',
" ├── Cᶜe: ", ml.Cᶜe, '\n',
" ├── Cᵉc: ", ml.Cᵉc, '\n',
" ├── Cᵉe: ", ml.Cᵉe, '\n',
" ├── Cˢᵖ: ", ml.Cˢᵖ, '\n',
" ├── CRiᵟ: ", ml.CRiᵟ, '\n',
" └── CRi⁰: ", ml.CRi⁰)
print(io, "TKEBasedVerticalDiffusivities.CATKEMixingLength parameters:\n",
" ├── Surface distance coefficient for shear length scale: Cˢ = $(ml.Cˢ)\n",
" ├── Bottom distance coefficient for shear length scale: Cᵇ = $(ml.Cᵇ)\n",
" ├── Shear mixing length coefficient for momentum at high Ri: Cʰⁱu = $(ml.Cʰⁱu)\n",
" ├── Shear mixing length coefficient for tracers at high Ri: Cʰⁱc = $(ml.Cʰⁱc)\n",
" ├── Shear mixing length coefficient for TKE at high Ri: Cʰⁱe = $(ml.Cʰⁱe)\n",
" ├── Shear mixing length coefficient for momentum at low Ri: Cˡᵒu = $(ml.Cˡᵒu)\n",
" ├── Shear mixing length coefficient for tracers at low Ri: Cˡᵒc = $(ml.Cˡᵒc)\n",
" ├── Shear mixing length coefficient for TKE at low Ri: Cˡᵒe = $(ml.Cˡᵒe)\n",
" ├── Shear mixing length coefficient for momentum at negative Ri: Cᵘⁿu = $(ml.Cᵘⁿu)\n",
" ├── Shear mixing length coefficient for tracers at negative Ri: Cᵘⁿc = $(ml.Cᵘⁿc)\n",
" ├── Shear mixing length coefficient for TKE at negative Ri: Cᵘⁿe = $(ml.Cᵘⁿe)\n",
" ├── Convective mixing length coefficient for momentum: Cᶜu = $(ml.Cᶜu)\n",
" ├── Convective mixing length coefficient for tracers: Cᶜc = $(ml.Cᶜc)\n",
" ├── Convective mixing length coefficient for TKE: Cᶜe = $(ml.Cᶜe)\n",
" ├── Convective penetration mixing length coefficient for momentum: Cᵉu = $(ml.Cᵉu)\n",
" ├── Convective penetration mixing length coefficient for tracers: Cᵉc = $(ml.Cᵉc)\n",
" ├── Convective penetration mixing length coefficient for TKE: Cᵉe = $(ml.Cᵉe)\n",
" ├── Sheared convective plume coefficient: Cˢᵖ = $(ml.Cˢᵖ)\n",
" ├── Stability function width: CRiᵟ = $(ml.CRiᵟ)\n",
" └── Stability function lower Ri: CRi⁰ = $(ml.CRi⁰)")