Xyce  6.1
N_DEV_MembraneModel.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // Copyright Notice
3 //
4 // Copyright 2002 Sandia Corporation. Under the terms
5 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S.
6 // Government retains certain rights in this software.
7 //
8 // Xyce(TM) Parallel Electrical Simulator
9 // Copyright (C) 2002-2015 Sandia Corporation
10 //
11 // This program is free software: you can redistribute it and/or modify
12 // it under the terms of the GNU General Public License as published by
13 // the Free Software Foundation, either version 3 of the License, or
14 // (at your option) any later version.
15 //
16 // This program is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 // GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU General Public License
22 // along with this program. If not, see <http://www.gnu.org/licenses/>.
23 //-----------------------------------------------------------------------------
24 
25 //-----------------------------------------------------------------------------
26 // Filename : $RCSfile: N_DEV_MembraneModel.h,v $
27 //
28 // Purpose : Neuron classes.
29 //
30 // Special Notes :
31 //
32 // Creator : Richard Schiek, SNL, Electrical and Microsystem Modeling
33 //
34 // Creation Date : 08/11/10
35 //
36 // Revision Information:
37 // ---------------------
38 //
39 // Revision Number: $Revision: 1.14 $
40 //
41 // Revision Date : $Date: 2015/04/08 19:18:23 $
42 //
43 // Current Owner : $Author: tvrusso $
44 //-----------------------------------------------------------------------------
45 
46 #ifndef Xyce_N_DEV_MembraneModel_h
47 #define Xyce_N_DEV_MembraneModel_h
48 
49 #include <vector>
50 
51 // ---------- Xyce Includes ----------
52 #include <N_DEV_fwd.h>
53 #include <N_LAS_fwd.h>
54 
55 namespace Xyce {
56 namespace Device {
57 
58 //-----------------------------------------------------------------------------
59 // Class : N_DEV_MembraneModel
60 // Purpose : This is class is a virtual base class to define the base
61 // interface for membrane modeling equations. Classes
62 // that derive from this will define the equations that
63 // need to be solved for various ion currents
64 // Special Notes :
65 // Creator : Richard Schiek, SNL, Electrical and Microsystem Modeling
66 // Creation Date : 08/11/2010
67 //-----------------------------------------------------------------------------
69 {
70 public:
72  : solState(ss1),
75  {}
76 
78 
79  int numVars() { return numIndependentVars_; }
80 
81  virtual void setJacStamp( int numExtVars, int segmentNumber, int vOffset, std::vector< std::vector< int > > & segmentJacStamp ) {}
82  virtual void loadDAEQVector( int segmentNumber, std::vector< int > & lidIndexVector, Linear::Vector * solnVecPtr, Linear::Vector * daeQVecPtr, double segArea) {}
83  virtual void loadDAEFVector( int segmentNumber, std::vector< int > & lidIndexVector, Linear::Vector * solnVecPtr, Linear::Vector * daeFVecPtr, double segArea) {}
84  virtual void loadDAEdQdx( int segmentNumber, int vOffset, std::vector< int > & lidIndexVector, std::vector< std::vector< int > > & jacobianOffsets, Linear::Vector * solnVecPtr, Linear::Matrix * dQdxMatPtr, double segArea) {}
85  virtual void loadDAEdFdx( int segmentNumber, int vOffset, std::vector< int > & lidIndexVector, std::vector< std::vector< int > > & jacobianOffsets, Linear::Vector * solnVecPtr, Linear::Matrix * dFdxMatPtr, double segArea) {}
86 
88 
89  // these are modeling parameters common to most model types
90  // this is some data duplication between the devcie model the membrane model
91  // need to think of a cleaner way to do this
92  double cMem_;
93  double gMem_;
94  double vRest_;
95 
96  const int numExternalVars_; // always assume that the owning cable equation has two external vars (a Vin and Vout)
97  // if this assumption needs to be changed we'll have this constant to show where we made such an assumption.
98 
99  const SolverState & solState; // this is here incase a model needs to be aware of simulator data like dcopflag or currtime.
100 };
101 
102 } // namespace Device
103 } // namespace Xyce
104 
105 #endif
106 
Pure virtual class to augment a linear system.
virtual void loadDAEQVector(int segmentNumber, std::vector< int > &lidIndexVector, Linear::Vector *solnVecPtr, Linear::Vector *daeQVecPtr, double segArea)
MembraneModel(const SolverState &ss1)
virtual void setJacStamp(int numExtVars, int segmentNumber, int vOffset, std::vector< std::vector< int > > &segmentJacStamp)
virtual void loadDAEFVector(int segmentNumber, std::vector< int > &lidIndexVector, Linear::Vector *solnVecPtr, Linear::Vector *daeFVecPtr, double segArea)
virtual void loadDAEdFdx(int segmentNumber, int vOffset, std::vector< int > &lidIndexVector, std::vector< std::vector< int > > &jacobianOffsets, Linear::Vector *solnVecPtr, Linear::Matrix *dFdxMatPtr, double segArea)
virtual void loadDAEdQdx(int segmentNumber, int vOffset, std::vector< int > &lidIndexVector, std::vector< std::vector< int > > &jacobianOffsets, Linear::Vector *solnVecPtr, Linear::Matrix *dQdxMatPtr, double segArea)