Xyce  6.1
N_DEV_DeviceOptions.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_DeviceOptions.h,v $
27 //
28 // Purpose :
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.77.2.1 $
40 //
41 // Revision Date : $Date: 2015/04/02 18:20:09 $
42 //
43 // Current Owner : $Author: tvrusso $
44 //-----------------------------------------------------------------------------
45 
46 
47 #ifndef Xyce_N_DEV_DeviceOptions_h
48 #define Xyce_N_DEV_DeviceOptions_h
49 
50 #include <string>
51 
52 #include <N_DEV_fwd.h>
53 #include <N_IO_fwd.h>
54 #include <N_UTL_fwd.h>
55 #include <N_UTL_Param.h>
56 
57 namespace Xyce {
58 namespace Device {
59 
60 //-----------------------------------------------------------------------------
61 // Class : DeviceOptions
62 // Purpose :
63 // Special Notes :
64 // Creator : Eric Keiter, SNL, Parallel Computational Sciences
65 // Creation Date : 3/16/00
66 //-----------------------------------------------------------------------------
68 {
69  friend std::ostream & operator<<(std::ostream & os, const DeviceOptions & devOp);
70 
71 public:
72  DeviceOptions();
74 
75  bool registerOptions(const Util::OptionBlock & OB);
76 
77  bool setupDefaultOptions(const IO::CmdParse &command_line);
78  bool applyCmdLineOptions(const IO::CmdParse &command_line);
79 
80  // // Assignment operator:
81 private:
84 
85 public:
86  // some general MOS parameters:
87  double defad; // MOS drain diffusion area.
88  double defas; // MOS source diffusion area.
89  double defl; // MOS channel length.
90  double defw; // MOS channel width.
91 
92  double abstol; // absolute current error tolerance.
93  double reltol; // relative current error tolerance.
94  double chgtol; // absolute charge error tolerance.
95 
96  double gmin; // minimum allowed conductance.
97  double gmin_orig; // this is needed for gmin-homotopy.
98  double gmin_init; // this is needed for gmin-homotopy.
99  double gmin_scalar; // this is needed for gmin-homotopy.
100 
101  double gmax; // maximum allowed conductance.
102 
103  double testJac_relTol; // reltol for num. jacobian diagnostic
104  double testJac_absTol; // abstol for num. jacobian diagnostic.
105  double testJac_SqrtEta;// dx = numJacSqrtEta * (1.0 + std::fabs(soln[i]));
106  double deviceSens_dp; // similar to eta, but for numerical device sensitivities
107 
108  double tnom; // nominal temperature for device params.
109  Util::Param temp; // operating temperature of ckt.
110 
111  double scale_src; // scaling for source loads
112 
119  std::string testJacDeviceName;
122 
124 
125  double icMultiplier;
126 
128 
129  // mosfet homotopy:
130  double vdsScaleMin;
131  double vgstConst;
135  double length0;
136  double width0;
137  double tox0;
138  double minRes;
139  double minCap;
140  double exp_order;
141 
142  // tolerance on resistance below which it will be treated as zero
145 
148  double debugMinTime;
149  double debugMaxTime;
150 
152 
154  bool defaultNewExcessPhase; // default is true for MPDE, false for non-MPDE.
155 
158 
159  unsigned int randomSeed; // seed for random number generator used by some devices.
160  // note: each device gets its own random number generator so
161  // it must initialize thing correctly. (See N_DEV_Synapse3 for an
162  // example)
163 
164  bool tryToCompact; // Try to compact past history for LTRA device(s).
165 
166  bool calculateAllLeadCurrents; // class level flag to have the device manager
167  // configure all devices to load lead current.
168  // data in store and storeQvec.
169 };
170 
171 } // namespace Device
172 } // namespace Xyce
173 
174 #endif // Xyce_N_DEV_DeviceOptions_h
bool setupDefaultOptions(const IO::CmdParse &command_line)
Pure virtual class to augment a linear system.
friend std::ostream & operator<<(std::ostream &os, const DeviceOptions &devOp)
bool applyCmdLineOptions(const IO::CmdParse &command_line)
bool registerOptions(const Util::OptionBlock &OB)
DeviceOptions & operator=(DeviceOptions const &)