LinearSolver

class LinearSolver

Bases: Flow360BaseModel

LinearSolver class for setting up the linear solver.

Example

>>> fl.LinearSolver(
...     max_iterations=50,
...     absoluteTolerance=1e-10
... )

Attributes

max_iterations: int

Maximum number of linear solver iterations.

Default:

30

absolute_tolerance: float, optional

The linear solver converges when the final residual of the pseudo steps below this value.Either absolute tolerance or relative tolerance can be used to determine convergence.

Default:

None

relative_tolerance: float, optional

The linear solver converges when the ratio of the final residual and the initial residual of the pseudo step is below this value.

Default:

None

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')