ZombiePoolInterface.h

Go to the documentation of this file.

/**********************************************************************
** This program is part of 'MOOSE', the
** Messaging Object Oriented Simulation Environment.
**           Copyright (C) 2003-2014 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 _ZOMBIE_POOL_INTERFACE_H
#define _ZOMBIE_POOL_INTERFACE_H

class ZombiePoolInterface
{
    public:
        ZombiePoolInterface();

        virtual void setNinit( const Eref& e, double val ) = 0;
        virtual double getNinit( const Eref& e ) const = 0;

        virtual void setN( const Eref& e, double val ) = 0;
        virtual double getN( const Eref& e ) const = 0;

        virtual void setDiffConst( const Eref& e, double val ) = 0;
        virtual double getDiffConst( const Eref& e ) const = 0;

        virtual void setMotorConst( const Eref& e, double val )
        {;}

        virtual void setNumPools( unsigned int num ) = 0;
        virtual unsigned int getNumPools() const = 0;

        virtual void setNumAllVoxels( unsigned int numVoxels ) = 0;
        virtual unsigned int getNumLocalVoxels() const = 0;
        virtual VoxelPoolsBase* pools( unsigned int i ) = 0;

        virtual double volume( unsigned int i ) const = 0;

        virtual void getBlock( vector< double >& values ) const = 0;

        virtual void setBlock( const vector< double >& values ) = 0;

        virtual void setStoich( Id stoich ) = 0;

        virtual void setDsolve( Id dsolve ) = 0;

        virtual void setCompartment( Id compartment );
        Id getCompartment() const;

        virtual void updateJunctions( double dt );
        virtual void setPrev();
        virtual void updateRateTerms( unsigned int index = ~0U ) = 0;

        virtual unsigned int getPoolIndex( const Eref& er ) const = 0;

    protected:
        Id stoich_;

        Id compartment_;

        bool isBuilt_;
};

#endif  // _ZOMBIE_POOL_INTERFACE_H