Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
N_DEV_RegionData.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_RegionData.h,v $
27 //
28 // Purpose :
29 //
30 // Special Notes :
31 //
32 // Creator : Eric R. Keiter, SNL
33 //
34 // Creation Date : 07/19/06
35 //
36 // Revision Information:
37 // ---------------------
38 //
39 // Revision Number: $Revision: 1.8 $
40 //
41 // Revision Date : $Date: 2014/02/24 23:49:14 $
42 //
43 // Current Owner : $Author: tvrusso $
44 //-----------------------------------------------------------------------------
45 
46 #ifndef Xyce_N_DEV_RegionData_h
47 #define Xyce_N_DEV_RegionData_h
48 
49 // ---------- Standard Includes ----------
50 #include <N_UTL_Misc.h>
51 
52 // ---------- Xyce Includes ----------
53 #include <N_DEV_CompositeParam.h>
54 
55 // ---------- Forward Declarations -------
56 
57 //-----------------------------------------------------------------------------
58 // Class : N_DEV_RegionData
59 // Purpose :
60 // Special Notes : This class is intended to be a class for passing data into
61 // the Rxn Region constructor.
62 //
63 // Creator : Eric Keiter, SNL
64 // Creation Date : 4/17/11
65 //-----------------------------------------------------------------------------
66 
67 namespace Xyce {
68 namespace Device {
69 
70 class RegionData : public CompositeParam
71 {
72  friend class ParametricData<RegionData>;
73 
74 public:
76 
77  RegionData ();
78 
79  void processParams ();
80 
81 #ifdef Xyce_DEBUG_DEVICE
82  friend std::ostream & operator<<(std::ostream & os, const RegionData & rd);
83 #endif
84 
85 private:
86 
87 public:
88  std::string name;
89  std::string outName;
90  std::string type;
91  std::string reactionFile;
92  double area;
93  double xloc;
94 
95  bool doNothing; // set to true if reaction set should be ignored.
96 };
97 
98 } // namespace Device
99 } // namespace Xyce
100 
102 
103 #endif
104