HHGate2D Class Reference

#include <HHGate2D.h>

Collaboration diagram for HHGate2D:

Public Member Functions
bool	checkOriginal (Id id, const string &field) const
vector< vector< double > >	getTableA (const Eref &e) const
vector< vector< double > >	getTableB (const Eref &e) const
unsigned int	getXdivsA (const Eref &e) const
unsigned int	getXdivsB (const Eref &e) const
double	getXmaxA (const Eref &e) const
double	getXmaxB (const Eref &e) const
double	getXminA (const Eref &e) const
double	getXminB (const Eref &e) const
unsigned int	getYdivsA (const Eref &e) const
unsigned int	getYdivsB (const Eref &e) const
double	getYmaxA (const Eref &e) const
double	getYmaxB (const Eref &e) const
double	getYminA (const Eref &e) const
double	getYminB (const Eref &e) const
	HHGate2D ()
	HHGate2D (Id originalChanId, Id originalGateId)
bool	isOriginalChannel (Id id) const
bool	isOriginalGate (Id id) const
double	lookupA (vector< double > v) const
double	lookupB (vector< double > v) const
void	lookupBoth (double v, double c, double *A, double *B) const
Id	originalChannelId () const
void	setTableA (const Eref &e, vector< vector< double > > value)
void	setTableB (const Eref &e, vector< vector< double > > value)
void	setXdivsA (const Eref &e, unsigned int value)
void	setXdivsB (const Eref &e, unsigned int value)
void	setXmaxA (const Eref &e, double value)
void	setXmaxB (const Eref &e, double value)
void	setXminA (const Eref &e, double value)
void	setXminB (const Eref &e, double value)
void	setYdivsA (const Eref &e, unsigned int value)
void	setYdivsB (const Eref &e, unsigned int value)
void	setYmaxA (const Eref &e, double value)
void	setYmaxB (const Eref &e, double value)
void	setYminA (const Eref &e, double value)
void	setYminB (const Eref &e, double value)

Static Public Member Functions
static const Cinfo *	initCinfo ()

Private Attributes
Interpol2D	A_
Interpol2D	B_
Id	originalChanId_
Id	originalGateId_

Detailed Description

Definition at line 12 of file HHGate2D.h.

Constructor & Destructor Documentation

HHGate2D::HHGate2D

(

)

Definition at line 164 of file HHGate2D.cpp.

    : originalChanId_(0),
          originalGateId_(0)
{;}

HHGate2D::HHGate2D	(	Id	originalChanId,
		Id	originalGateId
	)

Definition at line 169 of file HHGate2D.cpp.

    :
        originalChanId_( originalChanId ),
        originalGateId_( originalGateId )
{;}

Member Function Documentation

bool HHGate2D::checkOriginal	(	Id	id,
		const string &	field
	)		const

Checks if the provided Id is the one that the HHGate was created on. If true, fine, otherwise complains about trying to set the field.

vector< vector< double > > HHGate2D::getTableA

(

const Eref &

e

)

const

Returns the A interpol

Definition at line 219 of file HHGate2D.cpp.

References A_, and Interpol2D::getTableVector().

Referenced by initCinfo().

{
    return A_.getTableVector();
}

Here is the call graph for this function:

Here is the caller graph for this function:

vector< vector< double > > HHGate2D::getTableB

(

const Eref &

e

)

const

Returns the B interpol

Definition at line 229 of file HHGate2D.cpp.

References B_, and Interpol2D::getTableVector().

Referenced by initCinfo().

{
    return B_.getTableVector();
}

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int HHGate2D::getXdivsA

(

const Eref &

e

)

const

Definition at line 277 of file HHGate2D.cpp.

References A_, and Interpol2D::getXdivs().

Referenced by initCinfo().

{
    return A_.getXdivs();
}

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int HHGate2D::getXdivsB

(

const Eref &

e

)

const

Definition at line 337 of file HHGate2D.cpp.

References B_, and Interpol2D::getXdivs().

Referenced by initCinfo().

{
    return B_.getXdivs();
}

Here is the call graph for this function:

Here is the caller graph for this function:

double HHGate2D::getXmaxA

(

const Eref &

e

)

const

Definition at line 267 of file HHGate2D.cpp.

References A_, and Interpol2D::getXmax().

Referenced by initCinfo().

{
    return A_.getXmax();
}

Here is the call graph for this function:

Here is the caller graph for this function:

double HHGate2D::getXmaxB

(

const Eref &

e

)

const

Definition at line 327 of file HHGate2D.cpp.

References B_, and Interpol2D::getXmax().

Referenced by initCinfo().

{
    return B_.getXmax();
}

Here is the call graph for this function:

Here is the caller graph for this function:

double HHGate2D::getXminA

(

const Eref &

e

)

const

Definition at line 257 of file HHGate2D.cpp.

References A_, and Interpol2D::getXmin().

Referenced by initCinfo().

{
    return A_.getXmin();
}

Here is the call graph for this function:

Here is the caller graph for this function:

double HHGate2D::getXminB

(

const Eref &

e

)

const

Definition at line 317 of file HHGate2D.cpp.

References B_, and Interpol2D::getXmin().

Referenced by initCinfo().

{
    return B_.getXmin();
}

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int HHGate2D::getYdivsA

(

const Eref &

e

)

const

Definition at line 307 of file HHGate2D.cpp.

References A_, and Interpol2D::getYdivs().

Referenced by initCinfo().

{
    return A_.getYdivs();
}

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int HHGate2D::getYdivsB

(

const Eref &

e

)

const

Definition at line 367 of file HHGate2D.cpp.

References B_, and Interpol2D::getYdivs().

Referenced by initCinfo().

{
    return B_.getYdivs();
}

Here is the call graph for this function:

Here is the caller graph for this function:

double HHGate2D::getYmaxA

(

const Eref &

e

)

const

Definition at line 297 of file HHGate2D.cpp.

References A_, and Interpol2D::getYmax().

Referenced by initCinfo().

{
    return A_.getYmax();
}

Here is the call graph for this function:

Here is the caller graph for this function:

double HHGate2D::getYmaxB

(

const Eref &

e

)

const

Definition at line 357 of file HHGate2D.cpp.

References B_, and Interpol2D::getYmax().

Referenced by initCinfo().

{
    return B_.getYmax();
}

Here is the call graph for this function:

Here is the caller graph for this function:

double HHGate2D::getYminA

(

const Eref &

e

)

const

Definition at line 287 of file HHGate2D.cpp.

References A_, and Interpol2D::getYmin().

Referenced by initCinfo().

{
    return A_.getYmin();
}

Here is the call graph for this function:

Here is the caller graph for this function:

double HHGate2D::getYminB

(

const Eref &

e

)

const

Definition at line 347 of file HHGate2D.cpp.

References B_, and Interpol2D::getYmin().

Referenced by initCinfo().

{
    return B_.getYmin();
}

Here is the call graph for this function:

Here is the caller graph for this function:

const Cinfo * HHGate2D::initCinfo ( )

static

Definition at line 17 of file HHGate2D.cpp.

References getTableA(), getTableB(), getXdivsA(), getXdivsB(), getXmaxA(), getXmaxB(), getXminA(), getXminB(), getYdivsA(), getYdivsB(), getYmaxA(), getYmaxB(), getYminA(), getYminB(), Neutral::initCinfo(), lookupA(), lookupB(), setTableA(), setTableB(), setXdivsA(), setXdivsB(), setXmaxA(), setXmaxB(), setXminA(), setXminB(), setYdivsA(), setYdivsB(), setYmaxA(), setYmaxB(), setYminA(), and setYminB().

Referenced by HHChannel2D::initCinfo().

{
    // Field definitions.
        static ReadOnlyLookupValueFinfo< HHGate2D, vector< double >, double >
            A( "A",
            "lookupA: Look up the A gate value from two doubles, passed"
            "in as a vector. Uses linear interpolation in the 2D table"
             "The range of the lookup doubles is predefined based on "
             "knowledge of voltage or conc ranges, and the granularity "
             "is specified by the xmin, xmax, and dx field, and their "
             "y-axis counterparts.",
            &HHGate2D::lookupA );
        static ReadOnlyLookupValueFinfo< HHGate2D, vector< double >, double >
            B( "B",
            "lookupB: Look up B gate value from two doubles in a vector.",
            &HHGate2D::lookupB );

        static ElementValueFinfo< HHGate2D, vector< vector< double > > > tableA(
            "tableA",
            "Table of A entries",
                        &HHGate2D::setTableA,
            &HHGate2D::getTableA
        );

        static ElementValueFinfo< HHGate2D, vector< vector< double > > > tableB(
            "tableB",
            "Table of B entries",
            &HHGate2D::setTableB,
            &HHGate2D::getTableB);

        static ElementValueFinfo< HHGate2D, double > xminA( "xminA",
            "Minimum range for lookup",
            &HHGate2D::setXminA,
            &HHGate2D::getXminA
        );

        static ElementValueFinfo< HHGate2D, double > xmaxA( "xmaxA",
            "Minimum range for lookup",
            &HHGate2D::setXmaxA,
            &HHGate2D::getXmaxA
        );

        static ElementValueFinfo< HHGate2D, unsigned int > xdivsA( "xdivsA",
            "Divisions for lookup. Zero means to use linear interpolation",
            &HHGate2D::setXdivsA,
            &HHGate2D::getXdivsA);

        static ElementValueFinfo< HHGate2D, double > yminA( "yminA",
            "Minimum range for lookup",
            &HHGate2D::setYminA,
            &HHGate2D::getYminA);

        static ElementValueFinfo< HHGate2D, double > ymaxA( "ymaxA",
            "Minimum range for lookup",
            &HHGate2D::setYmaxA,
            &HHGate2D::getYmaxA);

        static ElementValueFinfo< HHGate2D, unsigned int > ydivsA( "ydivsA",
            "Divisions for lookup. Zero means to use linear interpolation",
            &HHGate2D::setYdivsA,
            &HHGate2D::getYdivsA);

        static ElementValueFinfo< HHGate2D, double > xminB( "xminB",
            "Minimum range for lookup",
            &HHGate2D::setXminB,
            &HHGate2D::getXminB
        );

        static ElementValueFinfo< HHGate2D, double > xmaxB( "xmaxB",
            "Minimum range for lookup",
            &HHGate2D::setXmaxB,
            &HHGate2D::getXmaxB
        );

        static ElementValueFinfo< HHGate2D, unsigned int > xdivsB( "xdivsB",
            "Divisions for lookup. Zero means to use linear interpolation",
            &HHGate2D::setXdivsB,
            &HHGate2D::getXdivsB
        );

        static ElementValueFinfo< HHGate2D, double > yminB( "yminB",
            "Minimum range for lookup",
            &HHGate2D::setYminB,
            &HHGate2D::getYminB);

        static ElementValueFinfo< HHGate2D, double > ymaxB( "ymaxB",
            "Minimum range for lookup",
            &HHGate2D::setYmaxB,
            &HHGate2D::getYmaxB);

        static ElementValueFinfo< HHGate2D, unsigned int > ydivsB( "ydivsB",
            "Divisions for lookup. Zero means to use linear interpolation",
            &HHGate2D::setYdivsB,
                        &HHGate2D::getYdivsB);

    // DestFinfos
    static Finfo* HHGate2DFinfos[] =
    {
        &A,         // ReadOnlyLookupValue
        &B,         // ReadOnlyLookupValue
        &tableA,    // ElementValue
        &tableB,    // ElementValue
                &xminA,
                &xmaxA,
                &xdivsA,
                &yminA,
                &ymaxA,
                &ydivsA,
                &xminB,
                &xmaxB,
                &xdivsB,
                &yminB,
                &ymaxB,
                &ydivsB
        };

    static string doc[] =
    {
        "Name", "HHGate2D",
        "Author", "Niraj Dudani, 2009, NCBS. Updated by Subhasis Ray, 2014, NCBS.",
        "Description", "HHGate2D: Gate for Hodkgin-Huxley type channels, equivalent to the "
        "m and h terms on the Na squid channel and the n term on K. "
        "This takes the voltage and state variable from the channel, "
        "computes the new value of the state variable and a scaling, "
        "depending on gate power, for the conductance. These two "
        "terms are sent right back in a message to the channel.",
    };

        static Dinfo< HHGate2D > dinfo;
    static Cinfo HHGate2DCinfo(
        "HHGate2D",
        Neutral::initCinfo(),
        HHGate2DFinfos, sizeof(HHGate2DFinfos)/sizeof(Finfo *),
                &dinfo,
                doc,
                sizeof(doc) / sizeof(string)
    );

    return &HHGate2DCinfo;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool HHGate2D::isOriginalChannel

(

Id

id

)

const

isOriginalChannel returns true if the provided Id is the Id of the channel on which the HHGate was created.

Definition at line 242 of file HHGate2D.cpp.

References originalChanId_.

Referenced by HHChannel2D::checkOriginal().

{
    return ( id == originalChanId_ );
}

Here is the caller graph for this function:

bool HHGate2D::isOriginalGate

(

Id

id

)

const

isOriginalChannel returns true if the provided Id is the Id of the Gate created at the same time as the original channel.

Definition at line 247 of file HHGate2D.cpp.

References originalGateId_.

{
    return ( id == originalGateId_ );
}

double HHGate2D::lookupA

(

vector< double >

v

)

const

Definition at line 178 of file HHGate2D.cpp.

References A_, and Interpol2D::innerLookup().

Referenced by initCinfo().

{
    if ( v.size() < 2 ) {
        cerr << "Error: HHGate2D::getAValue: 2 real numbers needed to lookup 2D table.\n";
        return 0.0;
    }

    if ( v.size() > 2 ) {
        cerr << "Error: HHGate2D::getAValue: Only 2 real numbers needed to lookup 2D table. "
            "Using only first 2.\n";
    }

    return A_.innerLookup( v[ 0 ], v[ 1 ] );
}

Here is the call graph for this function:

Here is the caller graph for this function:

double HHGate2D::lookupB

(

vector< double >

v

)

const

Definition at line 193 of file HHGate2D.cpp.

References B_, and Interpol2D::innerLookup().

Referenced by initCinfo().

{
    if ( v.size() < 2 ) {
        cerr << "Error: HHGate2D::getAValue: 2 real numbers needed to lookup 2D table.\n";
        return 0.0;
    }

    if ( v.size() > 2 ) {
        cerr << "Error: HHGate2D::getAValue: Only 2 real numbers needed to lookup 2D table. "
            "Using only first 2.\n";
    }

    return B_.innerLookup( v[ 0 ], v[ 1 ] );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::lookupBoth	(	double	v,
		double	c,
		double *	A,
		double *	B
	)		const

Single call to get both A and B values in a single lookup

Definition at line 208 of file HHGate2D.cpp.

References A_, B_, and Interpol2D::innerLookup().

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

{
    *A = A_.innerLookup( v, c );
    *B = B_.innerLookup( v, c );
}

Here is the call graph for this function:

Here is the caller graph for this function:

Id HHGate2D::originalChannelId

(

)

const

Returns the Id of the original Channel.

Definition at line 252 of file HHGate2D.cpp.

References originalChanId_.

{
    return originalChanId_;
}

void HHGate2D::setTableA	(	const Eref &	e,
		vector< vector< double > >	value
	)

Definition at line 224 of file HHGate2D.cpp.

References A_, Interpol2D::setTableVector(), and value.

Referenced by initCinfo().

{
    A_.setTableVector(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setTableB	(	const Eref &	e,
		vector< vector< double > >	value
	)

Definition at line 234 of file HHGate2D.cpp.

References B_, Interpol2D::setTableVector(), and value.

Referenced by initCinfo().

{
    B_.setTableVector(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setXdivsA	(	const Eref &	e,
		unsigned int	value
	)

Definition at line 282 of file HHGate2D.cpp.

References A_, and Interpol2D::setXdivs().

Referenced by initCinfo().

{
    A_.setXdivs(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setXdivsB	(	const Eref &	e,
		unsigned int	value
	)

Definition at line 342 of file HHGate2D.cpp.

References B_, and Interpol2D::setXdivs().

Referenced by initCinfo().

{
    B_.setXdivs(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setXmaxA	(	const Eref &	e,
		double	value
	)

Definition at line 272 of file HHGate2D.cpp.

References A_, and Interpol2D::setXmax().

Referenced by initCinfo().

{
    A_.setXmax(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setXmaxB	(	const Eref &	e,
		double	value
	)

Definition at line 332 of file HHGate2D.cpp.

References B_, and Interpol2D::setXmax().

Referenced by initCinfo().

{
    B_.setXmax(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setXminA	(	const Eref &	e,
		double	value
	)

Definition at line 262 of file HHGate2D.cpp.

References A_, and Interpol2D::setXmin().

Referenced by initCinfo().

{
    A_.setXmin(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setXminB	(	const Eref &	e,
		double	value
	)

Definition at line 322 of file HHGate2D.cpp.

References B_, and Interpol2D::setXmin().

Referenced by initCinfo().

{
    B_.setXmin(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setYdivsA	(	const Eref &	e,
		unsigned int	value
	)

Definition at line 312 of file HHGate2D.cpp.

References A_, and Interpol2D::setYdivs().

Referenced by initCinfo().

{
    A_.setYdivs(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setYdivsB	(	const Eref &	e,
		unsigned int	value
	)

Definition at line 372 of file HHGate2D.cpp.

References B_, and Interpol2D::setYdivs().

Referenced by initCinfo().

{
    B_.setYdivs(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setYmaxA	(	const Eref &	e,
		double	value
	)

Definition at line 302 of file HHGate2D.cpp.

References A_, and Interpol2D::setYmax().

Referenced by initCinfo().

{
    A_.setYmax(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setYmaxB	(	const Eref &	e,
		double	value
	)

Definition at line 362 of file HHGate2D.cpp.

References B_, and Interpol2D::setYmax().

Referenced by initCinfo().

{
    B_.setYmax(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setYminA	(	const Eref &	e,
		double	value
	)

Definition at line 292 of file HHGate2D.cpp.

References A_, and Interpol2D::setYmin().

Referenced by initCinfo().

{
    A_.setYmin(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void HHGate2D::setYminB	(	const Eref &	e,
		double	value
	)

Definition at line 352 of file HHGate2D.cpp.

References B_, and Interpol2D::setYmin().

Referenced by initCinfo().

{
    B_.setYmin(value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Interpol2D HHGate2D::A_

private

Definition at line 96 of file HHGate2D.h.

Referenced by getTableA(), getXdivsA(), getXmaxA(), getXminA(), getYdivsA(), getYmaxA(), getYminA(), lookupA(), lookupBoth(), setTableA(), setXdivsA(), setXmaxA(), setXminA(), setYdivsA(), setYmaxA(), and setYminA().

Interpol2D HHGate2D::B_

private

Definition at line 97 of file HHGate2D.h.

Referenced by getTableB(), getXdivsB(), getXmaxB(), getXminB(), getYdivsB(), getYmaxB(), getYminB(), lookupB(), lookupBoth(), setTableB(), setXdivsB(), setXmaxB(), setXminB(), setYdivsB(), setYmaxB(), and setYminB().

Id HHGate2D::originalChanId_

private

Definition at line 99 of file HHGate2D.h.

Referenced by isOriginalChannel(), and originalChannelId().

Id HHGate2D::originalGateId_

private

Definition at line 100 of file HHGate2D.h.

Referenced by isOriginalGate().

---

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

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