|
| 1 | +@concrete struct NonlinearSolveTraceEntry |
| 2 | + iteration::Int |
| 3 | + fnorm |
| 4 | + stepnorm |
| 5 | + condJ |
| 6 | + J |
| 7 | + u |
| 8 | + fu |
| 9 | + δu |
| 10 | +end |
| 11 | + |
| 12 | +function __show_top_level(io::IO, entry::NonlinearSolveTraceEntry) |
| 13 | + if entry.condJ === nothing |
| 14 | + @printf io "%-6s %-20s %-20s\n" "Iter" "f(u) inf-norm" "Step 2-norm" |
| 15 | + @printf io "%-6s %-20s %-20s\n" "----" "-------------" "-----------" |
| 16 | + else |
| 17 | + @printf io "%-6s %-20s %-20s %-20s\n" "Iter" "f(u) inf-norm" "Step 2-norm" "cond(J)" |
| 18 | + @printf io "%-6s %-20s %-20s %-20s\n" "----" "-------------" "-----------" "-------" |
| 19 | + end |
| 20 | +end |
| 21 | + |
| 22 | +function Base.show(io::IO, entry::NonlinearSolveTraceEntry) |
| 23 | + entry.iteration == 0 && __show_top_level(io, entry) |
| 24 | + if entry.condJ === nothing |
| 25 | + @printf io "%-6d %-20.8e %-20.8e\n" entry.iteration entry.fnorm entry.stepnorm |
| 26 | + else |
| 27 | + @printf io "%-6d %-20.8e %-20.8e %-20.8e\n" entry.iteration entry.fnorm entry.stepnorm entry.condJ |
| 28 | + end |
| 29 | + return nothing |
| 30 | +end |
| 31 | + |
| 32 | +function NonlinearSolveTraceEntry(iteration, fu, δu) |
| 33 | + return NonlinearSolveTraceEntry(iteration, norm(fu, Inf), norm(δu, 2), nothing, |
| 34 | + nothing, nothing, nothing, nothing) |
| 35 | +end |
| 36 | + |
| 37 | +function NonlinearSolveTraceEntry(iteration, fu, δu, J) |
| 38 | + return NonlinearSolveTraceEntry(iteration, norm(fu, Inf), norm(δu, 2), __cond(J), nothing, |
| 39 | + nothing, nothing, nothing) |
| 40 | +end |
| 41 | + |
| 42 | +function NonlinearSolveTraceEntry(iteration, fu, δu, J, u) |
| 43 | + return NonlinearSolveTraceEntry(iteration, norm(fu, Inf), norm(δu, 2), __cond(J), |
| 44 | + copy(J), copy(u), copy(fu), copy(δu)) |
| 45 | +end |
| 46 | + |
| 47 | +__cond(J::AbstractMatrix) = cond(J) |
| 48 | +__cond(J) = NaN # Covers cases where `J` is a Operator, nothing, etc. |
| 49 | + |
| 50 | +@concrete struct NonlinearSolveTrace{show_trace, trace_level, store_trace} |
| 51 | + history |
| 52 | +end |
| 53 | + |
| 54 | +function Base.show(io::IO, trace::NonlinearSolveTrace) |
| 55 | + for entry in trace.history |
| 56 | + show(io, entry) |
| 57 | + end |
| 58 | + return nothing |
| 59 | +end |
| 60 | + |
| 61 | +function init_nonlinearsolve_trace(u, fu, J, δu; show_trace::Val = Val(false), |
| 62 | + trace_level::Val = Val(1), store_trace::Val = Val(false), kwargs...) |
| 63 | + return init_nonlinearsolve_trace(show_trace, trace_level, store_trace, u, fu, J, δu) |
| 64 | +end |
| 65 | + |
| 66 | +function init_nonlinearsolve_trace(::Val{show_trace}, ::Val{trace_level}, |
| 67 | + ::Val{store_trace}, u, fu, J, δu) where {show_trace, trace_level, store_trace} |
| 68 | + history = __init_trace_history(Val{show_trace}(), Val{trace_level}(), |
| 69 | + Val{store_trace}(), u, fu, J, δu) |
| 70 | + return NonlinearSolveTrace{show_trace, trace_level, store_trace}(history) |
| 71 | +end |
| 72 | + |
| 73 | +function __init_trace_history(::Val{show_trace}, ::Val{trace_level}, ::Val{store_trace}, u, |
| 74 | + fu, J, δu) where {show_trace, trace_level, store_trace} |
| 75 | + !store_trace && !show_trace && return nothing |
| 76 | + entry = __trace_entry(Val{trace_level}(), 0, u, fu, J, δu) |
| 77 | + show_trace && show(entry) |
| 78 | + store_trace && return [entry] |
| 79 | + return nothing |
| 80 | +end |
| 81 | + |
| 82 | +__trace_entry(::Val{1}, iter, u, fu, J, δu) = NonlinearSolveTraceEntry(iter, fu, δu) |
| 83 | +__trace_entry(::Val{2}, iter, u, fu, J, δu) = NonlinearSolveTraceEntry(iter, fu, δu, J) |
| 84 | +__trace_entry(::Val{3}, iter, u, fu, J, δu) = NonlinearSolveTraceEntry(iter, fu, δu, J, u) |
| 85 | +function __trace_entry(::Val{T}, iter, u, fu, J, δu) where {T} |
| 86 | + throw(ArgumentError("::Val{trace_level} == ::Val{$(T)} is not supported. \ |
| 87 | + Possible values are `Val{1}()`/`Val{2}()`/`Val{3}()`.")) |
| 88 | +end |
| 89 | + |
| 90 | +function update_trace!(trace::NonlinearSolveTrace{ShT, TrL, StT}, iter, u, fu, J, |
| 91 | + δu) where {ShT, TrL, StT} |
| 92 | + !StT && !ShT && return nothing |
| 93 | + entry = __trace_entry(Val{TrL}(), iter, u, fu, J, δu) |
| 94 | + StT && push!(trace.history, entry) |
| 95 | + ShT && show(entry) |
| 96 | + return trace |
| 97 | +end |
| 98 | + |
| 99 | +# Needed for Algorithms which directly use `inv(J)` instead of `J` |
| 100 | +function update_trace_with_invJ!(trace::NonlinearSolveTrace{ShT, TrL, StT}, iter, u, fu, J, |
| 101 | + δu) where {ShT, TrL, StT} |
| 102 | + !StT && !ShT && return nothing |
| 103 | + if TrL == 1 |
| 104 | + entry = __trace_entry(Val{1}(), iter, u, fu, J, δu) |
| 105 | + else |
| 106 | + entry = __trace_entry(Val{TrL}(), iter, u, fu, inv(J), δu) |
| 107 | + end |
| 108 | + StT && push!(trace.history, entry) |
| 109 | + ShT && show(entry) |
| 110 | + return trace |
| 111 | +end |
| 112 | + |
0 commit comments