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

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

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

HeatEquationSolver

Contents

HeatEquationSolver#