Nernst Class Reference

#include <Nernst.h>

Collaboration diagram for Nernst:

Public Member Functions
double	getCin () const
double	getCout () const
double	getE () const
double	getScale () const
double	getTemperature () const
int	getValence () const
void	handleCin (const Eref &e, double conc)
void	handleCout (const Eref &e, double conc)
	Nernst ()
void	setCin (double value)
void	setCout (double value)
void	setScale (double value)
void	setTemperature (double value)
void	setValence (int value)

Static Public Member Functions
static const Cinfo *	initCinfo ()

Private Member Functions
void	updateE ()

Private Attributes
double	Cin_
double	Cout_
double	E_
double	factor_
double	scale_
double	Temperature_
int	valence_

Static Private Attributes
static const double	R_OVER_F = 8.6171458e-5
static const double	ZERO_CELSIUS = 273.15

Detailed Description

This class does the Nernst equation calculations

Definition at line 16 of file Nernst.h.

Constructor & Destructor Documentation

Nernst::Nernst

(

)

Definition at line 118 of file Nernst.cpp.

    :
        E_( 0.0 ),
        Temperature_( 295 ),
        valence_( 1 ),
        Cin_( 1.0 ),
        Cout_( 1.0 ),
        scale_( 1.0 ),
        factor_( scale_ * R_OVER_F * Temperature_ / valence_ )
{;}

Member Function Documentation

double Nernst::getCin

(

)

const

Definition at line 168 of file Nernst.cpp.

References Cin_.

Referenced by initCinfo().

{
    return Cin_;
}

Here is the caller graph for this function:

double Nernst::getCout

(

)

const

Definition at line 177 of file Nernst.cpp.

References Cout_.

Referenced by initCinfo().

{
    return Cout_;
}

Here is the caller graph for this function:

double Nernst::getE

(

)

const

Definition at line 132 of file Nernst.cpp.

References E_.

Referenced by initCinfo().

{
    return E_;
}

Here is the caller graph for this function:

double Nernst::getScale

(

)

const

Definition at line 187 of file Nernst.cpp.

References scale_.

Referenced by initCinfo().

{
    return scale_;
}

Here is the caller graph for this function:

double Nernst::getTemperature

(

)

const

Definition at line 145 of file Nernst.cpp.

References Temperature_.

Referenced by initCinfo().

{
    return Temperature_;
}

Here is the caller graph for this function:

int Nernst::getValence

(

)

const

Definition at line 158 of file Nernst.cpp.

References valence_.

Referenced by initCinfo().

{
    return valence_;
}

Here is the caller graph for this function:

void Nernst::handleCin	(	const Eref &	e,
		double	conc
	)

Definition at line 201 of file Nernst.cpp.

References Cin_, E_, Eout(), and updateE().

Referenced by initCinfo().

{
    Cin_ = conc;
    updateE();
    Eout()->send( er, E_ );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Nernst::handleCout	(	const Eref &	e,
		double	conc
	)

Definition at line 208 of file Nernst.cpp.

References Cout_, E_, Eout(), and updateE().

Referenced by initCinfo().

{
    Cout_ = conc;
    updateE();
    Eout()->send( er, E_ );
}

Here is the call graph for this function:

Here is the caller graph for this function:

const Cinfo * Nernst::initCinfo ( )

static

Definition at line 26 of file Nernst.cpp.

References Eout(), getCin(), getCout(), getE(), getScale(), getTemperature(), getValence(), handleCin(), handleCout(), Neutral::initCinfo(), setCin(), setCout(), setScale(), setTemperature(), and setValence().

{
    static ReadOnlyValueFinfo< Nernst, double > E( "E",
        "Computed reversal potential",
            &Nernst::getE
    );
    static ValueFinfo< Nernst, double > temperature( "Temperature",
        "Temperature of cell",
        &Nernst::setTemperature,
        &Nernst::getTemperature
    );
    static ValueFinfo< Nernst, int > valence( "valence",
        "Valence of ion in Nernst calculation",
        &Nernst::setValence,
        &Nernst::getValence
    );
    static ValueFinfo< Nernst, double > Cin( "Cin",
        "Internal conc of ion",
        &Nernst::setCin,
        &Nernst::getCin
    );
    static ValueFinfo< Nernst, double > Cout( "Cout",
        "External conc of ion",
        &Nernst::setCout,
        &Nernst::getCout
    );
    static ValueFinfo< Nernst, double > scale( "scale",
        "Voltage scale factor",
        &Nernst::setScale,
        &Nernst::getScale
    );
    // Shared definitions


    // MsgDest definitions
    // These differ from field assignments because they trigger an
    // outgoing msg with the updated E.
    static DestFinfo ci( "ci",
        "Set internal conc of ion, and immediately send out the updated E",
        new EpFunc1< Nernst, double >( &Nernst::handleCin )
    );
    static DestFinfo co( "co",
        "Set external conc of ion, and immediately send out the updated E",
        new EpFunc1< Nernst, double >( &Nernst::handleCout )
    );

    // Field definitions
    static Finfo* NernstFinfos[] =
    {
        Eout(),     // SrcFinfo
        &E,         // ReadOnlyValue
        &temperature,   // Value
        &valence,       // Value
        &Cin,       // Value
        &Cout,      // Value
        &scale,     // Value
        &ci,        // Dest
        &co,        // Dest
    };

    static string doc[] =
    {
        "Name", "Nernst",
        "Author", "Upinder S. Bhalla, 2007, NCBS",
        "Description", "Nernst: Calculates Nernst potential for a given ion based on "
                "Cin and Cout, the inside and outside concentrations. "
                "Immediately sends out the potential to all targets.",
    };

    static Dinfo< Nernst > dinfo;
    static const Cinfo NernstCinfo(
        "Nernst",
        Neutral::initCinfo(),
        NernstFinfos,
        sizeof( NernstFinfos ) / sizeof(Finfo *),
        &dinfo,
        doc,
        sizeof( doc ) / sizeof( string )
    );

    return &NernstCinfo;
}

Here is the call graph for this function:

void Nernst::setCin

(

double

value

)

Definition at line 163 of file Nernst.cpp.

References Cin_, updateE(), and value.

Referenced by initCinfo().

{
    Cin_ = value;
    updateE();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Nernst::setCout

(

double

value

)

Definition at line 173 of file Nernst.cpp.

References Cout_, updateE(), and value.

Referenced by initCinfo().

                                   {
    Cout_ = value;
    updateE();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Nernst::setScale

(

double

value

)

Definition at line 182 of file Nernst.cpp.

References factor_, R_OVER_F, scale_, Temperature_, updateE(), valence_, and value.

Referenced by initCinfo().

                                    {
    scale_ = value;
    factor_ = scale_ * R_OVER_F * Temperature_ / valence_;
    updateE();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Nernst::setTemperature

(

double

value

)

Definition at line 137 of file Nernst.cpp.

References factor_, R_OVER_F, scale_, Temperature_, updateE(), valence_, and value.

Referenced by initCinfo().

                                          {
    if ( value > 0.0 ) {
        Temperature_ = value;
        factor_ = scale_ * R_OVER_F * Temperature_ / valence_;
    }
    updateE();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Nernst::setValence

(

int

value

)

Definition at line 150 of file Nernst.cpp.

References factor_, R_OVER_F, scale_, Temperature_, updateE(), valence_, and value.

Referenced by initCinfo().

                                   {
    if ( value != 0 ) {
        valence_ = value;
    }
    factor_ = scale_ * R_OVER_F * Temperature_ / valence_;
    updateE();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Nernst::updateE ( )

private

Definition at line 196 of file Nernst.cpp.

References Cin_, Cout_, E_, factor_, and moose::log().

Referenced by handleCin(), handleCout(), setCin(), setCout(), setScale(), setTemperature(), and setValence().

{
    E_ = factor_ * log( Cout_ / Cin_ );
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

double Nernst::Cin_

private

Definition at line 54 of file Nernst.h.

Referenced by getCin(), handleCin(), setCin(), and updateE().

double Nernst::Cout_

private

Definition at line 55 of file Nernst.h.

Referenced by getCout(), handleCout(), setCout(), and updateE().

double Nernst::E_

private

Definition at line 51 of file Nernst.h.

Referenced by getE(), handleCin(), handleCout(), and updateE().

double Nernst::factor_

private

Definition at line 57 of file Nernst.h.

Referenced by setScale(), setTemperature(), setValence(), and updateE().

const double Nernst::R_OVER_F = 8.6171458e-5

staticprivate

Definition at line 58 of file Nernst.h.

Referenced by setScale(), setTemperature(), and setValence().

double Nernst::scale_

private

Definition at line 56 of file Nernst.h.

Referenced by getScale(), setScale(), setTemperature(), and setValence().

double Nernst::Temperature_

private

Definition at line 52 of file Nernst.h.

Referenced by getTemperature(), setScale(), setTemperature(), and setValence().

int Nernst::valence_

private

Definition at line 53 of file Nernst.h.

Referenced by getValence(), setScale(), setTemperature(), and setValence().

const double Nernst::ZERO_CELSIUS = 273.15

staticprivate

Definition at line 59 of file Nernst.h.

---

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

• moose-core/biophysics/Nernst.h
• moose-core/biophysics/Nernst.cpp