SimParameter Class Reference
Structure which encapsulates all global simulation parameters. More...
#include <SimParameter.h>
Public Member Functions | |
| SimParameter (const Time &dt=SimParameter::Default.dt, const Time &minDelay=SimParameter::Default.minDelay, const Time &maxDelay=SimParameter::Default.maxDelay, uint32 constructionRNGSeed=0, uint32 simulationRNGSeed=0) | |
| Constructor. | |
| virtual | ~SimParameter () |
Public Attributes | |
| Time | dt |
| The simulation step size. | |
| Time | minDelay |
| The minimal delay allowed for spikes. | |
| Time | maxDelay |
| The maximal delay allowed for spikes as well as analog messages. | |
| uint32 | constructionRNGSeed |
| Seed for the random number generator used in the construction process. | |
| uint32 | simulationRNGSeed |
| Seed for random number generators used in the simulation phase. | |
Static Public Attributes | |
| static SimParameter | Default |
| This static member holds all the default values. | |
Detailed Description
Structure which encapsulates all global simulation parameters.Definition at line 8 of file SimParameter.h.
Constructor & Destructor Documentation
| SimParameter::SimParameter | ( | const Time & | dt = SimParameter::Default.dt, |
|
| const Time & | minDelay = SimParameter::Default.minDelay, |
|||
| const Time & | maxDelay = SimParameter::Default.maxDelay, |
|||
| uint32 | constructionRNGSeed = 0, |
|||
| uint32 | simulationRNGSeed = 0 | |||
| ) | [inline] |
Constructor.
Definition at line 15 of file SimParameter.h.
References Time::steps().
| virtual SimParameter::~SimParameter | ( | ) | [inline, virtual] |
Definition at line 31 of file SimParameter.h.
Member Data Documentation
The simulation step size.
Definition at line 34 of file SimParameter.h.
Referenced by DistributedMultiThreadNetwork::_addAnalogMessage_(), DistributedSingleThreadNetwork::_addSpikeMessage_(), DistributedMultiThreadNetwork::_addSpikeMessage_(), MultiThreadNetwork::_initialize_(), MultiThreadNetwork::addGenericAnalogMessage(), DistributedSingleThreadNetwork::addGenericAnalogMessage(), DistributedMultiThreadNetwork::addGenericAnalogMessage(), MultiThreadNetwork::addLocalSpikeMessage(), SingleThreadSpikeScheduler::deliverSpikes(), MultiThreadSpikeScheduler::deliverSpikes(), SimNetwork::get_dt(), DistributedMultiThreadNetwork::init(), MultiThreadSpikeScheduler::MultiThreadSpikeScheduler(), SingleThreadSpikeScheduler::reset(), MultiThreadSpikeScheduler::reset(), and SimNetwork::set_dt().
The minimal delay allowed for spikes.
Definition at line 40 of file SimParameter.h.
Referenced by MultiThreadNetwork::_addSpikeMessage_(), DistributedSingleThreadNetwork::_addSpikeMessage_(), DistributedMultiThreadNetwork::_addSpikeMessage_(), MultiThreadNetwork::_initialize_(), DistributedSingleThreadNetwork::_initialize_(), DistributedMultiThreadNetwork::_initialize_(), MultiThreadNetwork::addGenericAnalogMessage(), DistributedSingleThreadNetwork::addGenericAnalogMessage(), DistributedMultiThreadNetwork::addGenericAnalogMessage(), MultiThreadNetwork::addLocalSpikeMessage(), DistributedMultiThreadNetwork::init(), MultiThreadSimEngine::MultiThreadSimEngine(), MultiThreadSpikeScheduler::MultiThreadSpikeScheduler(), SingleThreadSpikeScheduler::reset(), and MultiThreadSpikeScheduler::reset().
The maximal delay allowed for spikes as well as analog messages.
Definition at line 43 of file SimParameter.h.
Referenced by SingleThreadNetwork::_addSpikeMessage_(), MultiThreadNetwork::_addSpikeMessage_(), DistributedSingleThreadNetwork::_addSpikeMessage_(), DistributedMultiThreadNetwork::_addSpikeMessage_(), MultiThreadNetwork::addGenericAnalogMessage(), DistributedSingleThreadNetwork::addGenericAnalogMessage(), DistributedMultiThreadNetwork::addGenericAnalogMessage(), DistributedMultiThreadNetwork::init(), SingleThreadSpikeScheduler::reset(), and MultiThreadSpikeScheduler::reset().
Seed for the random number generator used in the construction process.
NOTE : This seed must be set equal to all mpi processing nodes, otherwise an error will occur. (TODO: Automatic check to ensure consistency of seeds will be implemented in the future)
If the same seed is used for construction of the same network, then the exactly the same network will be generated (identical topology, and identical parameters of elements) provided that the number of machines and number of threads on each machine don't change.
Definition at line 54 of file SimParameter.h.
Referenced by SingleThreadNetwork::seed_noise_rng(), MultiThreadNetwork::seed_noise_rng(), DistributedNetwork::seed_noise_rng(), and SimNetwork::setupConstructRNGEngines().
Seed for random number generators used in the simulation phase.
Usually used for noise in neurons, poison spike train generators, ion channel state switching etc.
Under the same environment, with the same network and the same simulation_seed value, the produced simulation results should be identical.
NOTE: If the hardware environment used for simulation is changed (number of machines and number of threads per each machine) then simulation results can differ even with the same simulation rng seed number.
Definition at line 68 of file SimParameter.h.
Referenced by DistributedMultiThreadNetwork::init(), and SingleThreadSimEngine::SingleThreadSimEngine().
SimParameter SimParameter::Default [static] |
The documentation for this class was generated from the following files:
- /home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/simcore/SimParameter.h
- /home/tnatschl/PCSIM-Sandbox/pcsim/pcsim/simcore/SimParameter.cpp
