Skip to content

Commit 6f81a2c

Browse files
committed
more fix
1 parent f11e23d commit 6f81a2c

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

src/saturation_adjustment.jl

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -594,6 +594,10 @@ branch-free execution on GPUs. For typical atmospheric conditions (T < 320 K),
594594
this achieves better than 0.1 K accuracy.
595595
596596
For more control over solver parameters, use the full signature with explicit method type.
597+
598+
# Returns
599+
- `NamedTuple` `(; T, q_liq, q_ice)` — note: `converged` is not included; fixed iterations
600+
always succeed by construction.
597601
"""
598602
function saturation_adjustment(
599603
param_set::APS,
@@ -624,6 +628,10 @@ branch-free execution on GPUs. For typical atmospheric conditions (T < 320 K),
624628
this achieves better than 0.1 K accuracy.
625629
626630
For more control over solver parameters, use the full signature with explicit method type.
631+
632+
# Returns
633+
- `NamedTuple` `(; T, q_liq, q_ice)` — note: `converged` is not included; fixed iterations
634+
always succeed by construction.
627635
"""
628636
function saturation_adjustment(
629637
param_set::APS,
@@ -654,6 +662,10 @@ branch-free execution on GPUs. For typical atmospheric conditions (T < 320 K),
654662
this achieves better than 0.1 K accuracy.
655663
656664
For more control over solver parameters, use the full signature with explicit method type.
665+
666+
# Returns
667+
- `NamedTuple` `(; T, q_liq, q_ice)` — note: `converged` is not included; fixed iterations
668+
always succeed by construction.
657669
"""
658670
function saturation_adjustment(
659671
param_set::APS,
@@ -662,6 +674,7 @@ function saturation_adjustment(
662674
h,
663675
q_tot;
664676
maxiter::Int = 2,
677+
tol = nothing,
665678
)
666679
sa_result = saturation_adjustment_fixed_iters(param_set, ph(), p, h, q_tot, maxiter)
667680
return (; sa_result.T, sa_result.q_liq, sa_result.q_ice)
@@ -684,6 +697,10 @@ branch-free execution on GPUs. For typical atmospheric conditions (T < 320 K),
684697
this achieves better than 0.1 K accuracy.
685698
686699
For more control over solver parameters, use the full signature with explicit method type.
700+
701+
# Returns
702+
- `NamedTuple` `(; T, q_liq, q_ice)` — note: `converged` is not included; fixed iterations
703+
always succeed by construction.
687704
"""
688705
function saturation_adjustment(
689706
param_set::APS,
@@ -692,6 +709,7 @@ function saturation_adjustment(
692709
θ_li,
693710
q_tot;
694711
maxiter::Int = 2,
712+
tol = nothing,
695713
)
696714
sa_result =
697715
saturation_adjustment_fixed_iters(param_set, pθ_li(), p, θ_li, q_tot, maxiter)
@@ -715,6 +733,10 @@ branch-free execution on GPUs. For typical atmospheric conditions (T < 320 K),
715733
this achieves better than 0.1 K accuracy.
716734
717735
For more control over solver parameters, use the full signature with explicit method type.
736+
737+
# Returns
738+
- `NamedTuple` `(; T, q_liq, q_ice)` — note: `converged` is not included; fixed iterations
739+
always succeed by construction.
718740
"""
719741
function saturation_adjustment(
720742
param_set::APS,
@@ -746,6 +768,10 @@ branch-free execution on GPUs. For typical atmospheric conditions (T < 320 K),
746768
this achieves better than 0.1 K accuracy.
747769
748770
For more control over solver parameters, use the full signature with explicit method type.
771+
772+
# Returns
773+
- `NamedTuple` `(; T, q_liq, q_ice)` — note: `converged` is not included; fixed iterations
774+
always succeed by construction.
749775
"""
750776
function saturation_adjustment(
751777
param_set::APS,

0 commit comments

Comments
 (0)