Compartment.h

Go to the documentation of this file.

/**********************************************************************
** This program is part of 'MOOSE', the
** Messaging Object Oriented Simulation Environment,
** also known as GENESIS 3 base code.
**           copyright (C) 2003-2006 Upinder S. Bhalla. and NCBS
** It is made available under the terms of the
** GNU Lesser General Public License version 2.1
** See the file COPYING.LIB for the full notice.
**********************************************************************/

#ifndef _COMPARTMENT_H
#define _COMPARTMENT_H

namespace moose
{
class Compartment: public CompartmentBase
{
public:
    Compartment();
    virtual ~Compartment();

    // Value Field access function definitions.
    virtual void vSetVm( const Eref& e, double Vm );
    virtual double vGetVm( const Eref& e ) const;
    virtual void vSetEm( const Eref& e, double Em );
    virtual double vGetEm( const Eref& e ) const;
    virtual void vSetCm( const Eref& e, double Cm );
    virtual double vGetCm( const Eref& e ) const;
    virtual void vSetRm( const Eref& e, double Rm );
    virtual double vGetRm( const Eref& e ) const;
    virtual void vSetRa( const Eref& e, double Ra );
    virtual double vGetRa( const Eref& e ) const;
    virtual double vGetIm( const Eref& e ) const;
    virtual void vSetInject( const Eref& e, double Inject );
    virtual double vGetInject( const Eref& e ) const;
    virtual void vSetInitVm( const Eref& e, double initVm );
    virtual double vGetInitVm( const Eref& e ) const;

    // Dest function definitions.
    void vProcess( const Eref& e, ProcPtr p );

    void vReinit( const Eref& e, ProcPtr p );

    void vInitProc( const Eref& e, ProcPtr p );

    void vInitReinit( const Eref& e, ProcPtr p );

    void vHandleChannel( const Eref& e, double Gk, double Ek);

    void vHandleRaxial( double Ra, double Vm);

    void vHandleAxial( double Vm);

    void vInjectMsg( const Eref& e, double current);

    void vRandInject( const Eref& e, double prob, double current);

    void cable();


    static const Cinfo* initCinfo();

protected:
    double Vm_;
    double initVm_;
    double Em_;
    double Cm_;
    double Rm_;
    double Ra_;
    double Im_;
    double lastIm_;
    double inject_;
    double A_;
    double B_;
    double sumInject_;

private:
    double invRm_;
    double dt_;
    static const double EPSILON;

};
}

// Used by solver, readcell, etc.

#endif // _COMPARTMENT_H