HinesMatrix.h

Go to the documentation of this file.

/**********************************************************************
** This program is part of 'MOOSE', the
** Messaging Object Oriented Simulation Environment.
**   copyright (C) 2003-2007 Upinder S. Bhalla, Niraj Dudani 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 _HINES_MATRIX_H
#define _HINES_MATRIX_H

#ifdef DO_UNIT_TESTS
# define ASSERT( isOK, message ) \
    if ( !(isOK) ) { \
        cerr << "\nERROR: Assert '" << #isOK << "' failed on line " << __LINE__ << "\nin file " << __FILE__ << ": " << message << endl; \
        exit( 1 ); \
    } else { \
        cout << ""; \
    }
#else
# define ASSERT( unused, message ) do {} while ( false )
#endif

struct JunctionStruct
{
    JunctionStruct( unsigned int i, unsigned int r ) :
        index( i ),
        rank( r )
    {
        ;
    }

    bool operator< ( const JunctionStruct& other ) const
    {
        return ( index < other.index );
    }

    unsigned int index;     
    unsigned int rank;      
};

struct TreeNodeStruct
{
    vector< unsigned int > children;    
    double Ra;
    double Rm;
    double Cm;
    double Em;
    double initVm;
};

class HinesMatrix
{
public:
    HinesMatrix();

    void setup( const vector< TreeNodeStruct >& tree, double dt );

    unsigned int getSize() const;
    double getA( unsigned int row, unsigned int col ) const;
    double getB( unsigned int row ) const;
    double getVMid( unsigned int row ) const;

protected:
    typedef vector< double >::iterator vdIterator;

    unsigned int              nCompt_;
    double                    dt_;

    vector< JunctionStruct >  junction_;
    vector< double >          HS_;          
    vector< double >          HJ_;          
    vector< double >          HJCopy_;
    vector< double >          VMid_;        
    vector< vdIterator >      operand_;
    vector< vdIterator >      backOperand_;
    int                       stage_;       

private:
    void clear();
    void makeJunctions();
    void makeMatrix();      
    void makeOperands();    

    const vector< TreeNodeStruct >     *tree_;      
    vector< double >                   Ga_;
    vector< vector< unsigned int > >   coupled_;
    map< unsigned int, vdIterator >    operandBase_;
    map< unsigned int, unsigned int >  groupNumber_;
};

#endif // _HINES_MATRIX_H