user_params.hpp

Go to the documentation of this file.

/*
# =============================================================================
# Copyright (c) 2016 - 2021 Blue Brain Project/EPFL
#
# See top-level LICENSE file for details.
# =============================================================================
*/
 
#pragma once
 
namespace coreneuron {
 
class CheckPoints;
 
/// This structure is data needed is several part of nrn_setup, phase1 and phase2.
/// Before it was globals variables, group them to give them as a single argument.
/// They have for the most part, nothing related to each other.
struct UserParams {
    UserParams(int ngroup_,
               int* gidgroups_,
               const char* path_,
               const char* restore_path_,
               CheckPoints& checkPoints_)
        : ngroup(ngroup_)
        , gidgroups(gidgroups_)
        , path(path_)
        , restore_path(restore_path_)
        , file_reader(ngroup_)
        , checkPoints(checkPoints_) {}
 
    /// direct memory mode with neuron, do not open files
    /// Number of local cell groups
    const int ngroup;
    /// Array of cell group numbers (indices)
    const int* const gidgroups;
    /// path to dataset file
    const char* const path;
    /// Dataset path from where simulation is being restored
    const char* const restore_path;
    std::vector<FileHandler> file_reader;
    CheckPoints& checkPoints;
};
}  // namespace coreneuron