Xyce  6.1
N_DEV_ScalingVars.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_ScalingVars.h,v $
27 //
28 // Purpose :
29 //
30 // Special Notes :
31 //
32 // Creator : Eric R. Keiter, SNL, Parallel Computational Sciences
33 //
34 // Creation Date : 03/04/08
35 //
36 // Revision Information:
37 // ---------------------
38 //
39 // Revision Number: $Revision: 1.2.2.1 $
40 //
41 // Revision Date : $Date: 2015/04/02 18:20:09 $
42 //
43 // Current Owner : $Author: tvrusso $
44 //-----------------------------------------------------------------------------
45 
46 #ifndef Xyce_ScalingVars_h
47 #define Xyce_ScalingVars_h
48 
49 namespace Xyce {
50 namespace Device {
51 
52 //-----------------------------------------------------------------------------
53 // Class : ScalingVars
54 // Purpose :
55 // Special Notes :
56 // Creator : Eric Keiter, SNL, Parallel Computational Sciences
57 // Creation Date : 3/04/08
58 //-----------------------------------------------------------------------------
60 {
61 public:
63  : x0(1.0), a0(1.0), T0(1.0), V0(1.0),
64  rV0(1.0), C0(1.0), D0(1.0), u0(1.0),
65  R0(1.0), rR0(1.0), t0(1.0), E0(1.0),
66  F0(1.0), J0(1.0), L0(1.0), k0(1.0),
67  rt0(1.0), rk0(1.0)
68  {}
69 
70 public:
71  double x0; // distance scaling (cm)
72  double a0; // area scaling (cm^2)
73  double T0; // temperature scaling (K)
74  double V0; // electrostatic potential scaling (V)
75  double rV0; // reciprocal of V0
76  double C0; // concentration scaling (cm^-3);
77  double D0; // diffusion coefficient scaling (cm^2/s)
78  double u0; // mobility coefficient scaling (cm^2/V/s)
79  double R0; // recombination rate scaling (cm^-3/s)
80  double rR0; // reciprocal of R0
81  double t0; // time scaling (s)
82  double E0; // electric field scaling (V/s)
83  double F0; // particle flux scaling (cm^-2/s)
84  double J0; // current density scaling (A/cm^2)
85  double L0; // Laplacian scaling constant
86 
87  double k0;
88  double rt0;
89  double rk0;
90 };
91 
92 //-----------------------------------------------------------------------------
93 // Function : ScalingVars::operator<<
94 // Purpose : "<<" operator
95 // Special Notes :
96 // Scope : public
97 // Creator : Eric R. Keiter, SNL, Parallel Computational Sciences
98 // Creation Date : 11/15/09
99 //-----------------------------------------------------------------------------
100 std::ostream & operator<<(std::ostream & os, const ScalingVars & scaleVars);
101 
102 } // namespace Device
103 } // namespace Xyce
104 
105 #endif
106 
Pure virtual class to augment a linear system.
std::ostream & operator<<(std::ostream &os, const Configuration &configuration)
Definition: N_DEV_Dump.C:134