Xyce  6.1
N_DEV_ArtificialParameters.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_ArtificialParameters.h,v $
27 //
28 // Purpose : Implement the MOSFET Level 1 static model
29 //
30 // Special Notes :
31 //
32 // Creator : Eric R. Keiter, SNL, Parallel Computational Sciences
33 //
34 // Creation Date : 02/28/00
35 //
36 // Revision Information:
37 // ---------------------
38 //
39 // Revision Number: $Revision: 1.2.2.1 $
40 //
41 // Revision Date : $Date: 2015/04/02 18:20:10 $
42 //
43 // Current Owner : $Author: tvrusso $
44 //-------------------------------------------------------------------------
45 
46 #ifndef Xyce_N_DEV_ArtificialParameters_h
47 #define Xyce_N_DEV_ArtificialParameters_h
48 
49 #include <Xyce_config.h>
50 
51 #include <vector>
52 
53 #include <N_DEV_fwd.h>
54 
55 namespace Xyce {
56 namespace Device {
57 namespace ArtificialParameters {
58 
59 typedef std::vector<DeviceInstance *> InstanceVector;
60 typedef std::map<ModelTypeId, InstanceVector> ModelTypeInstanceVectorMap;
61 
63 {
64  virtual ~ArtificialParameter() {};
65 
66  SolverState &getSolverState(DeviceMgr &device_manager);
67  const SolverState &getSolverState(const DeviceMgr &device_manager) const;
68  DeviceOptions &getDeviceOptions(DeviceMgr &device_manager);
69  const DeviceOptions &getDeviceOptions(const DeviceMgr &device_manager) const;
70  ModelTypeInstanceVectorMap &getModelTypeInstanceVectorMap(DeviceMgr &device_manager);
71  const ModelTypeInstanceVectorMap &getModelTypeInstanceVectorMap(const DeviceMgr &device_manager) const;
72  InstanceVector &getInstanceVector(DeviceMgr &device_manager);
73  const InstanceVector &getInstanceVector(const DeviceMgr &device_manager) const;
74 
75  virtual bool setValue(DeviceMgr &device_manager, double value) = 0;
76  virtual double getValue(const DeviceMgr &device_manager) const = 0;
77 };
78 
80 {
81  virtual bool setValue(DeviceMgr &device_manager, double value);
82  virtual double getValue(const DeviceMgr &device_manager) const;
83 };
84 
86 {
87  virtual bool setValue(DeviceMgr &device_manager, double value);
88  virtual double getValue(const DeviceMgr &device_manager) const;
89 };
90 
92 {
93  virtual bool setValue(DeviceMgr &device_manager, double value);
94  virtual double getValue(const DeviceMgr &device_manager) const;
95 };
96 
98 {
99  virtual bool setValue(DeviceMgr &device_manager, double value);
100  virtual double getValue(const DeviceMgr &device_manager) const;
101 };
102 
104 {
105  virtual bool setValue(DeviceMgr &device_manager, double value);
106  virtual double getValue(const DeviceMgr &device_manager) const;
107 };
108 
110 {
111  virtual bool setValue(DeviceMgr &device_manager, double value);
112  virtual double getValue(const DeviceMgr &device_manager) const;
113 };
114 
116 {
117  virtual bool setValue(DeviceMgr &device_manager, double value);
118  virtual double getValue(const DeviceMgr &device_manager) const;
119 };
120 
122 {
123  virtual bool setValue(DeviceMgr &device_manager, double value);
124  virtual double getValue(const DeviceMgr &device_manager) const;
125 };
126 
128 {
129  virtual bool setValue(DeviceMgr &device_manager, double value);
130  virtual double getValue(const DeviceMgr &device_manager) const;
131 };
132 
134 {
135  virtual bool setValue(DeviceMgr &device_manager, double value);
136  virtual double getValue(const DeviceMgr &device_manager) const;
137 };
138 
140 {
141  virtual bool setValue(DeviceMgr &device_manager, double value);
142  virtual double getValue(const DeviceMgr &device_manager) const;
143 };
144 
146 {
147  virtual bool setValue(DeviceMgr &device_manager, double value);
148  virtual double getValue(const DeviceMgr &device_manager) const;
149 };
150 
152 {
153  virtual bool setValue(DeviceMgr &device_manager, double value);
154  virtual double getValue(const DeviceMgr &device_manager) const;
155 };
156 
158 {
159  virtual bool setValue(DeviceMgr &device_manager, double value);
160  virtual double getValue(const DeviceMgr &device_manager) const;
161 };
162 
164 {
165  virtual bool setValue(DeviceMgr &device_manager, double value);
166  virtual double getValue(const DeviceMgr &device_manager) const;
167 };
168 
170 {
171  virtual bool setValue(DeviceMgr &device_manager, double value);
172  virtual double getValue(const DeviceMgr &device_manager) const;
173 };
174 
176 {
177  virtual bool setValue(DeviceMgr &device_manager, double value);
178  virtual double getValue(const DeviceMgr &device_manager) const;
179 };
180 
182 {
183  virtual bool setValue(DeviceMgr &device_manager, double value);
184  virtual double getValue(const DeviceMgr &device_manager) const;
185 };
186 
187 } // namespace ArtificialParameters
188 } // namespace Device
189 } // namespace Xyce
190 
191 #endif // Xyce_N_DEV_ArtificialParameters_h
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual double getValue(const DeviceMgr &device_manager) const
std::vector< DeviceInstance * > InstanceVector
virtual double getValue(const DeviceMgr &device_manager) const
virtual double getValue(const DeviceMgr &device_manager) const
virtual double getValue(const DeviceMgr &device_manager) const
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual double getValue(const DeviceMgr &device_manager) const
virtual bool setValue(DeviceMgr &device_manager, double value)
Pure virtual class to augment a linear system.
virtual double getValue(const DeviceMgr &device_manager) const
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual double getValue(const DeviceMgr &device_manager) const
ModelTypeInstanceVectorMap & getModelTypeInstanceVectorMap(DeviceMgr &device_manager)
virtual bool setValue(DeviceMgr &device_manager, double value)
const T & value(const ParameterBase &entity, const Descriptor &descriptor)
Returns the value of the parameter for the entity.
Definition: N_DEV_Pars.h:1224
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual double getValue(const DeviceMgr &device_manager) const
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual double getValue(const DeviceMgr &device_manager) const
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual double getValue(const DeviceMgr &device_manager) const
DeviceOptions & getDeviceOptions(DeviceMgr &device_manager)
virtual double getValue(const DeviceMgr &device_manager) const
std::map< ModelTypeId, InstanceVector > ModelTypeInstanceVectorMap
virtual double getValue(const DeviceMgr &device_manager) const
virtual double getValue(const DeviceMgr &device_manager) const
virtual bool setValue(DeviceMgr &device_manager, double value)=0
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual double getValue(const DeviceMgr &device_manager) const
InstanceVector & getInstanceVector(DeviceMgr &device_manager)
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual double getValue(const DeviceMgr &device_manager) const =0
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual double getValue(const DeviceMgr &device_manager) const
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual double getValue(const DeviceMgr &device_manager) const
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual double getValue(const DeviceMgr &device_manager) const
virtual bool setValue(DeviceMgr &device_manager, double value)
virtual double getValue(const DeviceMgr &device_manager) const