pymloc.solvers.base_solver¶
Classes
|
Base class for all solvers. |
|
Class provides the current level of a solver inside the multilevel approach. |
|
Class for the solution of a solver run |
|
Solution subclass that allows for solutions on a time-grid |
-
class
pymloc.solvers.base_solver.BaseSolver(model=None, abs_tol=0.001, rel_tol=0.001, max_iter=10)¶ Bases:
abc.ABCBase class for all solvers. Sets common attributes and handles running the solver.
- Parameters
model (Optional[Solvable]) –
abs_tol (float) –
rel_tol (float) –
max_iter (int) –
-
abort(residual)¶ - Parameters
residual (numpy.ndarray) –
- Return type
float
-
property
model¶
-
output()¶
-
run(*args, **kwargs)¶ - Return type
-
class
pymloc.solvers.base_solver.Level¶ Bases:
objectClass provides the current level of a solver inside the multilevel approach. Used by loggers to filter and format the output.
-
static
get_instance()¶ - Return type
None
-
static
-
class
pymloc.solvers.base_solver.Solution(solution, params=None)¶ Bases:
objectClass for the solution of a solver run
- Parameters
solution (np.ndarray) –
-
property
params¶
-
property
solution¶
-
class
pymloc.solvers.base_solver.TimeSolution(time_grid, solution, interpolation=False, dynamic_update=None, params=None)¶ Bases:
pymloc.solvers.base_solver.SolutionSolution subclass that allows for solutions on a time-grid
- Parameters
time_grid (np.ndarray) –
solution (np.ndarray) –
interpolation (bool) –
-
property
dynamic_update¶
-
property
interpolation¶
-
property
time_grid¶