RelativeEnergyIncrTest

RelativeEnergyIncrTest(tol: float, max_iter: int, print_flag: int = 0)

Bases: Test

Relative energy increment convergence test.

RelativeEnergyIncrTest compares the current energy increment against the initial energy increment scaled by a tolerance.

Tcl form

test RelativeEnergyIncr <tol> <maxIter> <printFlag>

Example

from femora.core.model import Model

model = Model()
test = model.analysis.test.relativeenergyincr(
    tol=1e-6,
    max_iter=100,
    print_flag=1,
)

Create a RelativeEnergyIncr convergence test.

Parameters:

Name	Type	Description	Default
`tol`	`float`	Tolerance criteria for convergence.	required
`max_iter`	`int`	Maximum number of iterations to perform before returning failure.	required
`print_flag`	`int`	Print control flag. 0 prints nothing, 1 prints norm info each iteration, 2 prints norms and iterations at success, 4 prints norms, displacement, and residual vectors, 5 prints warnings only.	`0`