Detailed Description

Definition at line 37 of file corenrn_parameters.hpp.

#include <corenrn_parameters.hpp>

Inheritance diagram for coreneuron::corenrn_parameters_data:

Public Types
enum	verbose_level : std::uint32_t { NONE = 0, ERROR = 1, INFO = 2, DEBUG_INFO = 3, DEFAULT = INFO }

Public Attributes
unsigned	spikebuf = 100'000

int	prcellgid = -1
	Internal buffer used on every rank for spikes. More...

unsigned	ms_phases = 2
	Gid of cell for prcellstate. More...

unsigned	ms_subint = 2
	Number of multisend phases, 1 or 2. More...

unsigned	spkcompress = 0
	Number of multisend interval. 1 or 2. More...

unsigned	cell_interleave_permute = 0
	Spike Compression. More...

unsigned	nwarp = 65536
	Cell interleaving permutation. More...

unsigned	num_gpus = 0
	Number of warps to balance for cell_interleave_permute == 2. More...

unsigned	report_buff_size = report_buff_size_default
	Number of gpus to use per node. More...

int	seed = -1
	Size in MB of the report buffer. More...

bool	mpi_enable = false
	Initialization seed for random number generator (int) More...

bool	skip_mpi_finalize = false
	Enable MPI flag. More...

bool	multisend = false
	Skip MPI finalization. More...

bool	threading = false
	Use Multisend spike exchange instead of Allgather. More...

bool	gpu = false
	Enable pthread/openmp. More...

bool	cuda_interface = false
	Enable GPU computation. More...

bool	binqueue = false
	Enable CUDA interface (default is the OpenACC interface). Branch of the code is executed through CUDA kernels instead of OpenACC regions. More...

bool	show_version = false
	Use bin queue. More...

bool	model_stats = false
	Print version and exit. More...

verbose_level	verbose {verbose_level::DEFAULT}
	Print mechanism counts and model size after initialization. More...

double	tstop = 100
	Verbosity-level. More...

double	dt = -1000.0
	Stop time of simulation in msec. More...

double	dt_io = 0.1
	Timestep to use in msec. More...

double	dt_report
	I/O timestep to use in msec. More...

double	celsius = -1000.0
	I/O timestep to use in msec for reports. More...

double	voltage = -65.0
	Temperature in degC. More...

double	forwardskip = 0.
	Initial voltage used for nrn_finitialize(1, v_init). More...

double	mindelay = 10.
	Forward skip to TIME. More...

std::string	patternstim
	Maximum integration interval (likely reduced by minimum NetCon delay). More...

std::string	datpath = "."
	Apply patternstim using the specified spike file. More...

std::string	outpath = "."
	Directory path where .dat files. More...

std::string	filesdat = "files.dat"
	Directory where spikes will be written. More...

std::string	restorepath
	Name of file containing list of gids dat files read in. More...

std::string	reportfilepath
	Restore simulation from provided checkpoint directory. More...

std::string	checkpointpath
	Reports configuration file. More...

std::string	writeParametersFilepath
	Enable checkpoint and specify directory to store related files. More...

std::string	mpi_lib
	Write parameters to this file. More...

Static Public Attributes
static constexpr int	report_buff_size_default = 4

Member Enumeration Documentation

◆ verbose_level

enum coreneuron::corenrn_parameters_data::verbose_level : std::uint32_t

Enumerator
NONE
ERROR
INFO
DEBUG_INFO
DEFAULT

Definition at line 38 of file corenrn_parameters.hpp.

Member Data Documentation

◆ binqueue

bool coreneuron::corenrn_parameters_data::binqueue = false

Enable CUDA interface (default is the OpenACC interface). Branch of the code is executed through CUDA kernels instead of OpenACC regions.

Definition at line 67 of file corenrn_parameters.hpp.

◆ cell_interleave_permute

unsigned coreneuron::corenrn_parameters_data::cell_interleave_permute = 0

Spike Compression.

Definition at line 53 of file corenrn_parameters.hpp.

◆ celsius

double coreneuron::corenrn_parameters_data::celsius = -1000.0

I/O timestep to use in msec for reports.

Definition at line 79 of file corenrn_parameters.hpp.

◆ checkpointpath

std::string coreneuron::corenrn_parameters_data::checkpointpath

Reports configuration file.

Definition at line 91 of file corenrn_parameters.hpp.

◆ cuda_interface

bool coreneuron::corenrn_parameters_data::cuda_interface = false

Enable GPU computation.

Definition at line 64 of file corenrn_parameters.hpp.

◆ datpath

std::string coreneuron::corenrn_parameters_data::datpath = "."

Apply patternstim using the specified spike file.

Definition at line 86 of file corenrn_parameters.hpp.

◆ dt

double coreneuron::corenrn_parameters_data::dt = -1000.0

Stop time of simulation in msec.

Definition at line 76 of file corenrn_parameters.hpp.

◆ dt_io

double coreneuron::corenrn_parameters_data::dt_io = 0.1

Timestep to use in msec.

Definition at line 77 of file corenrn_parameters.hpp.

◆ dt_report

double coreneuron::corenrn_parameters_data::dt_report

I/O timestep to use in msec.

Definition at line 78 of file corenrn_parameters.hpp.

◆ filesdat

std::string coreneuron::corenrn_parameters_data::filesdat = "files.dat"

Directory where spikes will be written.

Definition at line 88 of file corenrn_parameters.hpp.

◆ forwardskip

double coreneuron::corenrn_parameters_data::forwardskip = 0.

Initial voltage used for nrn_finitialize(1, v_init).

Definition at line 81 of file corenrn_parameters.hpp.

◆ gpu

bool coreneuron::corenrn_parameters_data::gpu = false

Enable pthread/openmp.

Definition at line 63 of file corenrn_parameters.hpp.

◆ mindelay

double coreneuron::corenrn_parameters_data::mindelay = 10.

Forward skip to TIME.

Definition at line 82 of file corenrn_parameters.hpp.

◆ model_stats

bool coreneuron::corenrn_parameters_data::model_stats = false

Print version and exit.

Definition at line 71 of file corenrn_parameters.hpp.

◆ mpi_enable

bool coreneuron::corenrn_parameters_data::mpi_enable = false

Initialization seed for random number generator (int)

Definition at line 59 of file corenrn_parameters.hpp.

◆ mpi_lib

std::string coreneuron::corenrn_parameters_data::mpi_lib

Write parameters to this file.

Definition at line 93 of file corenrn_parameters.hpp.

◆ ms_phases

unsigned coreneuron::corenrn_parameters_data::ms_phases = 2

Gid of cell for prcellstate.

Definition at line 50 of file corenrn_parameters.hpp.

◆ ms_subint

unsigned coreneuron::corenrn_parameters_data::ms_subint = 2

Number of multisend phases, 1 or 2.

Definition at line 51 of file corenrn_parameters.hpp.

◆ multisend

bool coreneuron::corenrn_parameters_data::multisend = false

Skip MPI finalization.

Definition at line 61 of file corenrn_parameters.hpp.

◆ num_gpus

unsigned coreneuron::corenrn_parameters_data::num_gpus = 0

Number of warps to balance for cell_interleave_permute == 2.

Definition at line 55 of file corenrn_parameters.hpp.

◆ nwarp

unsigned coreneuron::corenrn_parameters_data::nwarp = 65536

Cell interleaving permutation.

Definition at line 54 of file corenrn_parameters.hpp.

◆ outpath

std::string coreneuron::corenrn_parameters_data::outpath = "."

Directory path where .dat files.

Definition at line 87 of file corenrn_parameters.hpp.

◆ patternstim

std::string coreneuron::corenrn_parameters_data::patternstim

Maximum integration interval (likely reduced by minimum NetCon delay).

Definition at line 85 of file corenrn_parameters.hpp.

◆ prcellgid

int coreneuron::corenrn_parameters_data::prcellgid = -1

Internal buffer used on every rank for spikes.

Definition at line 49 of file corenrn_parameters.hpp.

◆ report_buff_size

unsigned coreneuron::corenrn_parameters_data::report_buff_size = report_buff_size_default

Number of gpus to use per node.

Definition at line 56 of file corenrn_parameters.hpp.

◆ report_buff_size_default

constexpr int coreneuron::corenrn_parameters_data::report_buff_size_default = 4

staticconstexpr

Definition at line 46 of file corenrn_parameters.hpp.

◆ reportfilepath

std::string coreneuron::corenrn_parameters_data::reportfilepath

Restore simulation from provided checkpoint directory.

Definition at line 90 of file corenrn_parameters.hpp.

◆ restorepath

std::string coreneuron::corenrn_parameters_data::restorepath

Name of file containing list of gids dat files read in.

Definition at line 89 of file corenrn_parameters.hpp.

◆ seed

int coreneuron::corenrn_parameters_data::seed = -1

Size in MB of the report buffer.

Definition at line 57 of file corenrn_parameters.hpp.

◆ show_version

bool coreneuron::corenrn_parameters_data::show_version = false

Use bin queue.

Definition at line 69 of file corenrn_parameters.hpp.

◆ skip_mpi_finalize

bool coreneuron::corenrn_parameters_data::skip_mpi_finalize = false

Enable MPI flag.

Definition at line 60 of file corenrn_parameters.hpp.

◆ spikebuf

unsigned coreneuron::corenrn_parameters_data::spikebuf = 100'000

Definition at line 48 of file corenrn_parameters.hpp.

◆ spkcompress

unsigned coreneuron::corenrn_parameters_data::spkcompress = 0

Number of multisend interval. 1 or 2.

Definition at line 52 of file corenrn_parameters.hpp.

◆ threading

bool coreneuron::corenrn_parameters_data::threading = false

Use Multisend spike exchange instead of Allgather.

Definition at line 62 of file corenrn_parameters.hpp.

◆ tstop

double coreneuron::corenrn_parameters_data::tstop = 100

Verbosity-level.

Definition at line 75 of file corenrn_parameters.hpp.

◆ verbose

verbose_level coreneuron::corenrn_parameters_data::verbose {verbose_level::DEFAULT}

Print mechanism counts and model size after initialization.

Definition at line 73 of file corenrn_parameters.hpp.

◆ voltage

double coreneuron::corenrn_parameters_data::voltage = -65.0

Temperature in degC.

Definition at line 80 of file corenrn_parameters.hpp.

◆ writeParametersFilepath

std::string coreneuron::corenrn_parameters_data::writeParametersFilepath

Enable checkpoint and specify directory to store related files.

Definition at line 92 of file corenrn_parameters.hpp.

The documentation for this struct was generated from the following file:

/home/runner/work/CoreNeuron/CoreNeuron/coreneuron/apps/corenrn_parameters.hpp