API Reference

ebtelplusplus

Functions

run(total_time, loop_length, *[, heating, ...])

Run an ebtelplusplus simulation

Classes

EbtelResult(results, inputs)

Result of an ebtelplusplus simulation

ebtelplusplus.models

Classes for configuring inputs to ebtelplusplus.run. All model inputs have default values such that each model only need be instantiated using the values of the parameters a user wants to change. The default values of each input are listed below.

Classes

PhysicsModel([saturation_limit, ...])	ebtelplusplus input parameters related to the physics of the simulation
SolverModel([tau, tau_max, ...])	ebtelplusplus input parameters related to the numerical solver
DemModel([calculate_dem, use_new_tr_method, ...])	ebtelplusplus input parameters related to differential emission measure (DEM) calculation.
HeatingModel([background, partition, events])	ebtelplusplus input parameters for time-dependent heating
HeatingEvent(start, duration, duration_rise, ...)	Single heating event
TriangularHeatingEvent(start, duration, rate)	A single event with a linear rise phase immediately followed by a linear decay phase of equal duration
SquareHeatingEvent(start, duration, rate)	A single event with no rise or decay phase and only a constant phase

Class Inheritance Diagram