aivika-6.1.1: A multi-method simulation library

Copyright	Copyright (c) 2009-2017 David Sorokin <david.sorokin@gmail.com>
License	BSD3
Maintainer	David Sorokin <david.sorokin@gmail.com>
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Simulation.Aivika.Internal.Specs

Description

Tested with: GHC 8.0.1

It defines the simulation specs and related stuff.

Synopsis

data Specs = Specs {
- spcStartTime :: Double
- spcStopTime :: Double
- spcDT :: Double
- spcMethod :: Method
- spcGeneratorType :: GeneratorType
}
data Method
- = Euler
- | RungeKutta2
- | RungeKutta4
- | RungeKutta4b
data Run = Run {
- runSpecs :: Specs
- runIndex :: Int
- runCount :: Int
- runEventQueue :: EventQueue
- runGenerator :: Generator
}
data Point = Point {
- pointSpecs :: Specs
- pointRun :: Run
- pointTime :: Double
- pointPriority :: EventPriority
- pointIteration :: Int
- pointPhase :: Int
}
type EventPriority = Int
data EventQueue = EventQueue {
- queuePQ :: PriorityQueue (Point -> IO ())
- queueBusy :: IORef Bool
- queueTime :: IORef Double
}
newEventQueue :: Specs -> IO EventQueue
basicTime :: Specs -> Int -> Int -> Double
integIterationBnds :: Specs -> (Int, Int)
integIterationHiBnd :: Specs -> Int
integIterationLoBnd :: Specs -> Int
integPhaseBnds :: Specs -> (Int, Int)
integPhaseHiBnd :: Specs -> Int
integPhaseLoBnd :: Specs -> Int
integTimes :: Specs -> [Double]
integPoints :: Run -> [Point]
integPointsStartingFrom :: Point -> [Point]
integStartPoint :: Run -> Point
integStopPoint :: Run -> Point
simulationStopPoint :: Run -> Point
timeGrid :: Specs -> Int -> [(Int, Double)]
pointAt :: Run -> Double -> EventPriority -> Point
delayPoint :: Point -> Int -> Point

Documentation

data Specs Source #

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 Source #

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

Instances details

Show Method Source #
Instance details Defined in Simulation.Aivika.Internal.Specs Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
Eq Method Source #
Instance details Defined in Simulation.Aivika.Internal.Specs Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #
Ord Method Source #
Instance details 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 Source #

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 Source #

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 Source #

The event priority (greater is higher).

data EventQueue Source #

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 Source #

Create a new event queue by the specified specs.

basicTime :: Specs -> Int -> Int -> Double Source #

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

integIterationBnds :: Specs -> (Int, Int) Source #

Returns the first and last integration iterations.

integIterationHiBnd :: Specs -> Int Source #

Returns the last integration iteration.

integIterationLoBnd :: Specs -> Int Source #

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

integPhaseBnds :: Specs -> (Int, Int) Source #

Returns the first and last integration phases.

integPhaseHiBnd :: Specs -> Int Source #

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

integPhaseLoBnd :: Specs -> Int Source #

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

integTimes :: Specs -> [Double] Source #

Return the integration time values.

integPoints :: Run -> [Point] Source #

Return the integration time points.

integPointsStartingFrom :: Point -> [Point] Source #

Return the integration time points starting from the specified iteration.

integStartPoint :: Run -> Point Source #

Return the start time point.

integStopPoint :: Run -> Point Source #

Return the integration stop time point.

simulationStopPoint :: Run -> Point Source #

Return the simulation stop time point.

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

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

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

Return the point at the specified time given the priority.

delayPoint :: Point -> Int -> Point Source #

Delay the point by the specified positive number of iterations.