aivika-transformers-5.9: Transformers for the Aivika 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	None
Language	Haskell2010

Simulation.Aivika.Trans.Internal.Specs

Description

Tested with: GHC 8.0.1

It defines the simulation specs and related stuff.

Synopsis

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

Documentation

data Specs m 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 m the type of 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

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

data Run m Source #

It indentifies the simulation run.

Constructors

Run
Fields runSpecs :: Specs m the simulation specs runIndex :: Int the current simulation run index runCount :: Int the total number of runs within the experiment runEventQueue :: EventQueue m the event queue runGenerator :: Generator m the random number generator

data Point m Source #

It defines the simulation point appended with the additional information.

Constructors

Point
Fields pointSpecs :: Specs m the simulation specs pointRun :: Run m the simulation run pointTime :: Double the current time pointIteration :: Int the current iteration pointPhase :: Int the current phase

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

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

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

Returns the first and last integration iterations.

integIterationHiBnd :: Specs m -> Int Source #

Returns the last integration iteration.

integIterationLoBnd :: Specs m -> Int Source #

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

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

Returns the first and last integration phases.

integPhaseHiBnd :: Specs m -> Int Source #

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

integPhaseLoBnd :: Specs m -> Int Source #

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

integTimes :: Specs m -> [Double] Source #

Return the integration time values.

integPoints :: Run m -> [Point m] Source #

Return the integration time points.

integPointsStartingFrom :: Point m -> [Point m] Source #

Return the integration time points startin from the specified iteration.

integStartPoint :: Run m -> Point m Source #

Return the start time point.

integStopPoint :: Run m -> Point m Source #

Return the integration stop time point.

simulationStopPoint :: Run m -> Point m Source #

Return the simulation stop time point.

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

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

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

Return the point at the specified time.

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

Delay the point by the specified positive number of iterations.