wolfgpu.simplesimu.durations

Module Contents

class wolfgpu.simplesimu.durations.SimulationDurationType(*args, **kwds)

Bases: enum.Enum

A type of duration.

This was introduced to abstract the duration of a simulation.

SECONDS = 0

A duration expressed in seconds.

STEPS = 1

A duration expressed in steps.

class wolfgpu.simplesimu.durations.SimulationDuration(_type: SimulationDurationType, duration: float | int)

In the GPU simulator, we represent durations about the simulation either as number of simulation steps either as simulation time (in seconds). This class can represent both.

type

duration

to_dict()

classmethod from_dict(d)

classmethod from_seconds(seconds) → SimulationDuration

classmethod from_steps(steps) → SimulationDuration

classmethod from_str(d: str) → SimulationDuration

classmethod zero_like(d) → SimulationDuration

is_zero()

class wolfgpu.simplesimu.durations.ReportFrequencyType(*args, **kwds)

Bases: enum.Enum

When specifying the report period, one can use two different units.

ITERATION = 1

Report period in iterations

SIMULATION_TIME = 0

Report period in simulation time (seconds)

class wolfgpu.simplesimu.durations.TimeStepStrategy(*args, **kwds)

Bases: enum.Enum

Describes the way the time step is computed on each simulation step.

FIXED_TIME_STEP = 1

The time step is constant over all simulation steps.

OPTIMIZED_TIME_STEP = 2

The time step is the maximum of the minimum time steps authorized by the Courant formula.