Xyce  6.1
N_DEV_SpecieSource.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_SpecieSource.h,v $
27 //
28 // Purpose : This file contains the PDE device instance base class.
29 //
30 // Special Notes :
31 //
32 // Creator : Eric R. Keiter, SNL, Parallel Computational Sciences
33 //
34 // Creation Date : 05/15/01
35 //
36 // Revision Information:
37 // ---------------------
38 //
39 // Revision Number: $Revision: 1.9.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_SpecieSource_h
47 #define Xyce_N_DEV_SpecieSource_h
48 
49 // ---------- Standard Includes ----------
50 
51 // ---------- Xyce Includes ----------
52 #include <N_DEV_fwd.h>
53 #include <N_DEV_Const.h>
54 #include <N_DEV_CompositeParam.h>
55 
56 namespace Xyce {
57 namespace Device {
58 
59 
60 //-----------------------------------------------------------------------------
61 // Class : SpecieSource
62 // Purpose :
63 // Special Notes :
64 // Creator : Eric Keiter, SNL
65 // Creation Date :
66 //-----------------------------------------------------------------------------
68 {
70 
71 public:
73 
74  SpecieSource ();
75  bool processParam (Param & ndParam, std::string & param, DevicePDEInstance & di);
76  void processParams ();
77 
78 public:
79  std::string name; // this is also the index into the map.
80 };
81 
82 // inline functions
83 //-----------------------------------------------------------------------------
84 // Function : SpecieSource::operator<<
85 // Purpose : "<<" operator
86 // Special Notes :
87 // Scope : public
88 // Creator : Eric R. Keiter, SNL
89 // Creation Date :
90 //-----------------------------------------------------------------------------
91 inline std::ostream & operator<<(std::ostream & os, const SpecieSource & ds)
92 {
93  os << ds.name << ":\n";
94  os << std::endl;
95  return os;
96 }
97 
98 } // namespace Device
99 } // namespace Xyce
100 
101 #endif
102 
bool processParam(Param &ndParam, std::string &param, DevicePDEInstance &di)
Pure virtual class to augment a linear system.
static ParametricData< SpecieSource > & getParametricData()
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...
std::ostream & operator<<(std::ostream &os, const Configuration &configuration)
Definition: N_DEV_Dump.C:134