run#

ebtelplusplus.run(total_time, loop_length, *, heating=None, physics=None, solver=None, dem=None)[source]#

Run an ebtelplusplus simulation

To run an ebtelplusplus simulation, at a minimum, you must specify a total simulation time and a loop half length. Additional input parameters are configured through high-level objects as listed below. Most users will likely want to modify the heating input by constructing a HeatingModel that specifies the amount of energy injected into the simulation as a function of time. Additional inputs are documented in the docstring of each respective input model.

Parameters:

  • total_time (IrreducibleUnit) – Total duration of the simulation

  • loop_length (Unit) – Loop half length

  • heating (HeatingModel, optional) – Configuration of heating model

  • physics (PhysicsModel, optional) – Configuration parameters related to the physics of the simulation

  • solver (SolverModel, optional) – Configuration parameters related to the numerical solver

  • dem (DemModel, optional) – Configuration parameters related to the DEM calculation

Returns:

results – Data structure holding the results of the ebtelplusplus calculation

Return type:

EbtelResult