Introduce logger type, remove module methods

docs/src/saturation_adjustment.jl

@@ -6,7 +6,6 @@ import Thermodynamics.Parameters as TP
 import CLIMAParameters as CP
 
 FT = Float64
-
 const param_set = TP.ThermodynamicsParameters(FT)
 
 profiles = TD.TestedProfiles.PhaseEquilProfiles(param_set, Array{FT});
@@ -55,19 +54,19 @@ ts_no_err = Dict(
             )
 
             @inbounds for NM in numerical_methods
-                TD.error_on_non_convergence() = false
                 ts_no_err[NM][n] = TD.PhaseEquil_dev_only(
+                    TD.NullLogger(),
                     param_set,
                     ρ[i],
                     e_int,
                     q_tot[k];
                     sat_adjust_method = NM,
                     maxiter = 10,
                 )
-                TD.error_on_non_convergence() = true
                 # @show n / prod(dims) * 100
                 try
                     ts[NM][n] = TD.PhaseEquil_dev_only(
+                        TD.ErrorLogger(),
                         param_set,
                         ρ[i],
                         e_int,

perf/jet.jl

@@ -1,9 +1,5 @@
 include("common_micro_bm.jl")
 
-# JET does not like KernelAbstractions.@print calls,
-# so we disable them here.
-TD.print_warning() = false
-
 function jet_thermo_states(::Type{FT}) where {FT}
     param_set = TP.ThermodynamicsParameters(FT)
     ArrayType = Array{FT}
@@ -22,7 +18,7 @@ function jet_thermo_states(::Type{FT}) where {FT}
         )
             for cond in conditions(C)
                 args = sample_args(profiles, param_set, cond, C)
-                JET.@test_opt C(param_set, args...)
+                JET.@test_opt C(TD.NullLogger(), param_set, args...)
             end
         end
     end

src/DataCollection.jl

@@ -12,10 +12,9 @@ import Thermodynamics as TD
 import RootSolvers as RS
 
 function do_work()
-    # Calls TD.PhaseEquil_ρeq()..., possibly many times
+    # Calls TD.PhaseEquil_ρeq(VerboseLogger(WarningLogger()), )..., possibly many times
 end
 
-TD.solution_type() = RS.VerboseSolution()
 do_work()
 TD.DataCollection.print_summary()
 ```

src/Thermodynamics.jl

@@ -56,26 +56,14 @@ import .Parameters
 const TP = Parameters
 const APS = TP.ThermodynamicsParameters
 
-# Allow users to skip error on non-convergence
-# by importing:
-# ```julia
-# import Thermodynamics
-# Thermodynamics.error_on_non_convergence() = false
-# ```
-# Error on convergence must be the default
-# behavior because this can result in printing
-# very large logs resulting in CI to seemingly hang.
-@inline error_on_non_convergence() = true
-
-# Allow users to skip printing warnings on non-convergence
-@inline print_warning() = true
-
 @inline q_pt_0(::Type{FT}) where {FT} = PhasePartition(FT(0), FT(0), FT(0))
 
-@inline solution_type() = RS.CompactSolution()
 include("DataCollection.jl")
 import .DataCollection
 
+include("logger.jl")
+solution_type(::AbstractThermodynamicsLogger) = RS.CompactSolution()
+solution_type(::VerboseLogger) = RS.CompactSolution()
 include("states.jl")
 include("relations.jl")
 include("isentropic.jl")

src/logger.jl

@@ -0,0 +1,63 @@
+"""
+    AbstractThermodynamicsLogger
+
+A Thermodynamics logger can be passed to
+thermo state constructors that (may) perform
+saturation adjustment. This logger will statically
+decide if a warning statement is printed, or
+if the function should error on non-convergence.
+"""
+abstract type AbstractThermodynamicsLogger end
+const ATL = AbstractThermodynamicsLogger
+
+"""
+    WarningLogger
+
+Warn when saturation adjustment did not converge.
+"""
+struct WarningLogger <: AbstractThermodynamicsLogger end
+
+"""
+    ErrorLogger
+
+Error (but do not warn) when saturation adjustment
+did not converge.
+
+This is really only useful in our development docs.
+"""
+struct ErrorLogger <: AbstractThermodynamicsLogger end
+
+"""
+    WarnAndErrorLogger
+
+Warn and error (default) when saturation adjustment did not converge.
+"""
+struct WarnAndErrorLogger <: AbstractThermodynamicsLogger end
+
+"""
+    VerboseLogger
+
+A verbose logger, for when we use RootSolvers `VerboseSolution` type.
+"""
+struct VerboseLogger{L} <: AbstractThermodynamicsLogger
+    logger::L
+end
+
+"""
+    NullLogger
+
+Do nothing when saturation adjustment did not converge.
+"""
+struct NullLogger <: AbstractThermodynamicsLogger end
+
+warn_msg(::WarningLogger) = true
+warn_msg(::WarnAndErrorLogger) = true
+warn_msg(l::VerboseLogger) = warn_msg(l.logger)
+warn_msg(::AbstractThermodynamicsLogger) = false
+
+error_msg(::ErrorLogger) = true
+error_msg(::WarnAndErrorLogger) = true
+error_msg(l::VerboseLogger) = error_msg(l.logger)
+error_msg(::AbstractThermodynamicsLogger) = false
+
+Base.broadcastable(x::AbstractThermodynamicsLogger) = tuple(x)