sofirpy.simulation.simulation_entity module
Module containing abstract class SimulationEntity
- class sofirpy.simulation.simulation_entity.SimulationEntity[source]
Bases:
ABC
Abstract object representing a simulation entity.
- abstract do_step(time: float) None [source]
Perform a simulation step.
- Parameters:
time (float) – current simulation time
- get_dtype_of_parameter(parameter_name: str) type [source]
Return the data type of a parameter.
- Parameters:
parameter_name (str) – Name of the parameter.
- Returns:
Data type of the parameter.
- Return type:
type
- abstract get_parameter_value(parameter_name: str) bool | float | int | str | object [source]
Return the value of a parameter.
- Parameters:
parameter_name (str) – name of parameter whose value is to be obtained
- Returns:
value of the parameter
- Return type:
ParameterValue
- get_unit(parameter_name: str) str | None [source]
Return the unit of a parameter.
- Parameters:
parameter_name (str) – Name of the parameter.
- Returns:
Unit of the parameter.
- Return type:
str | None