Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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-2011 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.10.2.1 $
40 //
41 // Revision Date : $Date: 2014/02/26 20:16:30 $
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 
54 
55 // ---------- Forward Declarations ----------
56 class N_LAS_Vector;
57 class N_LAS_Matrix;
58 
59 namespace Xyce {
60 namespace Device {
61 
62 //-----------------------------------------------------------------------------
63 // Class : N_DEV_MembraneModel
64 // Purpose : This is class is a virtual base class to define the base
65 // interface for membrane modeling equations. Classes
66 // that derive from this will define the equations that
67 // need to be solved for various ion currents
68 // Special Notes :
69 // Creator : Richard Schiek, SNL, Electrical and Microsystem Modeling
70 // Creation Date : 08/11/2010
71 //-----------------------------------------------------------------------------
73 {
74 public:
76  : solState(ss1),
79  {}
80 
82 
83  int numVars() { return numIndependentVars_; }
84 
85  virtual void setJacStamp( int numExtVars, int segmentNumber, int vOffset, std::vector< std::vector< int > > & segmentJacStamp ) {}
86  virtual void loadDAEQVector( int segmentNumber, std::vector< int > & lidIndexVector, N_LAS_Vector * solnVecPtr, N_LAS_Vector * daeQVecPtr, double segArea) {}
87  virtual void loadDAEFVector( int segmentNumber, std::vector< int > & lidIndexVector, N_LAS_Vector * solnVecPtr, N_LAS_Vector * daeFVecPtr, double segArea) {}
88  virtual void loadDAEdQdx( int segmentNumber, int vOffset, std::vector< int > & lidIndexVector, std::vector< std::vector< int > > & jacobianOffsets, N_LAS_Vector * solnVecPtr, N_LAS_Matrix * dQdxMatPtr, double segArea) {}
89  virtual void loadDAEdFdx( int segmentNumber, int vOffset, std::vector< int > & lidIndexVector, std::vector< std::vector< int > > & jacobianOffsets, N_LAS_Vector * solnVecPtr, N_LAS_Matrix * dFdxMatPtr, double segArea) {}
90 
92 
93  // these are modeling parameters common to most model types
94  // this is some data duplication between the devcie model the membrane model
95  // need to think of a cleaner way to do this
96  double cMem_;
97  double gMem_;
98  double vRest_;
99 
100  const int numExternalVars_; // always assume that the owning cable equation has two external vars (a Vin and Vout)
101  // if this assumption needs to be changed we'll have this constant to show where we made such an assumption.
102 
103  const SolverState & solState; // this is here incase a model needs to be aware of simulator data like dcopflag or currtime.
104 };
105 
106 } // namespace Device
107 } // namespace Xyce
108 
110 
111 #endif
112