LineSearch

class LineSearch

Bases: Flow360BaseModel

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

Example

>>> fl.LineSearch(
...     residual_growth_threshold=0.85,
...     max_residual_growth=1.1,
...     activation_step=100,
... )

Attributes

residual_growth_threshold: float

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

Default:

0.85

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.1

activation_step: int

Pseudotime step threshold before the max_residual_growth limit is activated.

Default:

100

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')