nest::Compartment Class Reference

#include <cm_tree.h>

Collaboration diagram for nest::Compartment:

Public Member Functions
	Compartment (const long compartment_index, const long parent_index)
	Compartment (const long compartment_index, const long parent_index, const Dictionary &compartment_params)
	~Compartment ()
void	pre_run_hook ()
std::map< std::string, double * >	get_recordables ()
void	construct_matrix_element (const long lag)
	matrix construction
void	gather_input (const std::pair< double, double > &in)
	maxtrix inversion
std::pair< double, double >	io ()
double	calc_v (const double v_in)

Public Attributes
long	comp_index
	compartment index
long	p_index
	parent compartment index
Compartment *	parent
	tree structure indices
std::vector< Compartment >	children
RingBuffer	currents
	buffer for currents
double	ca
	electrical parameters
double	gc
double	gl
double	el
double	v_comp
	voltage variable
double	gg0
	auxiliary variables for efficienchy
double	ca__div__dt
double	gl__div__2
double	gc__div__2
double	gl__times__el
double	ff
	for numerical integration
double	gg
double	hh
int	n_passed
	passage counter for recursion
CompartmentCurrents	compartment_currents
	vector for synapses

Private Attributes
double	xx_
	aggragators for numerical integration
double	yy_

Constructor & Destructor Documentation

Compartment() [1/2]

nest::Compartment::Compartment	(	const long	compartment_index,
		const long	parent_index
	)

References compartment_currents, and v_comp.

Compartment() [2/2]

nest::Compartment::Compartment	(	const long	compartment_index,
		const long	parent_index,
		const Dictionary &	compartment_params
	)

References Dictionary::all_entries_accessed(), nest::names::C_m(), ca, compartment_currents, nest::names::e_L(), el, nest::names::g_C(), nest::names::g_L(), gc, gl, Dictionary::init_access_flags(), Dictionary::update_value(), v_comp, and nest::names::v_comp().

Here is the call graph for this function:

~Compartment()

nest::Compartment::~Compartment ( )

inline

Member Function Documentation

calc_v()

double nest::Compartment::calc_v ( const double  v_in )

inline

References ff, gg, hh, v_comp, xx_, and yy_.

Referenced by nest::CompTree::solve_matrix_upsweep().

Here is the caller graph for this function:

construct_matrix_element()

void nest::Compartment::construct_matrix_element

(

const long

lag

)

matrix construction

References ca__div__dt, children, compartment_currents, currents, nest::CompartmentCurrents::f_numstep(), ff, gc__div__2, nest::RingBuffer::get_value(), gg, gg0, gl__div__2, gl__times__el, hh, parent, and v_comp.

Here is the call graph for this function:

gather_input()

void nest::Compartment::gather_input ( const std::pair< double, double > &  in )

inline

maxtrix inversion

References xx_, and yy_.

Referenced by nest::CompTree::solve_matrix_downsweep().

Here is the caller graph for this function:

get_recordables()

std::map< std::string, double * > nest::Compartment::get_recordables

(

)

References comp_index, compartment_currents, nest::CompartmentCurrents::get_recordables(), and v_comp.

Here is the call graph for this function:

io()

std::pair< double, double > nest::Compartment::io ( )

inline

References ff, gg, hh, xx_, and yy_.

Referenced by nest::CompTree::solve_matrix_downsweep().

Here is the caller graph for this function:

pre_run_hook()

void nest::Compartment::pre_run_hook

(

)

References ca, ca__div__dt, nest::RingBuffer::clear(), compartment_currents, currents, el, gc, gc__div__2, nest::Time::get_ms(), nest::Time::get_resolution(), gg0, gl, gl__div__2, gl__times__el, and nest::CompartmentCurrents::pre_run_hook().

Here is the call graph for this function:

Member Data Documentation

ca

double nest::Compartment::ca

electrical parameters

Referenced by Compartment(), pre_run_hook(), and nest::CompTree::print_tree().

ca__div__dt

double nest::Compartment::ca__div__dt

Referenced by construct_matrix_element(), and pre_run_hook().

children

std::vector< Compartment > nest::Compartment::children

Referenced by nest::CompTree::add_compartment(), construct_matrix_element(), nest::CompTree::get_compartment(), nest::CompTree::solve_matrix_downsweep(), and nest::CompTree::solve_matrix_upsweep().

comp_index

long nest::Compartment::comp_index

compartment index

Referenced by nest::CompTree::add_compartment(), nest::CompTree::get_compartment(), get_recordables(), nest::cm_default::get_status(), nest::CompTree::pre_run_hook(), and nest::CompTree::print_tree().

compartment_currents

CompartmentCurrents nest::Compartment::compartment_currents

vector for synapses

Referenced by nest::cm_default::add_receptor_(), Compartment(), Compartment(), construct_matrix_element(), get_recordables(), nest::cm_default::get_status(), pre_run_hook(), and nest::CompTree::set_syn_buffers().

currents

RingBuffer nest::Compartment::currents

buffer for currents

Referenced by construct_matrix_element(), nest::cm_default::handle(), and pre_run_hook().

el

double nest::Compartment::el

Referenced by Compartment(), pre_run_hook(), and nest::CompTree::print_tree().

ff

double nest::Compartment::ff

for numerical integration

Referenced by calc_v(), construct_matrix_element(), and io().

gc

double nest::Compartment::gc

Referenced by Compartment(), pre_run_hook(), and nest::CompTree::print_tree().

gc__div__2

double nest::Compartment::gc__div__2

Referenced by construct_matrix_element(), and pre_run_hook().

gg

double nest::Compartment::gg

Referenced by calc_v(), construct_matrix_element(), and io().

gg0

double nest::Compartment::gg0

auxiliary variables for efficienchy

Referenced by construct_matrix_element(), and pre_run_hook().

gl

double nest::Compartment::gl

Referenced by Compartment(), pre_run_hook(), and nest::CompTree::print_tree().

gl__div__2

double nest::Compartment::gl__div__2

Referenced by construct_matrix_element(), and pre_run_hook().

gl__times__el

double nest::Compartment::gl__times__el

Referenced by construct_matrix_element(), and pre_run_hook().

hh

double nest::Compartment::hh

Referenced by calc_v(), construct_matrix_element(), and io().

n_passed

int nest::Compartment::n_passed

passage counter for recursion

Referenced by nest::CompTree::solve_matrix_downsweep().

p_index

long nest::Compartment::p_index

parent compartment index

Referenced by nest::cm_default::get_status(), and nest::CompTree::set_parents().

parent

Compartment* nest::Compartment::parent

tree structure indices

Referenced by construct_matrix_element(), nest::CompTree::print_tree(), nest::CompTree::set_parents(), and nest::CompTree::solve_matrix_downsweep().

v_comp

double nest::Compartment::v_comp

voltage variable

Referenced by calc_v(), Compartment(), Compartment(), construct_matrix_element(), get_recordables(), and nest::cm_default::update().

xx_

double nest::Compartment::xx_

private

aggragators for numerical integration

Referenced by calc_v(), gather_input(), and io().

yy_

double nest::Compartment::yy_

private

Referenced by calc_v(), gather_input(), and io().

---

The documentation for this class was generated from the following files:

• cm_tree.h
• cm_tree.cpp