CaConcStruct Struct Reference

#include <HSolveStruct.h>

Collaboration diagram for CaConcStruct:

Public Member Functions
	CaConcStruct ()
	CaConcStruct (double Ca, double CaBasal, double tau, double B, double ceiling, double floor, double dt)
double	process (double activation)
void	setCa (double Ca)
void	setCaBasal (double CaBasal)
void	setTauB (double tau, double B, double dt)

Public Attributes
double	c_
double	CaBasal_
	Dynamic calcium concentration, over CaBasal_ More...
double	ceiling_
double	factor1_
	Reference calcium concentration More...
double	factor2_
	Both these factors are functions of tau, B and dt. More...
double	floor_
	Ceiling and floor for lookup tables More...

Detailed Description

Definition at line 137 of file HSolveStruct.h.

Constructor & Destructor Documentation

CaConcStruct::CaConcStruct

(

)

Definition at line 82 of file HSolveStruct.cpp.

    :
        c_( 0.0 ),
        CaBasal_( 0.0 ),
        factor1_( 0.0 ),
        factor2_( 0.0 ),
        ceiling_( 0.0 ),
        floor_( 0.0 )
{ ; }

CaConcStruct::CaConcStruct	(	double	Ca,
		double	CaBasal,
		double	tau,
		double	B,
		double	ceiling,
		double	floor,
		double	dt
	)

Definition at line 92 of file HSolveStruct.cpp.

References ceiling_, floor_, setCa(), setCaBasal(), and setTauB().

{
    setCa( Ca );
    setCaBasal( CaBasal );
    setTauB( tau, B, dt );
    ceiling_ = ceiling;
    floor_ = floor;
}

Here is the call graph for this function:

Member Function Documentation

double CaConcStruct::process

(

double

activation

)

Compute Ca concentration from factors and activation value. Also takes care of Ca concetration exceeding min and max values.

Definition at line 139 of file HSolveStruct.cpp.

References c_, CaBasal_, ceiling_, factor1_, factor2_, floor_, and setCa().

                                                {
    c_ = factor1_ * c_ + factor2_ * activation;

    double ca = CaBasal_ + c_;

    if ( ceiling_ > 0 && ca > ceiling_ ) {
        ca = ceiling_;
        setCa( ca );
    }

    if ( ca < floor_ ) {
        ca = floor_;
        setCa( ca );
    }

    return ca;
}

Here is the call graph for this function:

void CaConcStruct::setCa

(

double

Ca

)

Definition at line 108 of file HSolveStruct.cpp.

References c_, and CaBasal_.

Referenced by CaConcStruct(), and process().

                                    {
    c_ = Ca - CaBasal_;
}

Here is the caller graph for this function:

void CaConcStruct::setCaBasal

(

double

CaBasal

)

change CaBasal_ and update c_ accordingly.

Definition at line 112 of file HSolveStruct.cpp.

References c_, and CaBasal_.

Referenced by CaConcStruct().

                                              {
    /*
     * Also updating 'c_' here, so that only 'CaBasal' changes, and 'Ca'
     * remains the same. This is good because otherwise one has to bother about
     * the order in which 'setCa()' and 'setCaBasal()' are called.
     *
     * 'Ca' is:
     *         Ca = CaBasal_ + c_
     *
     * if:
     *         Ca_new = Ca_old
     *
     * then:
     *         CaBasal_new + c_new = CaBasal_old + c_old
     *
     * so:
     *         c_new = c_old + CaBasal_old - CaBasal_new
     */
    c_ += CaBasal_ - CaBasal;
    CaBasal_ = CaBasal;
}

Here is the caller graph for this function:

void CaConcStruct::setTauB	(	double	tau,
		double	B,
		double	dt
	)

Sets the factors using the appropriate functions.

Definition at line 134 of file HSolveStruct.cpp.

References factor1_, and factor2_.

Referenced by CaConcStruct().

                                                            {
    factor1_ = 4.0 / ( 2.0 + dt / tau ) - 1.0;
    factor2_ = 2.0 * B * dt / ( 2.0 + dt / tau );
}

Here is the caller graph for this function:

Member Data Documentation

double CaConcStruct::c_

Definition at line 139 of file HSolveStruct.h.

Referenced by process(), setCa(), and setCaBasal().

double CaConcStruct::CaBasal_

Dynamic calcium concentration, over CaBasal_

Definition at line 140 of file HSolveStruct.h.

Referenced by process(), setCa(), and setCaBasal().

double CaConcStruct::ceiling_

Definition at line 143 of file HSolveStruct.h.

Referenced by CaConcStruct(), and process().

double CaConcStruct::factor1_

Reference calcium concentration

Definition at line 141 of file HSolveStruct.h.

Referenced by process(), and setTauB().

double CaConcStruct::factor2_

Both these factors are functions of tau, B and dt.

Definition at line 142 of file HSolveStruct.h.

Referenced by process(), and setTauB().

double CaConcStruct::floor_

Ceiling and floor for lookup tables

Definition at line 144 of file HSolveStruct.h.

Referenced by CaConcStruct(), and process().

---

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

• moose-core/hsolve/HSolveStruct.h
• moose-core/hsolve/HSolveStruct.cpp