HeatEquationSolver

HeatEquationSolver#

class HeatEquationSolver[source]#

Bases: GenericSolverSettings

HeatEquationSolver class for setting up heat equation solver.

Example

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

Attributes

absolute_tolerance: float#

Absolute residual tolerance that determines the convergence of the heat equation in conjugate heat transfer. This value should be the same or higher than the absolute tolerance for the linear solver by a small margin.

Default:

1e-09

relative_tolerance: float#

Tolerance to the relative residual, below which the solver goes to the next physical step. Relative residual is defined as the ratio of the current pseudoStep’s residual to the maximum residual present in the first 10 pseudoSteps within the current physicalStep. NOTE: relativeTolerance is ignored in steady simulations and only absoluteTolerance is used as the convergence criterion.

Default:

0

order_of_accuracy: Literal[2]#

Order of accuracy in space.

Default:

2

equation_evaluation_frequency: int#

Frequency at which to solve the heat equation in conjugate heat transfer simulations.

Default:

10

linear_solver: LinearSolver#

Linear solver settings, see LinearSolver documentation.

Default:

LinearSolver()

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