coreneuron::corenrn_parameters Struct Reference
Detailed Description
Definition at line 96 of file corenrn_parameters.hpp.
#include <corenrn_parameters.hpp>
Inheritance diagram for coreneuron::corenrn_parameters:
Public Member Functions | |
| corenrn_parameters () | |
| ~corenrn_parameters () | |
| Constructor that initializes the CLI11 app. More... | |
| void | parse (int argc, char *argv[]) |
| Destructor defined in .cpp where CLI11 types are complete. More... | |
| void | reset () |
| Runs the CLI11_PARSE macro. More... | |
| bool | is_quiet () |
| std::string | config_to_str (bool default_also=false, bool write_description=false) const |
| Return a string summarising the current parameter values. More... | |
Private Attributes | |
| std::unique_ptr< CLI::App > | m_app |
Additional Inherited Members | |
 Public Types inherited from coreneuron::corenrn_parameters_data | |
| enum | verbose_level : std::uint32_t { NONE = 0, ERROR = 1, INFO = 2, DEBUG_INFO = 3, DEFAULT = INFO } |
| Public Attributes inherited from coreneuron::corenrn_parameters_data | |
| 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 inherited from coreneuron::corenrn_parameters_data | |
| static constexpr int | report_buff_size_default = 4 |
Constructor & Destructor Documentation
◆ corenrn_parameters()
| corenrn_parameters::corenrn_parameters | ( | ) |
Definition at line 16 of file corenrn_parameters.cpp.
◆ ~corenrn_parameters()
|
default |
Constructor that initializes the CLI11 app.
Member Function Documentation
◆ config_to_str()
| std::string corenrn_parameters::config_to_str | ( | bool | default_also = false, |
| bool | write_description = false |
||
| ) | const |
Return a string summarising the current parameter values.
This forwards to the CLI11 method of the same name. Returns a string that could be read in as a config of the current values of the App.
- Parameters
-
default_also Include any defaulted arguments. write_description Include option descriptions and the App description.
Definition at line 175 of file corenrn_parameters.cpp.
◆ is_quiet()
|
inline |
Definition at line 109 of file corenrn_parameters.hpp.
◆ parse()
| void corenrn_parameters::parse | ( | int | argc, |
| char * | argv[] | ||
| ) |
Destructor defined in .cpp where CLI11 types are complete.
Definition at line 184 of file corenrn_parameters.cpp.
◆ reset()
| void corenrn_parameters::reset | ( | ) |
Runs the CLI11_PARSE macro.
Reset all parameters to their default values.
Unfortunately it is awkward to support x = corenrn_parameters{} because app holds pointers to members of corenrn_parameters.
Definition at line 179 of file corenrn_parameters.cpp.
Member Data Documentation
◆ m_app
|
private |
Definition at line 127 of file corenrn_parameters.hpp.
The documentation for this struct was generated from the following files:
- /home/runner/work/CoreNeuron/CoreNeuron/coreneuron/apps/corenrn_parameters.hpp
- /home/runner/work/CoreNeuron/CoreNeuron/coreneuron/apps/corenrn_parameters.cpp