svMultiPhysics Documentation error: description on Ri/R1

Problem

The current documentation on svMultiPhysics says:
Ri/R1 = (Initial linear system norm / Initial nonlinear norm) / (First nonlinear iteration norm)

But I believe the definition is somewhat subtly misleading.

in pic.cpp (svMultiPhysics) (first Newton iteration of the current time-step):

if (eq.itr == 1) {               // only when Newton iter = 1
    eq.pNorm = eq.FSILS.RI.iNorm // ‖R_linear,0‖
              / eq.iNorm;        // ‖R_nonlinear,0‖
}

-> From these lines, we can know that eq.pNorm stores the step-local ratio:
(Ri/R0)_iter1 = ||R_lin,0|| / |R_nonlinear,0||

in output.cpp (svMultiPhysics) (whenever a Newton line is printed)

tmp  = eq.FSILS.RI.iNorm / eq.iNorm;  // Ri/R0 for this Newton iter
tmp1 = tmp / eq.pNorm;                // Ri/R1 = (Ri/R0)_this iter/(Ri/R0)_iter1

-> For Newton 1 of a step, tmp equals eq.pNorm, so tmp1 = 1.
-> For later Newton iterations, the denominator stays fixed while the numerator changes, giving a true convergence measure.

Let
L_i = ‖R_(i)lin,0‖ (initial linear residual at Newton i)
N_i = ‖R_(i)nonlinear,0|| (initial non-linear residual at Newton i)

Then the code prints
Ri/R0 = Ri/Ni
Ri/R1 = (Li/Ni) / (L1/N1)

So the definition should be fixed as “Ri/R1 = (Initial linear / Initial non-linear) / (First linear / First non-linear-iteration norm)"

Solution

The definition should be fixed
from Ri/R1 = (Initial linear system norm / Initial nonlinear norm) / (First nonlinear iteration norm)
to as Ri/R1 = (Initial linear / Initial non-linear) / (First linear / First non-linear-iteration norm)

Additional context

P.S. I wanted to put documentation label, not enhancement label on this post, but I couldn't find a way to do so...

Code of Conduct

• I agree to follow this project's Code of Conduct and Contributing Guidelines

Read the Ri/R1 documentation entry together with the referenced pic.cpp and output.cpp snippets. Locate the documentation text containing the current definition, update it to match the stated ratio using the first linear/nonlinear values, and verify that the published wording reflects the issue’s formula.