wolfgpu.simplesimu.durations
============================

.. py:module:: wolfgpu.simplesimu.durations




Module Contents
---------------

.. py:class:: SimulationDurationType(*args, **kwds)

   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: wolfgpu.simplesimu.durations.SimulationDurationType
      :parts: 1
      :private-bases:


   A type of duration.

   This was introduced to abstract the duration of a simulation.


   .. py:attribute:: SECONDS
      :value: 0


      A duration expressed in seconds.


   .. py:attribute:: STEPS
      :value: 1


      A duration expressed in steps.


.. py:class:: SimulationDuration(_type: SimulationDurationType, duration: Union[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.


   .. py:attribute:: type


   .. py:attribute:: duration


   .. py:method:: to_dict()


   .. py:method:: from_dict(d)
      :classmethod:



   .. py:method:: from_seconds(seconds) -> SimulationDuration
      :classmethod:



   .. py:method:: from_steps(steps) -> SimulationDuration
      :classmethod:



   .. py:method:: from_str(d: str) -> SimulationDuration
      :classmethod:



   .. py:method:: zero_like(d) -> SimulationDuration
      :classmethod:



   .. py:method:: is_zero()


.. py:class:: ReportFrequencyType(*args, **kwds)

   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: wolfgpu.simplesimu.durations.ReportFrequencyType
      :parts: 1
      :private-bases:


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


   .. py:attribute:: ITERATION
      :value: 1


      Report period in iterations


   .. py:attribute:: SIMULATION_TIME
      :value: 0


      Report period in simulation time (seconds)


.. py:class:: TimeStepStrategy(*args, **kwds)

   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: wolfgpu.simplesimu.durations.TimeStepStrategy
      :parts: 1
      :private-bases:


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



   .. py:attribute:: FIXED_TIME_STEP
      :value: 1


      The time step is constant over all simulation steps.


   .. py:attribute:: OPTIMIZED_TIME_STEP
      :value: 2


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