Simulation.Aivika.Internal.Specs

Tested with: GHC 8.0.1

It defines the simulation specs and related stuff.

Documentation

data Specs

It defines the simulation specs.

Constructors

Specs

Fields

• spcStartTime :: Double

  the start time

• spcStopTime :: Double

  the stop time

• spcDT :: Double

  the integration time step

• spcMethod :: Method

  the integration method

• spcGeneratorType :: GeneratorType

  the type of the random number generator

data Method

It defines the integration method.

Constructors

Euler

Euler's method

RungeKutta2

the 2nd order Runge-Kutta method

RungeKutta4

the 4th order Runge-Kutta method

RungeKutta4b

the 4th order Runge-Kutta 3/8-method

Instances

Show Method

Defined in Simulation.Aivika.Internal.Specs

Methods

showsPrec :: Int -> Method -> ShowS

show :: Method -> String

showList :: [Method] -> ShowS

Eq Method

Defined in Simulation.Aivika.Internal.Specs

Methods

(==) :: Method -> Method -> Bool

(/=) :: Method -> Method -> Bool

Ord Method

Defined in Simulation.Aivika.Internal.Specs

Methods

compare :: Method -> Method -> Ordering

(<) :: Method -> Method -> Bool

(<=) :: Method -> Method -> Bool

(>) :: Method -> Method -> Bool

(>=) :: Method -> Method -> Bool

max :: Method -> Method -> Method

min :: Method -> Method -> Method

data Run

It indentifies the simulation run.

Constructors

Run

Fields

• runSpecs :: Specs

  the simulation specs

• runIndex :: Int

  the current simulation run index

• runCount :: Int

  the total number of runs in this experiment

• runEventQueue :: EventQueue

  the event queue

• runGenerator :: Generator

  the random number generator

data Point

It defines the simulation point appended with the additional information.

Constructors

Point

Fields

• pointSpecs :: Specs

  the simulation specs

• pointRun :: Run

  the simulation run

• pointTime :: Double

  the current time

• pointPriority :: EventPriority

  the current priority

• pointIteration :: Int

  the current iteration

• pointPhase :: Int

  the current phase

type EventPriority = Int

The event priority (greater is higher).

data EventQueue

It represents the event queue.

Constructors

EventQueue

Fields

• queuePQ :: PriorityQueue (Point -> IO ())

  the underlying priority queue

• queueBusy :: IORef Bool

  whether the queue is currently processing events

• queueTime :: IORef Double

  the actual time of the event queue

newEventQueue :: Specs -> IO EventQueue

Create a new event queue by the specified specs.

basicTime :: Specs -> Int -> Int -> Double

Returns a simulation time for the integration point specified by the specs, iteration and phase.

integIterationBnds :: Specs -> (Int, Int)

Returns the first and last integration iterations.

integIterationHiBnd :: Specs -> Int

Returns the last integration iteration.

integIterationLoBnd :: Specs -> Int

Returns the first integration iteration, i.e. zero.

integPhaseBnds :: Specs -> (Int, Int)

Returns the first and last integration phases.

integPhaseHiBnd :: Specs -> Int

Returns the last integration phase, 0 for Euler's method, 1 for RK2 and 3 for RK4.

integPhaseLoBnd :: Specs -> Int

Returns the first integration phase, i.e. zero.

integTimes :: Specs -> [Double]

Return the integration time values.

integPoints :: Run -> [Point]

Return the integration time points.

integPointsStartingFrom :: Point -> [Point]

Return the integration time points starting from the specified iteration.

integStartPoint :: Run -> Point

Return the start time point.

integStopPoint :: Run -> Point

Return the integration stop time point.

simulationStopPoint :: Run -> Point

Return the simulation stop time point.

timeGrid :: Specs -> Int -> [(Int, Double)]

Return the indexed time values in the grid by specified size.

pointAt :: Run -> Double -> EventPriority -> Point

Return the point at the specified time given the priority.

delayPoint :: Point -> Int -> Point

Delay the point by the specified positive number of iterations.