Xyce  6.1
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-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_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.11.2.1 $
40 //
41 // Revision Date : $Date: 2015/04/02 18:20:09 $
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 
51 // ---------- Xyce Includes ----------
52 #include <N_DEV_CompositeParam.h>
53 
54 // ---------- Forward Declarations -------
55 
56 //-----------------------------------------------------------------------------
57 // Class : N_DEV_RegionData
58 // Purpose :
59 // Special Notes : This class is intended to be a class for passing data into
60 // the Rxn Region constructor.
61 //
62 // Creator : Eric Keiter, SNL
63 // Creation Date : 4/17/11
64 //-----------------------------------------------------------------------------
65 
66 namespace Xyce {
67 namespace Device {
68 
69 class RegionData : public CompositeParam
70 {
71  friend class ParametricData<RegionData>;
72  friend std::ostream & operator<<(std::ostream & os, const RegionData & rd);
73 
74 public:
76 
77  RegionData ();
78 
79  void processParams ();
80 
81 public:
82  std::string name;
83  std::string outName;
84  std::string type;
85  std::string reactionFile;
86  double area;
87  double xloc;
88 
89  bool doNothing; // set to true if reaction set should be ignored.
90 };
91 
92 } // namespace Device
93 } // namespace Xyce
94 
95 #endif
96 
Pure virtual class to augment a linear system.
static ParametricData< RegionData > & getParametricData()
friend std::ostream & operator<<(std::ostream &os, const RegionData &rd)
void processParams()
processParams post processes the parameters that have been set in the object of the derived class...
Manages parameter binding for class C.
Definition: N_DEV_Pars.h:214
CompositeParam is the base class for classes that wish to only manage the processing of parameter dat...