pymloc.solvers.base_solver

Classes

BaseSolver([model, abs_tol, rel_tol, max_iter])

Base class for all solvers.

Level()

Class provides the current level of a solver inside the multilevel approach.

Solution(solution[, params])

Class for the solution of a solver run

TimeSolution(time_grid, solution[, …])

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.ABC

Base 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

pymloc.solvers.base_solver.Solution

class pymloc.solvers.base_solver.Level

Bases: object

Class 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

class pymloc.solvers.base_solver.Solution(solution, params=None)

Bases: object

Class 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.Solution

Solution 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