/*
* iaf_cond_exp.cpp
*
* This file is part of NEST.
*
* Copyright (C) 2004 The NEST Initiative
*
* NEST is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* NEST is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with NEST. If not, see <http://www.gnu.org/licenses/>.
*
*/
#include "iaf_cond_exp.h"
#ifdef HAVE_GSL
#include "exceptions.h"
#include "network.h"
#include "dict.h"
#include "integerdatum.h"
#include "doubledatum.h"
#include "dictutils.h"
#include "numerics.h"
#include <limits>
#include "universal_data_logger_impl.h"
#include "event.h"
#include <iomanip>
#include <iostream>
#include <cstdio>
/* ----------------------------------------------------------------
* Recordables map
* ---------------------------------------------------------------- */
nest::RecordablesMap<nest::iaf_cond_exp> nest::iaf_cond_exp::recordablesMap_;
namespace nest // template specialization must be placed in namespace
{
// Override the create() method with one call to RecordablesMap::insert_()
// for each quantity to be recorded.
template <>
void RecordablesMap<iaf_cond_exp>::create()
{
// use standard names whereever you can for consistency!
insert_(names::V_m,
&iaf_cond_exp::get_y_elem_<iaf_cond_exp::State_::V_M>);
insert_(names::g_ex,
&iaf_cond_exp::get_y_elem_<iaf_cond_exp::State_::G_EXC>);
insert_(names::g_in,
&iaf_cond_exp::get_y_elem_<iaf_cond_exp::State_::G_INH>);
}
}
extern "C"
inline int nest::iaf_cond_exp_dynamics(double, const double y[], double f[], void* pnode)
{
// a shorthand
typedef nest::iaf_cond_exp::State_ S;
// get access to node so we can almost work as in a member function
assert(pnode);
const nest::iaf_cond_exp& node = *(reinterpret_cast<nest::iaf_cond_exp*>(pnode));
// y[] here is---and must be---the state vector supplied by the integrator,
// not the state vector in the node, node.S_.y[].
// The following code is verbose for the sake of clarity. We assume that a
// good compiler will optimize the verbosity away ...
const double I_syn_exc = y[S::G_EXC] * (y[S::V_M] - node.P_.E_ex);
const double I_syn_inh = y[S::G_INH] * (y[S::V_M] - node.P_.E_in);
const double I_L = node.P_.g_L * ( y[S::V_M] - node.P_.E_L );
//V dot
f[0]= ( - I_L + node.B_.I_stim_ + node.P_.I_e - I_syn_exc - I_syn_inh) / node.P_.C_m;
f[1] = -y[S::G_EXC] / node.P_.tau_synE;
f[2] = -y[S::G_INH] / node.P_.tau_synI;
return GSL_SUCCESS;
}
/* ----------------------------------------------------------------
* Default constructors defining default parameters and state
* ---------------------------------------------------------------- */
nest::iaf_cond_exp::Parameters_::Parameters_()
: V_th_ (-55.0 ), // mV
V_reset_ (-60.0 ), // mV
t_ref_ ( 2.0 ), // ms
g_L ( 16.6667 ), // nS
C_m (250.0 ), // pF
E_ex ( 0.0 ), // mV
E_in (-85.0 ), // mV
E_L (-70.0 ), // mV
tau_synE ( 0.2 ), // ms
tau_synI ( 2.0 ), // ms
I_e ( 0.0 ) // pA
{
}
nest::iaf_cond_exp::State_::State_(const Parameters_& p)
: r_(0)
{
y_[V_M] = p.E_L;
y_[G_EXC] = y_[G_INH] = 0;
}
nest::iaf_cond_exp::State_::State_(const State_& s)
: r_(s.r_)
{
for ( size_t i = 0 ; i < STATE_VEC_SIZE ; ++i )
y_[i] = s.y_[i];
}
nest::iaf_cond_exp::State_& nest::iaf_cond_exp::State_::operator=(const State_& s)
{
assert(this != &s); // would be bad logical error in program
for ( size_t i = 0 ; i < STATE_VEC_SIZE ; ++i )
y_[i] = s.y_[i];
r_ = s.r_;
return *this;
}
/* ----------------------------------------------------------------
* Parameter and state extractions and manipulation functions
* ---------------------------------------------------------------- */
void nest::iaf_cond_exp::Parameters_::get(DictionaryDatum &d) const
{
def<double>(d,names::V_th, V_th_);
def<double>(d,names::V_reset, V_reset_);
def<double>(d,names::t_ref, t_ref_);
def<double>(d,names::g_L, g_L);
def<double>(d,names::E_L, E_L);
def<double>(d,names::E_ex, E_ex);
def<double>(d,names::E_in, E_in);
def<double>(d,names::C_m, C_m);
def<double>(d,names::tau_syn_ex, tau_synE);
def<double>(d,names::tau_syn_in, tau_synI);
def<double>(d,names::I_e, I_e);
}
void nest::iaf_cond_exp::Parameters_::set(const DictionaryDatum& d)
{
// allow setting the membrane potential
updateValue<double>(d,names::V_th, V_th_);
updateValue<double>(d,names::V_reset, V_reset_);
updateValue<double>(d,names::t_ref, t_ref_);
updateValue<double>(d,names::E_L, E_L);
updateValue<double>(d,names::E_ex, E_ex);
updateValue<double>(d,names::E_in, E_in);
updateValue<double>(d,names::C_m, C_m);
updateValue<double>(d,names::g_L, g_L);
updateValue<double>(d,names::tau_syn_ex, tau_synE);
updateValue<double>(d,names::tau_syn_in, tau_synI);
updateValue<double>(d,names::I_e, I_e);
if ( V_reset_ >= V_th_ )
throw BadProperty("Reset potential must be smaller than threshold.");
if ( C_m <= 0 )
throw BadProperty("Capacitance must be strictly positive.");
if ( t_ref_ < 0 )
throw BadProperty("Refractory time cannot be negative.");
if ( tau_synE <= 0 || tau_synI <= 0 )
throw BadProperty("All time constants must be strictly positive.");
}
void nest::iaf_cond_exp::State_::get(DictionaryDatum &d) const
{
def<double>(d, names::V_m, y_[V_M]); // Membrane potential
}
void nest::iaf_cond_exp::State_::set(const DictionaryDatum& d, const Parameters_&)
{
updateValue<double>(d, names::V_m, y_[V_M]);
}
nest::iaf_cond_exp::Buffers_::Buffers_(iaf_cond_exp& n)
: logger_(n),
s_(0),
c_(0),
e_(0)
{
// Initialization of the remaining members is deferred to
// init_buffers_().
}
nest::iaf_cond_exp::Buffers_::Buffers_(const Buffers_&, iaf_cond_exp& n)
: logger_(n),
s_(0),
c_(0),
e_(0)
{
// Initialization of the remaining members is deferred to
// init_buffers_().
}
/* ----------------------------------------------------------------
* Default and copy constructor for node, and destructor
* ---------------------------------------------------------------- */
nest::iaf_cond_exp::iaf_cond_exp()
: Archiving_Node(),
P_(),
S_(P_),
B_(*this)
{
recordablesMap_.create();
}
nest::iaf_cond_exp::iaf_cond_exp(const iaf_cond_exp& n)
: Archiving_Node(n),
P_(n.P_),
S_(n.S_),
B_(n.B_, *this)
{
}
nest::iaf_cond_exp::~iaf_cond_exp()
{
// GSL structs may not have been allocated, so we need to protect destruction
if ( B_.s_ ) gsl_odeiv_step_free(B_.s_);
if ( B_.c_ ) gsl_odeiv_control_free(B_.c_);
if ( B_.e_ ) gsl_odeiv_evolve_free(B_.e_);
}
/* ----------------------------------------------------------------
* Node initialization functions
* ---------------------------------------------------------------- */
void nest::iaf_cond_exp::init_state_(const Node& proto)
{
const iaf_cond_exp& pr = downcast<iaf_cond_exp>(proto);
S_ = pr.S_;
}
void nest::iaf_cond_exp::init_buffers_()
{
B_.spike_exc_.clear(); // includes resize
B_.spike_inh_.clear(); // includes resize
B_.currents_.clear(); // includes resize
Archiving_Node::clear_history();
B_.logger_.reset();
B_.step_ = Time::get_resolution().get_ms();
B_.IntegrationStep_ = B_.step_;
static const gsl_odeiv_step_type* T1 = gsl_odeiv_step_rkf45;
if ( B_.s_ == 0 )
B_.s_ = gsl_odeiv_step_alloc (T1, State_::STATE_VEC_SIZE);
else
gsl_odeiv_step_reset(B_.s_);
if ( B_.c_ == 0 )
B_.c_ = gsl_odeiv_control_y_new (1e-3, 0.0);
else
gsl_odeiv_control_init(B_.c_, 1e-3, 0.0, 1.0, 0.0);
if ( B_.e_ == 0 )
B_.e_ = gsl_odeiv_evolve_alloc(State_::STATE_VEC_SIZE);
else
gsl_odeiv_evolve_reset(B_.e_);
B_.sys_.function = iaf_cond_exp_dynamics;
B_.sys_.jacobian = NULL;
B_.sys_.dimension = State_::STATE_VEC_SIZE;
B_.sys_.params = reinterpret_cast<void*>(this);
B_.I_stim_ = 0.0;
}
void nest::iaf_cond_exp::calibrate()
{
B_.logger_.init(); // ensures initialization in case mm connected after Simulate
V_.RefractoryCounts_ = Time(Time::ms(P_.t_ref_)).get_steps();
assert(V_.RefractoryCounts_ >= 0); // since t_ref_ >= 0, this can only fail in error
}
/* ----------------------------------------------------------------
* Update and spike handling functions
* ---------------------------------------------------------------- */
void nest::iaf_cond_exp::update(Time const & origin, const long_t from, const long_t to)
{
assert(to >= 0 && (delay) from < Scheduler::get_min_delay());
assert(from < to);
for ( long_t lag = from ; lag < to ; ++lag )
{
double t = 0.0;
// numerical integration with adaptive step size control:
// ------------------------------------------------------
// gsl_odeiv_evolve_apply performs only a single numerical
// integration step, starting from t and bounded by step;
// the while-loop ensures integration over the whole simulation
// step (0, step] if more than one integration step is needed due
// to a small integration step size;
// note that (t+IntegrationStep > step) leads to integration over
// (t, step] and afterwards setting t to step, but it does not
// enforce setting IntegrationStep to step-t; this is of advantage
// for a consistent and efficient integration across subsequent
// simulation intervals
while ( t < B_.step_ )
{
const int status = gsl_odeiv_evolve_apply(B_.e_, B_.c_, B_.s_,
&B_.sys_, // system of ODE
&t, // from t
B_.step_, // to t <= step
&B_.IntegrationStep_, // integration step size
S_.y_); // neuronal state
if ( status != GSL_SUCCESS )
throw GSLSolverFailure(get_name(), status);
}
S_.y_[State_::G_EXC] += B_.spike_exc_.get_value(lag);
S_.y_[State_::G_INH] += B_.spike_inh_.get_value(lag);
// absolute refractory period
if ( S_.r_ )
{// neuron is absolute refractory
--S_.r_;
S_.y_[State_::V_M] = P_.V_reset_;
}
else
// neuron is not absolute refractory
if ( S_.y_[State_::V_M] >= P_.V_th_ )
{
S_.r_ = V_.RefractoryCounts_;
S_.y_[State_::V_M] = P_.V_reset_;
set_spiketime(Time::step(origin.get_steps()+lag+1));
SpikeEvent se;
network()->send(*this, se, lag);
}
// set new input current
B_.I_stim_ = B_.currents_.get_value(lag);
// log state data
B_.logger_.record_data(origin.get_steps() + lag);
}
}
void nest::iaf_cond_exp::handle(SpikeEvent & e)
{
assert(e.get_delay() > 0);
if(e.get_weight() > 0.0)
B_.spike_exc_.add_value(e.get_rel_delivery_steps(network()->get_slice_origin()),
e.get_weight() * e.get_multiplicity() );
else
B_.spike_inh_.add_value(e.get_rel_delivery_steps(network()->get_slice_origin()),
-e.get_weight() * e.get_multiplicity() ); // ensure conductance is positive
}
void nest::iaf_cond_exp::handle(CurrentEvent& e)
{
assert(e.get_delay() > 0);
const double_t c=e.get_current();
const double_t w=e.get_weight();
// add weighted current; HEP 2002-10-04
B_.currents_.add_value(e.get_rel_delivery_steps(network()->get_slice_origin()),
w *c);
}
void nest::iaf_cond_exp::handle(DataLoggingRequest& e)
{
B_.logger_.handle(e);
}
#endif //HAVE_GSL