LineSearch

LineSearch#

class LineSearch[source]#

Bases: Flow360BaseModel

LineSearch class for configuring line search parameters used with the Krylov solver.

Example

>>> fl.LineSearch(
...     residual_growth_threshold=0.9,
...     max_residual_growth=1.2,
...     activation_step=200,
... )

Attributes

residual_growth_threshold: float#

Pseudotime nonlinear residual norm convergence ratio above which residual norm increase is allowed.

Default:

0.9

max_residual_growth: float#

Hard cap on the residual norm ratio — never allow the residual norm to grow beyond this factor over a single pseudotime step.

Default:

1.2

activation_step: int#

Pseudotime step threshold before the max_residual_growth limit is activated.

Default:

200

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None