#include <HHChannel2D.h>

Inheritance diagram for HHChannel2D:

Collaboration diagram for HHChannel2D:

Public Member Functions
bool	checkOriginal (Id chanId) const
	Returns true if channel is original, false if copy. More...

void	conc1 (double conc)

void	conc2 (double conc)

void	createGate (const Eref &e, string gateType)

void	destroyGate (const Eref &e, string gateType)

int	getInstant () const

unsigned int	getNumXgates () const

unsigned int	getNumYgates () const
	Returns 1 if Y gate present, otherwise 0. More...

unsigned int	getNumZgates () const
	Returns 1 if Z gate present, otherwise 0. More...

int	getUseConcentration ()

double	getX () const

HHGate2D *	getXgate (unsigned int i)
	Access function used for the X gate. The index is ignored. More...

string	getXindex () const

double	getXpower (const Eref &e) const

double	getY () const

HHGate2D *	getYgate (unsigned int i)
	Access function used for the Y gate. The index is ignored. More...

string	getYindex () const

double	getYpower (const Eref &e) const

double	getZ () const

HHGate2D *	getZgate (unsigned int i)
	Access function used for the Z gate. The index is ignored. More...

string	getZindex () const

double	getZpower (const Eref &e) const

	HHChannel2D ()

void	innerCreateGate (const string &gateName, HHGate2D **gatePtr, Id chanId, Id gateId)
	Inner utility function for creating the gate. More...

void	innerDestroyGate (const string &gateName, HHGate2D **gatePtr, Id chanId)

bool	setGatePower (const Eref &e, double power, double *assignee, const string &gateType)

void	setInstant (int Instant)

void	setNumGates (unsigned int num)
	Dummy assignment function for the number of gates. More...

void	setUseConcentration (int value)

void	setX (double X)

void	setXindex (string index)

void	setXpower (const Eref &e, double Xpower)

void	setY (double Y)

void	setYindex (string index)

void	setYpower (const Eref &e, double Ypower)

void	setZ (double Z)

void	setZindex (string index)

void	setZpower (const Eref &e, double Zpower)

void	vProcess (const Eref &e, ProcPtr p)

void	vReinit (const Eref &e, ProcPtr p)

Public Member Functions inherited from ChanCommon
	ChanCommon ()

double	getGbar () const
	Utility function to acces Gbar. More...

double	getModulation () const

double	getVm () const
	Utility function to access Vm. More...

void	sendProcessMsgs (const Eref &e, const ProcPtr info)

void	sendReinitMsgs (const Eref &e, const ProcPtr info)

void	updateIk ()

double	vGetEk (const Eref &e) const

double	vGetGbar (const Eref &e) const

double	vGetGk (const Eref &e) const

double	vGetIk (const Eref &e) const

double	vGetModulation (const Eref &e) const

void	vHandleVm (double Vm)

void	vSetEk (const Eref &e, double Ek)

void	vSetGbar (const Eref &e, double Gbar)

void	vSetGk (const Eref &e, double Gk)

void	vSetIk (const Eref &e, double Ic)

void	vSetModulation (const Eref &e, double modulation)

	~ChanCommon ()

Public Member Functions inherited from ChanBase
	ChanBase ()

double	getEk (const Eref &e) const

double	getGbar (const Eref &e) const

double	getGk (const Eref &e) const

double	getIk (const Eref &e) const

double	getModulation (const Eref &e) const

void	handleVm (double Vm)

void	process (const Eref &e, const ProcPtr info)

void	reinit (const Eref &e, const ProcPtr info)

void	setEk (const Eref &e, double Ek)

void	setGbar (const Eref &e, double Gbar)

void	setGk (const Eref &e, double Gk)

void	setIk (const Eref &e, double Ic)

void	setModulation (const Eref &e, double modulation)

	~ChanBase ()

Static Public Member Functions
static const Cinfo *	initCinfo ()

static PFDD	selectPower (double power)

Static Public Member Functions inherited from ChanCommon
static const Cinfo *	initCinfo ()
	Specify the Class Info static variable for initialization. More...

Static Public Member Functions inherited from ChanBase
static SrcFinfo2< double, double > *	channelOut ()

static SrcFinfo1< double > *	IkOut ()

static const Cinfo *	initCinfo ()
	Specify the Class Info static variable for initialization. More...

static SrcFinfo1< double > *	permeability ()

Public Attributes
double(*	takeXpower_ )(double, double)

double(*	takeYpower_ )(double, double)

double(*	takeZpower_ )(double, double)

Private Member Functions
int	dependency (string index, unsigned int dim)

double	depValue (int dependency)

double	integrate (double state, double dt, double A, double B)

Static Private Member Functions
static double	power1 (double x, double p)

static double	power2 (double x, double p)

static double	power3 (double x, double p)

static double	power4 (double x, double p)

static double	powerN (double x, double p)

Private Attributes
double	conc1_
	Internal variable used to calculate conductance. More...

double	conc2_

double	g_

int	instant_
	Exponent for Z gate. More...

double	X_

int	Xdep0_

int	Xdep1_

HHGate2D *	xGate_

string	Xindex_

bool	xInited_
	State variable for Z gate. More...

double	Xpower_

double	Y_
	State variable for X gate. More...

int	Ydep0_

int	Ydep1_

HHGate2D *	yGate_

string	Yindex_

bool	yInited_

double	Ypower_
	Exponent for X gate. More...

double	Z_
	State variable for Y gate. More...

int	Zdep0_

int	Zdep1_

HHGate2D *	zGate_
	HHGate2D for the yGate. More...

string	Zindex_

bool	zInited_

double	Zpower_
	Exponent for Y gate. More...

Static Private Attributes
static const double	EPSILON = 1.0e-10
	HHGate2D for the zGate. More...

static const int	INSTANT_X = 1

static const int	INSTANT_Y = 2

static const int	INSTANT_Z = 4

Additional Inherited Members
Protected Attributes inherited from ChanCommon
double	Vm_
	Vm_ is input variable from compartment, used for most rates. More...

Detailed Description

Definition at line 24 of file HHChannel2D.h.

Constructor & Destructor Documentation

HHChannel2D::HHChannel2D ( )

Definition at line 173 of file HHChannel2D.cpp.

     :   ChanCommon(),
         Xpower_( 0.0 ),
         Ypower_( 0.0 ),
         Zpower_( 0.0 ),
         instant_(0),
         X_(0.0),
         Y_(0.0),
         Z_(0.0),
         xInited_(false),
         yInited_(false),
         zInited_(false),
         conc1_(0.0),
         conc2_(0.0),
         Xdep0_( -1 ),
         Xdep1_( -1 ),
         Ydep0_( -1 ),
         Ydep1_( -1 ),
         Zdep0_( -1 ),
         Zdep1_( -1 ),
         xGate_( 0 ),
         yGate_( 0 ),
         zGate_( 0 )
 {;}

Member Function Documentation

bool HHChannel2D::checkOriginal ( Id chanId ) const

Returns true if channel is original, false if copy.

If the gate exists and has only this element for input, then change the gate power. If the gate exists and has multiple parents, then make a new gate, set its power. If the gate does not exist, make a new gate, set its power.

The function is designed with the idea that if copies of this channel are made, then they all point back to the original HHGate. (Unless they are cross-node copies). It is only if we subsequently alter the HHGate of this channel that we need to make our own variant of the HHGate, or disconnect from an existing one.

Definition at line 599 of file HHChannel2D.cpp.

References HHGate2D::isOriginalChannel(), xGate_, yGate_, and zGate_.

Referenced by createGate(), and destroyGate().

 {
     bool isOriginal = 1;
     if ( xGate_ ) {
         isOriginal = xGate_->isOriginalChannel( chanId );
     } else if ( yGate_ ) {
         isOriginal = yGate_->isOriginalChannel( chanId );
     } else if ( zGate_ ) {
         isOriginal = zGate_->isOriginalChannel( chanId );
     }
     return isOriginal;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void HHChannel2D::conc1 ( double conc )

Assign the local conc_ to the incoming conc from the concentration calculations for the compartment. Typically the message source will be a CaConc object, but there are other options for computing the conc.

Definition at line 402 of file HHChannel2D.cpp.

References conc1_.

Referenced by initCinfo().

 {
     conc1_ = conc;
 }

Here is the caller graph for this function:

void HHChannel2D::conc2 ( double conc )

Definition at line 407 of file HHChannel2D.cpp.

References conc2_.

Referenced by initCinfo().

 {
     conc2_ = conc;
 }

Here is the caller graph for this function:

void HHChannel2D::createGate	(	const Eref &	e,
		string	gateType
	)

Function for safely creating each gate, identified by strings as X, Y and Z. Will only work on a new channel, not on a copy. The idea is that the gates are always referred to the original 'library' channel, and their contents cannot be touched except by the original.

Definition at line 624 of file HHChannel2D.cpp.

References checkOriginal(), Eref::id(), innerCreateGate(), Id::path(), Id::value(), xGate_, yGate_, and zGate_.

Referenced by setGatePower().

 {
     if ( !checkOriginal( e.id() ) ) {
         cout << "Warning: HHChannel2D::createGate: Not allowed from copied channel:\n" << e.id().path() << "\n";
         return;
     }
 
     if ( gateType == "X" )
         innerCreateGate( "xGate", &xGate_, e.id(), Id(e.id().value() + 1) );
     else if ( gateType == "Y" )
         innerCreateGate( "yGate", &yGate_, e.id(), Id(e.id().value() + 2) );
     else if ( gateType == "Z" )
         innerCreateGate( "zGate", &zGate_, e.id(), Id(e.id().value() + 3) );
     else
         cout << "Warning: HHChannel2D::createGate: Unknown gate type '" <<
             gateType << "'. Ignored\n";
 }

Here is the call graph for this function:

Here is the caller graph for this function:

int HHChannel2D::dependency	(	string	index,
		unsigned int	dim
	)

private

Definition at line 362 of file HHChannel2D.cpp.

Referenced by setXindex(), setYindex(), and setZindex().

 {
     static vector< map< string, int > > dep;
     if ( dep.empty() ) {
         dep.resize( 2 );
 
         dep[ 0 ][ "VOLT_INDEX" ] = 0;
         dep[ 0 ][ "C1_INDEX" ] = 1;
         dep[ 0 ][ "C2_INDEX" ] = 2;
 
         dep[ 0 ][ "VOLT_C1_INDEX" ] = 0;
         dep[ 0 ][ "VOLT_C2_INDEX" ] = 0;
         dep[ 0 ][ "C1_C2_INDEX" ] = 1;
 
         dep[ 1 ][ "VOLT_INDEX" ] = -1;
         dep[ 1 ][ "C1_INDEX" ] = -1;
         dep[ 1 ][ "C2_INDEX" ] = -1;
 
         dep[ 1 ][ "VOLT_C1_INDEX" ] = 1;
         dep[ 1 ][ "VOLT_C2_INDEX" ] = 2;
         dep[ 1 ][ "C1_C2_INDEX" ] = 2;
     }
 
     if ( dep[ dim ].find( index ) == dep[ dim ].end() )
         return -1;
 
     if ( dep[ dim ][ index ] == 0 )
         return 0;
     if ( dep[ dim ][ index ] == 1 )
         return 1;
     if ( dep[ dim ][ index ] == 2 )
         return 2;
 
     return -1;
 }

Here is the caller graph for this function:

double HHChannel2D::depValue ( int dependency )

private

Definition at line 351 of file HHChannel2D.cpp.

References conc1_, conc2_, and ChanCommon::Vm_.

Referenced by vProcess(), and vReinit().

 {
     switch( dep )
     {
         case 0: return Vm_;
         case 1: return conc1_;
         case 2: return conc2_;
         default: assert( 0 ); return 0.0;
     }
 }

Here is the caller graph for this function:

void HHChannel2D::destroyGate	(	const Eref &	e,
		string	gateType
	)

Utility function for destroying gate. Works only on original HHChannel. Somewhat dangerous, should never be used after a copy has been made as the pointer of the gate will be in use elsewhere.

Definition at line 655 of file HHChannel2D.cpp.

References checkOriginal(), Eref::id(), innerDestroyGate(), Id::path(), xGate_, yGate_, and zGate_.

Referenced by setGatePower().

 {
     if ( !checkOriginal( e.id() ) ) {
         cout << "Warning: HHChannel2D::destroyGate: Not allowed from copied channel:\n" << e.id().path() << "\n";
         return;
     }
 
     if ( gateType == "X" )
         innerDestroyGate( "xGate", &xGate_, e.id() );
     else if ( gateType == "Y" )
         innerDestroyGate( "yGate", &yGate_, e.id() );
     else if ( gateType == "Z" )
         innerDestroyGate( "zGate", &zGate_, e.id() );
     else
         cout << "Warning: HHChannel2D::destroyGate: Unknown gate type '" <<
             gateType << "'. Ignored\n";
 }

Here is the call graph for this function:

Here is the caller graph for this function:

int HHChannel2D::getInstant ( ) const

Definition at line 228 of file HHChannel2D.cpp.

References instant_.

Referenced by initCinfo().

 {
     return instant_;
 }

Here is the caller graph for this function:

unsigned int HHChannel2D::getNumXgates ( ) const

Access function for the number of Xgates. Gives 1 if present, otherwise 0.

Definition at line 336 of file HHChannel2D.cpp.

References xGate_.

Referenced by initCinfo().

 {
     return ( xGate_ != 0 );
 }

Here is the caller graph for this function:

unsigned int HHChannel2D::getNumYgates ( ) const

Returns 1 if Y gate present, otherwise 0.

Definition at line 341 of file HHChannel2D.cpp.

References yGate_.

Referenced by initCinfo().

 {
     return ( yGate_ != 0 );
 }

Here is the caller graph for this function:

unsigned int HHChannel2D::getNumZgates ( ) const

Returns 1 if Z gate present, otherwise 0.

Definition at line 346 of file HHChannel2D.cpp.

References zGate_.

Referenced by initCinfo().

 {
     return ( zGate_ != 0 );
 }

Here is the caller graph for this function:

int HHChannel2D::getUseConcentration ( )

double HHChannel2D::getX ( ) const

Definition at line 238 of file HHChannel2D.cpp.

References X_.

Referenced by initCinfo().

 {
     return X_;
 }

Here is the caller graph for this function:

HHGate2D * HHChannel2D::getXgate ( unsigned int i )

Access function used for the X gate. The index is ignored.

Definition at line 318 of file HHChannel2D.cpp.

References xGate_.

Referenced by initCinfo().

 {
     return xGate_;
 }

Here is the caller graph for this function:

string HHChannel2D::getXindex ( ) const

Definition at line 263 of file HHChannel2D.cpp.

References Xindex_.

Referenced by initCinfo().

 {
     return Xindex_;
 }

Here is the caller graph for this function:

double HHChannel2D::getXpower ( const Eref & e ) const

Assigns the Xpower for this gate. If the gate exists and has only this element for input, then change the gate value. If the gate exists and has multiple parents, then make a new gate. If the gate does not exist, make a new gate

Definition at line 209 of file HHChannel2D.cpp.

References Xpower_.

Referenced by initCinfo().

 {
     return Xpower_;
 }

Here is the caller graph for this function:

double HHChannel2D::getY ( ) const

Definition at line 248 of file HHChannel2D.cpp.

References Y_.

Referenced by initCinfo().

 {
     return Y_;
 }

Here is the caller graph for this function:

HHGate2D * HHChannel2D::getYgate ( unsigned int i )

Access function used for the Y gate. The index is ignored.

Definition at line 323 of file HHChannel2D.cpp.

References yGate_.

Referenced by initCinfo().

 {
     return yGate_;
 }

Here is the caller graph for this function:

string HHChannel2D::getYindex ( ) const

Definition at line 280 of file HHChannel2D.cpp.

References Yindex_.

Referenced by initCinfo().

 {
     return Yindex_;
 }

Here is the caller graph for this function:

double HHChannel2D::getYpower ( const Eref & e ) const

Definition at line 214 of file HHChannel2D.cpp.

References Ypower_.

Referenced by initCinfo().

 {
     return Ypower_;
 }

Here is the caller graph for this function:

double HHChannel2D::getZ ( ) const

Definition at line 258 of file HHChannel2D.cpp.

References Z_.

Referenced by initCinfo().

 {
     return Z_;
 }

Here is the caller graph for this function:

HHGate2D * HHChannel2D::getZgate ( unsigned int i )

Access function used for the Z gate. The index is ignored.

Definition at line 328 of file HHChannel2D.cpp.

References zGate_.

Referenced by initCinfo().

 {
     return zGate_;
 }

Here is the caller graph for this function:

string HHChannel2D::getZindex ( ) const

Definition at line 297 of file HHChannel2D.cpp.

References Zindex_.

Referenced by initCinfo().

 {
     return Zindex_;
 }

Here is the caller graph for this function:

double HHChannel2D::getZpower ( const Eref & e ) const

Definition at line 219 of file HHChannel2D.cpp.

References Zpower_.

Referenced by initCinfo().

 {
     return Zpower_;
 }

Here is the caller graph for this function:

const Cinfo * HHChannel2D::initCinfo ( )

static

Definition at line 23 of file HHChannel2D.cpp.

References conc1(), conc2(), getInstant(), getNumXgates(), getNumYgates(), getNumZgates(), getX(), getXgate(), getXindex(), getXpower(), getY(), getYgate(), getYindex(), getYpower(), getZ(), getZgate(), getZindex(), getZpower(), HHChannel2DCinfo, ChanBase::initCinfo(), HHGate2D::initCinfo(), setInstant(), setNumGates(), setX(), setXindex(), setXpower(), setY(), setYindex(), setYpower(), setZ(), setZindex(), and setZpower().

 {
     // Shared messages
 // Field definitions
     static ValueFinfo< HHChannel2D, string > Xindex( "Xindex",
         "String for setting X index.",
         &HHChannel2D::setXindex,
         &HHChannel2D::getXindex
     );
     static ValueFinfo< HHChannel2D, string > Yindex( "Yindex",
         "String for setting Y index.",
         &HHChannel2D::setYindex,
         &HHChannel2D::getYindex
     );
     static ValueFinfo< HHChannel2D, string > Zindex( "Zindex",
         "String for setting Z index.",
         &HHChannel2D::setZindex,
         &HHChannel2D::getZindex
     );
         static ElementValueFinfo< HHChannel2D, double > Xpower( "Xpower",
             "Power for X gate",
             &HHChannel2D::setXpower,
             &HHChannel2D::getXpower
         );
         static ElementValueFinfo< HHChannel2D, double > Ypower( "Ypower",
             "Power for Y gate",
             &HHChannel2D::setYpower,
             &HHChannel2D::getYpower
         );
         static ElementValueFinfo< HHChannel2D, double > Zpower( "Zpower",
             "Power for Z gate",
             &HHChannel2D::setZpower,
             &HHChannel2D::getZpower
         );
         static ValueFinfo< HHChannel2D, int > instant( "instant",
             "Bitmapped flag: bit 0 = Xgate, bit 1 = Ygate, bit 2 = Zgate"
             "When true, specifies that the lookup table value should be"
             "used directly as the state of the channel, rather than used"
             "as a rate term for numerical integration for the state",
             &HHChannel2D::setInstant,
             &HHChannel2D::getInstant
         );
         static ValueFinfo< HHChannel2D, double > X( "X",
             "State variable for X gate",
             &HHChannel2D::setX,
             &HHChannel2D::getX
         );
         static ValueFinfo< HHChannel2D, double > Y( "Y",
             "State variable for Y gate",
             &HHChannel2D::setY,
             &HHChannel2D::getY
         );
         static ValueFinfo< HHChannel2D, double > Z( "Z",
             "State variable for Y gate",
             &HHChannel2D::setZ,
             &HHChannel2D::getZ
         );
 
 // MsgSrc definitions
 
 // MsgDest definitions
     static DestFinfo concen( "concen",
         "Incoming message from Concen object to specific conc to use"
         "as the first concen variable",
         new OpFunc1< HHChannel2D, double >( &HHChannel2D::conc1 )
     );
     static DestFinfo concen2( "concen2",
         "Incoming message from Concen object to specific conc to use"
         "as the second concen variable",
         new OpFunc1< HHChannel2D, double >( &HHChannel2D::conc2 )
     );
 // FieldElementFinfo definition for HHGates. Note that these are made
 // with the deferCreate flag off, so that the HHGates are created
 // right away even if they are empty.
 // I assume that we only have a single HHGate entry for each one.
         static FieldElementFinfo< HHChannel2D, HHGate2D > gateX( "gateX",
             "Sets up HHGate X for channel",
             HHGate2D::initCinfo(),
             &HHChannel2D::getXgate,
             &HHChannel2D::setNumGates,
             &HHChannel2D::getNumXgates
         );
         static FieldElementFinfo< HHChannel2D, HHGate2D > gateY( "gateY",
             "Sets up HHGate Y for channel",
             HHGate2D::initCinfo(),
             &HHChannel2D::getYgate,
             &HHChannel2D::setNumGates,
             &HHChannel2D::getNumYgates
         );
         static FieldElementFinfo< HHChannel2D, HHGate2D > gateZ( "gateZ",
             "Sets up HHGate Z for channel",
             HHGate2D::initCinfo(),
             &HHChannel2D::getZgate,
             &HHChannel2D::setNumGates,
             &HHChannel2D::getNumZgates
         );
     static Finfo* HHChannel2DFinfos[] =
     {
         &Xindex,    // Value
         &Yindex,    // Value
         &Zindex,    // Value
         &Xpower,    // Value
         &Ypower,    // Value
         &Zpower,    // Value
         &instant,   // Value
         &X,         // Value
         &Y,         // Value
         &Z,         // Value
         &concen,    // Dest
         &concen2,   // Dest
         &gateX,     // FieldElement
         &gateY,     // FieldElement
         &gateZ      // FieldElement
     };
 
     static string doc[] =
     {
         "Name", "HHChannel2D",
         "Author", "Niraj Dudani, 2009, NCBS, Updated Upi Bhalla, 2011",
         "Description", "HHChannel2D: Hodgkin-Huxley type voltage-gated Ion channel. Something "
         "like the old tabchannel from GENESIS, but also presents "
         "a similar interface as hhchan from GENESIS. ",
     };
 
         static Dinfo< HHChannel2D > dinfo;
     static Cinfo HHChannel2DCinfo(
         "HHChannel2D",
         ChanBase::initCinfo(),
         HHChannel2DFinfos,
         sizeof( HHChannel2DFinfos ) / sizeof(Finfo *),
         &dinfo,
                 doc,
                 sizeof(doc) / sizeof(string)
     );
 
     return &HHChannel2DCinfo;
 }

Here is the call graph for this function:

void HHChannel2D::innerCreateGate	(	const string &	gateName,
		HHGate2D **	gatePtr,
		Id	chanId,
		Id	gateId
	)

Inner utility function for creating the gate.

Definition at line 612 of file HHChannel2D.cpp.

References Id::path().

Referenced by createGate().

 {
     //Shell* shell = reinterpret_cast< Shell* >( ObjId( Id(), 0 ).data() );
     if ( *gatePtr ) {
         cout << "Warning: HHChannel2D::createGate: '" << gateName <<
             "' on Element '" << chanId.path() << "' already present\n";
         return;
     }
     *gatePtr = new HHGate2D( chanId, gateId );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void HHChannel2D::innerDestroyGate	(	const string &	gateName,
		HHGate2D **	gatePtr,
		Id	chanId
	)

Inner utility for destroying the gate

Definition at line 643 of file HHChannel2D.cpp.

References Id::path().

Referenced by destroyGate().

 {
     if ( *gatePtr == 0 ) {
         cout << "Warning: HHChannel2D::destroyGate: '" << gateName <<
             "' on Element '" << chanId.path() << "' not present\n";
         return;
     }
     delete (*gatePtr);
     *gatePtr = 0;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

double HHChannel2D::integrate	(	double	state,
		double	dt,
		double	A,
		double	B
	)

private

Returns the state variable for the new timestep based on the internal variables A_ and B_ which were passed in from the gate.

Definition at line 420 of file HHChannel2D.cpp.

References EPSILON.

Referenced by vProcess().

 {
     if ( B > EPSILON ) {
         double x = exp( -B * dt );
         return state * x + ( A / B ) * ( 1 - x );
     }
     return state + A * dt ;
 }

Here is the caller graph for this function:

static double HHChannel2D::power1	(	double	x,
		double	p
	)

inlinestaticprivate

Definition at line 208 of file HHChannel2D.h.

Referenced by selectPower().

                                                    {
             return x;
         }

Here is the caller graph for this function:

static double HHChannel2D::power2	(	double	x,
		double	p
	)

inlinestaticprivate

Definition at line 211 of file HHChannel2D.h.

Referenced by power4(), and selectPower().

                                                    {
             return x * x;
         }

Here is the caller graph for this function:

static double HHChannel2D::power3	(	double	x,
		double	p
	)

inlinestaticprivate

Definition at line 214 of file HHChannel2D.h.

Referenced by selectPower().

                                                    {
             return x * x * x;
         }

Here is the caller graph for this function:

static double HHChannel2D::power4	(	double	x,
		double	p
	)

inlinestaticprivate

Definition at line 217 of file HHChannel2D.h.

References power2().

Referenced by selectPower().

                                                    {
             return power2( x * x, p );
         }

Here is the call graph for this function:

Here is the caller graph for this function:

double HHChannel2D::powerN	(	double	x,
		double	p
	)

staticprivate

Definition at line 674 of file HHChannel2D.cpp.

References moose::log().

Referenced by selectPower().

 {
     if ( x > 0.0 )
         return exp( p * log( x ) );
     return 0.0;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

PFDD HHChannel2D::selectPower ( double power )

static

Definition at line 681 of file HHChannel2D.cpp.

References power1(), power2(), power3(), power4(), and powerN().

Referenced by setXpower(), setYpower(), and setZpower().

 {
     if ( power == 0.0 )
         return powerN;
     else if ( power == 1.0 )
         return power1;
     else if ( power == 2.0 )
         return power2;
     else if ( power == 3.0 )
         return power3;
     else if ( power == 4.0 )
         return power4;
     else
         return powerN;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

bool HHChannel2D::setGatePower	(	const Eref &	e,
		double	power,
		double *	assignee,
		const string &	gateType
	)

Utility for altering gate powers

Definition at line 535 of file HHChannel2D.cpp.

References createGate(), destroyGate(), and doubleEq().

Referenced by setXpower(), setYpower(), and setZpower().

 {
     if ( power < 0 ) {
         cout << "Error: HHChannel2D::set" << gateType <<
             "power: Cannot use negative power: " << power << endl;
         return 0;
     }
 
     if ( doubleEq( power, *assignee ) )
         return 0;
 
     if ( doubleEq( *assignee, 0.0 ) && power > 0 ) {
         createGate( e, gateType );
     } else if ( doubleEq( power, 0.0 ) ) {
         destroyGate( e, gateType );
     }
 
     *assignee = power;
     return 1;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void HHChannel2D::setInstant ( int Instant )

Definition at line 224 of file HHChannel2D.cpp.

References instant_.

Referenced by initCinfo().

 {
     instant_ = instant;
 }

Here is the caller graph for this function:

void HHChannel2D::setNumGates ( unsigned int num )

Dummy assignment function for the number of gates.

Definition at line 333 of file HHChannel2D.cpp.

Referenced by initCinfo().

334 { ; }

Here is the caller graph for this function:

void HHChannel2D::setUseConcentration ( int value )

void HHChannel2D::setX ( double X )

Definition at line 233 of file HHChannel2D.cpp.

References X_, and xInited_.

Referenced by initCinfo().

 {
         X_ = X;
         xInited_ = true;
 }

Here is the caller graph for this function:

void HHChannel2D::setXindex ( string index )

Definition at line 268 of file HHChannel2D.cpp.

References dependency(), Xdep0_, Xdep1_, and Xindex_.

Referenced by initCinfo().

 {
     if ( Xindex == Xindex_ )
         return;
 
     Xindex_ = Xindex;
     Xdep0_ = dependency( Xindex, 0 );
     Xdep1_ = dependency( Xindex, 1 );
 
     assert( Xdep0_ >= 0 );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void HHChannel2D::setXpower	(	const Eref &	e,
		double	Xpower
	)

Assigns the Xpower for this gate. If the gate exists and has only this element for input, then change the gate value. If the gate exists and has multiple parents, then make a new gate. If the gate does not exist, make a new gate

Definition at line 563 of file HHChannel2D.cpp.

References selectPower(), setGatePower(), takeXpower_, and Xpower_.

Referenced by initCinfo().

 {
     if ( setGatePower( e, Xpower, &Xpower_, "X" ) )
         takeXpower_ = selectPower( Xpower );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void HHChannel2D::setY ( double Y )

Definition at line 243 of file HHChannel2D.cpp.

References Y_, and yInited_.

Referenced by initCinfo().

 {
         Y_ = Y;
         yInited_ = true;
 }

Here is the caller graph for this function:

void HHChannel2D::setYindex ( string index )

Definition at line 285 of file HHChannel2D.cpp.

References dependency(), Ydep0_, Ydep1_, and Yindex_.

Referenced by initCinfo().

 {
     if ( Yindex == Yindex_ )
         return;
 
     Yindex_ = Yindex;
     Ydep0_ = dependency( Yindex, 0 );
     Ydep1_ = dependency( Yindex, 1 );
 
     assert( Ydep0_ >= 0 );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void HHChannel2D::setYpower	(	const Eref &	e,
		double	Ypower
	)

Definition at line 569 of file HHChannel2D.cpp.

References selectPower(), setGatePower(), takeYpower_, and Ypower_.

Referenced by initCinfo().

 {
     if ( setGatePower( e, Ypower, &Ypower_, "Y" ) )
         takeYpower_ = selectPower( Ypower );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void HHChannel2D::setZ ( double Z )

Definition at line 253 of file HHChannel2D.cpp.

References Z_, and zInited_.

Referenced by initCinfo().

 {
         Z_ = Z;
         zInited_ = true;
 }

Here is the caller graph for this function:

void HHChannel2D::setZindex ( string index )

Definition at line 302 of file HHChannel2D.cpp.

References dependency(), Zdep0_, Zdep1_, and Zindex_.

Referenced by initCinfo().

 {
     if ( Zindex == Zindex_ )
         return;
 
     Zindex_ = Zindex;
     Zdep0_ = dependency( Zindex, 0 );
     Zdep1_ = dependency( Zindex, 1 );
 
     assert( Zdep0_ >= 0 );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void HHChannel2D::setZpower	(	const Eref &	e,
		double	Zpower
	)

Definition at line 575 of file HHChannel2D.cpp.

References selectPower(), setGatePower(), takeZpower_, and Zpower_.

Referenced by initCinfo().

 {
     if ( setGatePower( e, Zpower, &Zpower_, "Z" ) )
         takeZpower_ = selectPower( Zpower );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void HHChannel2D::vProcess	(	const Eref &	e,
		ProcPtr	p
	)

virtual

processFunc handles the update and calculations every clock tick. It first sends the request for evaluation of the gate variables to the respective gate objects and recieves their response immediately through a return message. This is done so that many channel instances can share the same gate lookup tables, but do so cleanly. Such messages should never go to a remote node. Then the function does its own little calculations to send back to the parent compartment through regular messages.

Implements ChanBase.

Definition at line 429 of file HHChannel2D.cpp.

References depValue(), ProcInfo::dt, g_, ChanBase::getGbar(), instant_, INSTANT_X, INSTANT_Y, INSTANT_Z, integrate(), HHGate2D::lookupBoth(), ChanCommon::sendProcessMsgs(), ChanBase::setGk(), takeXpower_, takeYpower_, takeZpower_, ChanCommon::updateIk(), ChanCommon::vGetModulation(), X_, Xdep0_, Xdep1_, xGate_, Xpower_, Y_, Ydep0_, Ydep1_, yGate_, Ypower_, Z_, Zdep0_, Zdep1_, zGate_, and Zpower_.

 {
     g_ += ChanBase::getGbar( e );
     double A = 0;
     double B = 0;
     if ( Xpower_ > 0 ) {
         xGate_->lookupBoth( depValue( Xdep0_ ), depValue( Xdep1_ ), &A, &B );
         if ( instant_ & INSTANT_X )
             X_ = A/B;
         else
             X_ = integrate( X_, info->dt, A, B );
         g_ *= takeXpower_( X_, Xpower_ );
     }
 
     if ( Ypower_ > 0 ) {
         yGate_->lookupBoth( depValue( Ydep0_ ), depValue( Ydep1_ ), &A, &B );
         if ( instant_ & INSTANT_Y )
             Y_ = A/B;
         else
             Y_ = integrate( Y_, info->dt, A, B );
 
         g_ *= takeYpower_( Y_, Ypower_ );
     }
 
     if ( Zpower_ > 0 ) {
         zGate_->lookupBoth( depValue( Zdep0_ ), depValue( Zdep1_ ), &A, &B );
         if ( instant_ & INSTANT_Z )
             Z_ = A/B;
         else
             Z_ = integrate( Z_, info->dt, A, B );
 
         g_ *= takeZpower_( Z_, Zpower_ );
     }
 
     ChanBase::setGk( e, g_ * vGetModulation( e ) );
     updateIk();
     // Gk_ = g_;
     // Ik_ = ( Ek_ - Vm_ ) * g_;
 
     // Send out the relevant channel messages.
     sendProcessMsgs( e, info );
     g_ = 0.0;
  }

Here is the call graph for this function:

void HHChannel2D::vReinit	(	const Eref &	er,
		ProcPtr	info
	)

virtual

Reinitializes the values for the channel. This involves computing the steady-state value for the channel gates using the provided Vm from the parent compartment. It involves a similar cycle through the gates and then updates to the parent compartment as for the processFunc.

Here we get the steady-state values for the gate (the 'instant' calculation) as A_/B_.

Implements ChanBase.

Definition at line 477 of file HHChannel2D.cpp.

References depValue(), Eref::element(), EPSILON, g_, ChanBase::getGbar(), Element::getName(), HHGate2D::lookupBoth(), ChanCommon::sendReinitMsgs(), ChanBase::setGk(), takeXpower_, takeYpower_, takeZpower_, ChanCommon::updateIk(), ChanCommon::vGetModulation(), X_, Xdep0_, Xdep1_, xGate_, xInited_, Xpower_, Y_, Ydep0_, Ydep1_, yGate_, yInited_, Ypower_, Z_, Zdep0_, Zdep1_, zGate_, zInited_, and Zpower_.

  {
      g_ = ChanBase::getGbar( er );
      Element* e = er.element();
 
      double A = 0.0;
      double B = 0.0;
      if ( Xpower_ > 0 ) {
          xGate_->lookupBoth( depValue( Xdep0_ ), depValue( Xdep1_ ), &A, &B );
          if ( B < EPSILON ) {
              cout << "Warning: B_ value for " << e->getName() <<
                      " is ~0. Check X table\n";
              return;
          }
                  if (!xInited_)
                      X_ = A/B;
          g_ *= takeXpower_( X_, Xpower_ );
      }
 
      if ( Ypower_ > 0 ) {
          yGate_->lookupBoth( depValue( Ydep0_ ), depValue( Ydep1_ ), &A, &B );
          if ( B < EPSILON ) {
              cout << "Warning: B value for " << e->getName() <<
                      " is ~0. Check Y table\n";
              return;
          }
                  if (!yInited_)
                      Y_ = A/B;
          g_ *= takeYpower_( Y_, Ypower_ );
      }
 
      if ( Zpower_ > 0 ) {
          zGate_->lookupBoth( depValue( Zdep0_ ), depValue( Zdep1_ ), &A, &B );
          if ( B < EPSILON ) {
              cout << "Warning: B value for " << e->getName() <<
                      " is ~0. Check Z table\n";
              return;
          }
                  if (!zInited_)
                      Z_ = A/B;
          g_ *= takeZpower_( Z_, Zpower_ );
      }
 
      ChanBase::setGk( er, g_ * vGetModulation( er ) );
      updateIk();
      // Gk_ = g_;
      // Ik_ = ( Ek_ - Vm_ ) * g_;
 
      // Send out the relevant channel messages.
      // Same for reinit as for process.
      sendReinitMsgs( er, info );
     g_ = 0.0;
 }

Here is the call graph for this function:

Member Data Documentation

double HHChannel2D::conc1_

private

Internal variable used to calculate conductance.

Definition at line 180 of file HHChannel2D.h.

Referenced by conc1(), and depValue().

double HHChannel2D::conc2_

private

Definition at line 181 of file HHChannel2D.h.

Referenced by conc2(), and depValue().

const double HHChannel2D::EPSILON = 1.0e-10

staticprivate

HHGate2D for the zGate.

Definition at line 203 of file HHChannel2D.h.

Referenced by integrate(), and vReinit().

double HHChannel2D::g_

private

Definition at line 178 of file HHChannel2D.h.

Referenced by vProcess(), and vReinit().

int HHChannel2D::instant_

private

Exponent for Z gate.

bitmapped flag for X, Y, Z, to do equil calculation for gate

Definition at line 168 of file HHChannel2D.h.

Referenced by getInstant(), setInstant(), and vProcess().

const int HHChannel2D::INSTANT_X = 1

staticprivate

Definition at line 204 of file HHChannel2D.h.

Referenced by vProcess().

const int HHChannel2D::INSTANT_Y = 2

staticprivate

Definition at line 205 of file HHChannel2D.h.

Referenced by vProcess().

const int HHChannel2D::INSTANT_Z = 4

staticprivate

Definition at line 206 of file HHChannel2D.h.

Referenced by vProcess().

double( * HHChannel2D::takeXpower_)(double, double)

Definition at line 113 of file HHChannel2D.h.

Referenced by setXpower(), vProcess(), and vReinit().

double( * HHChannel2D::takeYpower_)(double, double)

Definition at line 114 of file HHChannel2D.h.

Referenced by setYpower(), vProcess(), and vReinit().

double( * HHChannel2D::takeZpower_)(double, double)

Definition at line 115 of file HHChannel2D.h.

Referenced by setZpower(), vProcess(), and vReinit().

double HHChannel2D::X_

private

Definition at line 169 of file HHChannel2D.h.

Referenced by getX(), setX(), vProcess(), and vReinit().

int HHChannel2D::Xdep0_

private

Definition at line 187 of file HHChannel2D.h.

Referenced by setXindex(), vProcess(), and vReinit().

int HHChannel2D::Xdep1_

private

Definition at line 188 of file HHChannel2D.h.

Referenced by setXindex(), vProcess(), and vReinit().

HHGate2D* HHChannel2D::xGate_

private

HHGate2D data structure for the xGate. This is writable only on the HHChannel that originally created the HHGate, for others it must be treated as readonly.

Definition at line 199 of file HHChannel2D.h.

Referenced by checkOriginal(), createGate(), destroyGate(), getNumXgates(), getXgate(), vProcess(), and vReinit().