xso.solvers.SolverABC
- class xso.solvers.SolverABC[source]
Abstract base class of backend solver class, use subclass to solve model within the XSO framework.
- __init__()
Methods
__init__()add_forcing(label, flux, time)Method to reformat a forcing function for use with solver, should return storage object of value.
add_parameter(label, value)Method to reformat a parameter object for use with solver.
add_variable(label, initial_value, model)Method to reformat a variable object for use with solver, should return storage object of value.
assemble(model)Method to initialize model.
cleanup()Method to clean up temporary storage or perform other actions after the model has been run.
register_flux(label, flux, model, dims)Method to reformat a flux function for use with solver, should return storage object of value.
solve(model, time_step)Method to solve model, specific to solver chosen.