#include <ChanCommon.h>

Inheritance diagram for ChanCommon:

Collaboration diagram for ChanCommon:

Public Member Functions
	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)

virtual void	vProcess (const Eref &e, const ProcPtr info)=0

virtual void	vReinit (const Eref &e, const ProcPtr info)=0

	~ChanBase ()

Static Public Member Functions
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 ()

Protected Attributes
double	Vm_
	Vm_ is input variable from compartment, used for most rates. More...

Private Attributes
double	Ek_
	Reversal potential of channel. More...

double	Gbar_
	Channel maximal conductance. More...

double	Gk_
	Channel actual conductance depending on opening of gates. More...

double	Ik_
	Channel current. More...

double	modulation_
	Channel modulation. Scales conductance. More...

Detailed Description

The ChanCommon.g handles the data fields for all ion channel classes in MOOSE, when they are using regular ee calculations rather than being zombified by the solver.

Definition at line 21 of file ChanCommon.h.

Constructor & Destructor Documentation

ChanCommon::ChanCommon ( )

Definition at line 17 of file ChanCommon.cpp.

             :
             Vm_( 0.0 ),
             Gbar_( 0.0 ), modulation_( 1.0 ),
             Ek_( 0.0 ),
             Gk_( 0.0 ), Ik_( 0.0 )
 {
     ;
 }

ChanCommon::~ChanCommon ( )

Definition at line 27 of file ChanCommon.cpp.

28 {;}

Member Function Documentation

double ChanCommon::getGbar ( ) const

Utility function to acces Gbar.

Definition at line 129 of file ChanCommon.cpp.

References Gbar_.

Referenced by SynChan::normalizeGbar().

 {
     return Gbar_;
 }

Here is the caller graph for this function:

double ChanCommon::getModulation ( ) const

Definition at line 54 of file ChanCommon.cpp.

References modulation_.

Referenced by SynChan::calcGk().

 {
     return modulation_;
 }

Here is the caller graph for this function:

double ChanCommon::getVm ( ) const

Utility function to access Vm.

Definition at line 124 of file ChanCommon.cpp.

References Vm_.

 {
     return Vm_;
 }

static const Cinfo* ChanCommon::initCinfo ( )

static

Specify the Class Info static variable for initialization.

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

This function sends out the messages expected of a channel, after process. Used as a utility by various derived classes.

Definition at line 100 of file ChanCommon.cpp.

References ChanBase::channelOut(), Ek_, Gk_, Ik_, ChanBase::IkOut(), and ChanBase::permeability().

Referenced by MgBlock::vProcess(), SynChan::vProcess(), Leakage::vProcess(), NMDAChan::vProcess(), MarkovChannel::vProcess(), HHChannel2D::vProcess(), and HHChannel::vProcess().

 {
         ChanBase::channelOut()->send( e, Gk_, Ek_ );
     // This is used if the channel connects up to a conc pool and
     // handles influx of ions giving rise to a concentration change.
         ChanBase::IkOut()->send( e, Ik_ );
     // Needed by GHK-type objects
         ChanBase::permeability()->send( e, Gk_ );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 111 of file ChanCommon.cpp.

References ChanBase::channelOut(), Ek_, Gk_, Ik_, ChanBase::IkOut(), and ChanBase::permeability().

Referenced by SynChan::vReinit(), MgBlock::vReinit(), Leakage::vReinit(), NMDAChan::vReinit(), MarkovChannel::vReinit(), HHChannel2D::vReinit(), and HHChannel::vReinit().

 {
         ChanBase::channelOut()->send( e, Gk_, Ek_ );
         ChanBase::IkOut()->send( e, Ik_ );
     // Needed by GHK-type objects
         ChanBase::permeability()->send( e, Gk_ );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void ChanCommon::updateIk ( )

Utility function for a common computation using local variables

Definition at line 119 of file ChanCommon.cpp.

References Ek_, Gk_, Ik_, and Vm_.

Referenced by MgBlock::vProcess(), SynChan::vProcess(), Leakage::vProcess(), NMDAChan::vProcess(), MarkovChannel::vProcess(), HHChannel2D::vProcess(), HHChannel::vProcess(), Leakage::vReinit(), HHChannel2D::vReinit(), and HHChannel::vReinit().

 {
     Ik_ = ( Ek_ - Vm_ ) * Gk_;
 }

Here is the caller graph for this function:

double ChanCommon::vGetEk ( const Eref & e ) const

virtual

Implements ChanBase.

Definition at line 63 of file ChanCommon.cpp.

References Ek_.

 {
     return Ek_;
 }

double ChanCommon::vGetGbar ( const Eref & e ) const

virtual

Implements ChanBase.

Definition at line 39 of file ChanCommon.cpp.

References Gbar_.

Referenced by Leakage::vProcess(), HHChannel::vProcess(), Leakage::vReinit(), and HHChannel::vReinit().

 {
     return Gbar_;
 }

Here is the caller graph for this function:

double ChanCommon::vGetGk ( const Eref & e ) const

virtual

Implements ChanBase.

Definition at line 72 of file ChanCommon.cpp.

References Gk_.

 {
     return Gk_;
 }

double ChanCommon::vGetIk ( const Eref & e ) const

virtual

Implements ChanBase.

Definition at line 81 of file ChanCommon.cpp.

References Ik_.

 {
     return Ik_;
 }

double ChanCommon::vGetModulation ( const Eref & e ) const

virtual

Implements ChanBase.

Reimplemented in HHChannel.

Definition at line 49 of file ChanCommon.cpp.

References modulation_.

Referenced by Leakage::vProcess(), HHChannel2D::vProcess(), Leakage::vReinit(), HHChannel2D::vReinit(), and Leakage::vSetGbar().

 {
     return modulation_;
 }

Here is the caller graph for this function:

void ChanCommon::vHandleVm ( double Vm )

virtual

Assign the local Vm_ to the incoming Vm from the compartment

Implements ChanBase.

Definition at line 90 of file ChanCommon.cpp.

References Vm_.

 {
     Vm_ = Vm;
 }

void ChanCommon::vSetEk	(	const Eref &	e,
		double	Ek
	)

virtual

Implements ChanBase.

Definition at line 59 of file ChanCommon.cpp.

References Ek_.

 {
     Ek_ = Ek;
 }

void ChanCommon::vSetGbar	(	const Eref &	e,
		double	Gbar
	)

virtual

Implements ChanBase.

Reimplemented in Leakage, and SynChan.

Definition at line 34 of file ChanCommon.cpp.

References Gbar_.

Referenced by SynChan::vSetGbar(), and Leakage::vSetGbar().

 {
     Gbar_ = Gbar;
 }

Here is the caller graph for this function:

void ChanCommon::vSetGk	(	const Eref &	e,
		double	Gk
	)

virtual

Implements ChanBase.

Definition at line 68 of file ChanCommon.cpp.

References Gk_.

Referenced by Leakage::vProcess(), HHChannel::vProcess(), Leakage::vReinit(), HHChannel::vReinit(), and Leakage::vSetGbar().

 {
     Gk_ = Gk;
 }

Here is the caller graph for this function:

void ChanCommon::vSetIk	(	const Eref &	e,
		double	Ic
	)

virtual

Ik is read-only for MOOSE, but we provide the set func for derived classes to update it.

Implements ChanBase.

Definition at line 77 of file ChanCommon.cpp.

References Ik_.

 {
     Ik_ = Ik;
 }

void ChanCommon::vSetModulation	(	const Eref &	e,
		double	modulation
	)

virtual

Implements ChanBase.

Reimplemented in HHChannel.

Definition at line 44 of file ChanCommon.cpp.

References modulation_.

 {
     modulation_ = modulation;
 }

Member Data Documentation

double ChanCommon::Ek_

private

Reversal potential of channel.

Definition at line 88 of file ChanCommon.h.

Referenced by sendProcessMsgs(), sendReinitMsgs(), updateIk(), vGetEk(), and vSetEk().

double ChanCommon::Gbar_

private

Channel maximal conductance.

Definition at line 84 of file ChanCommon.h.

Referenced by getGbar(), vGetGbar(), and vSetGbar().

double ChanCommon::Gk_

private

Channel actual conductance depending on opening of gates.

Definition at line 91 of file ChanCommon.h.

Referenced by sendProcessMsgs(), sendReinitMsgs(), updateIk(), vGetGk(), and vSetGk().

double ChanCommon::Ik_

private

Channel current.

Definition at line 93 of file ChanCommon.h.

Referenced by sendProcessMsgs(), sendReinitMsgs(), updateIk(), vGetIk(), and vSetIk().

double ChanCommon::modulation_

private

Channel modulation. Scales conductance.

Definition at line 86 of file ChanCommon.h.

Referenced by getModulation(), vGetModulation(), and vSetModulation().

double ChanCommon::Vm_

protected

Vm_ is input variable from compartment, used for most rates.

Definition at line 80 of file ChanCommon.h.

Referenced by HHChannel2D::depValue(), MarkovChannel::getVm(), getVm(), MarkovChannel::setVm(), updateIk(), vHandleVm(), MgBlock::vProcess(), NMDAChan::vProcess(), HHChannel::vProcess(), and HHChannel::vReinit().

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

moose-core/biophysics/ChanCommon.h
moose-core/biophysics/ChanCommon.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation