tardis.simulation.convergence module

class tardis.simulation.convergence.ConvergenceSolver(strategy)

Bases: object

Convergence solver. Sets convergence strategy and assigns a method to the converge property.

Parameters:

strategystring

Convergence strategy for the physical property

Raises:

NotImplementedError

Custom convergence type specified

ValueError

Unknown convergence type specified

damped_converge(value, estimated_value)

Damped convergence solver

Parameters:

valuenp.float64

The current value of the physical property

estimated_valuenp.float64

The estimated value of the physical property

Returns:

np.float64

The converged value

get_convergence_status(value, estimated_value, no_of_cells)

Get the status of convergence for the physical property

Parameters:

valuenp.float64, Quantity

The current value of the physical property

estimated_valuenp.float64, Quantity

The estimated value of the physical property

no_of_cellsnp.int64

The number of cells to measure convergence over

Returns:

bool

True if convergence is reached