mufem.UnsteadyRunner
- class mufem.UnsteadyRunner
Bases:
RunnerTrait
Unsteady runner implementing time-stepping simulation.
- Parameters:
total_time (float) – The total simulation time.
time_step_size (float) – The time step size.
total_inner_iterations (int) – The number of inner iterations at each time step.
- __init__(self: mufem.UnsteadyRunner, total_time: float, time_step_size: float, total_inner_iterations: int) None
Methods
__init__
(self, total_time, time_step_size, ...)advance
(self[, time_steps])Advance the simulation by a given number of time steps.
get_time
(self)Get the current simulation time.
get_time_step_size
(self)Get the current time step size.
get_total_time
(self)Get the total simulation time.
run
(self)Run the time-stepping simulation.
set_time_step_size
(self, time_step_size)Set the time step size.
set_total_time
(self, total_time)Set the total simulation time.
- advance(self: mufem.UnsteadyRunner, time_steps: int = 1) None
Advance the simulation by a given number of time steps.
- Parameters:
time_steps (int, optional) – Number of time steps to advance. Defaults to 1.
- get_time(self: mufem.UnsteadyRunner) float
Get the current simulation time.
- Returns:
The current simulation time.
- Return type:
float
- get_time_step_size(self: mufem.UnsteadyRunner) float
Get the current time step size.
- Returns:
The current time step size.
- Return type:
float
- get_total_time(self: mufem.UnsteadyRunner) float
Get the total simulation time.
- Returns:
The total simulation time.
- Return type:
float
- run(self: mufem.UnsteadyRunner) None
Run the time-stepping simulation.
Executes the unsteady simulation loop using the configured total time and time step size.
- set_time_step_size(self: mufem.UnsteadyRunner, time_step_size: float) None
Set the time step size.
- Parameters:
time_step_size (float) – The new time step size.
- set_total_time(self: mufem.UnsteadyRunner, total_time: float) None
Set the total simulation time.
- Parameters:
total_time (float) – The new total simulation time.