Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
N_DEV_TransportHelper.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-2014 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_TransportHelper.h,v $
27 //
28 // Purpose :
29 //
30 // Special Notes :
31 //
32 // Creator : Thomas V. Russo, SNL, Component Information and Models
33 //
34 // Creation Date : 08/19/04
35 //
36 // Revision Information:
37 // ---------------------
38 //
39 // Revision Number: $Revision: 1.7.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_TransportHelper_h
47 #define Xyce_N_DEV_TransportHelper_h
48 
49 namespace Xyce {
50 namespace Device {
51 
52 //-----------------------------------------------------------------------------
53 // Class : TransportHelper
54 // Purpose :
55 // Special Notes :
56 // Creator : Eric Keiter, SNL, Parallel Computational Sciences
57 // Creation Date : 10/31/06
58 //-----------------------------------------------------------------------------
60 {
61 public:
63  D_specie (3.6e-11),
64  transportFlag(false),
65  flux_bc1(0.0),
66  flux_bc2(0.0),
67  bcScale1(1.0),
68  bcScale2(1.0)
69  {};
70 
71  TransportHelper (double D, std::string & n) :
72  D_specie (D),
73  name(n),
74  transportFlag(false),
75  flux_bc1(0.0),
76  flux_bc2(0.0),
77  bcScale1(1.0),
78  bcScale2(1.0)
79  {
80  if (D!= 0.0) transportFlag = true;
81  };
82 
83  std::string name;
84  std::vector<int> regSubIndexVec;
85  std::vector<double> fluxVec;
86 
87  double flux_bc1;
88  double flux_bc2;
89  double bcScale1;
90  double bcScale2;
91 
92  std::vector<int> specie_id;
93  double D_specie; // diffusion constant.
94 
96 };
97 
98 } // namespace Device
99 } // namespace Xyce
100 
102 
103 #endif
104