Xyce  6.1
N_DEV_SpecieSource.C
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.C,v $
27 //
28 // Purpose : This file contains the details of the dope info class.
29 //
30 // Special Notes :
31 //
32 // Creator : Eric R. Keiter, SNL, Parallel Computational Sciences
33 //
34 // Creation Date :
35 //
36 // Revision Information:
37 // ---------------------
38 //
39 // Revision Number: $Revision: 1.10.4.1 $
40 //
41 // Revision Date : $Date: 2015/04/02 18:20:09 $
42 //
43 // Current Owner : $Author: tvrusso $
44 //-------------------------------------------------------------------------
45 #include <Xyce_config.h>
46 
47 // ---------- Standard Includes ----------
48 #include <iostream>
49 
50 // ---------- Xyce Includes ----------
52 #include <N_UTL_Expression.h>
53 #include <N_DEV_SpecieSource.h>
54 
55 namespace Xyce {
56 namespace Device {
57 
58 template<>
60 {
61  addPar("NAME", "none", &SpecieSource::name);
62 }
63 
65  static ParametricData<SpecieSource> parMap;
66 
67  return parMap;
68 }
69 
70 // ----------------------------------------------------------------------------
71 // Function : SpecieSource::SpecieSource
72 // Purpose : constructor
73 // Special Notes :
74 // Scope : public
75 // Creator : Eric Keiter, SNL
76 // Creation Date :
77 // ----------------------------------------------------------------------------
79  : CompositeParam (getParametricData()),
80  name("V0")
81 {}
82 
83 // ----------------------------------------------------------------------------
84 // Function : SpecieSource::processParam
85 // Purpose :
86 // Special Notes :
87 // Scope : public
88 // Creator : Eric Keiter, SNL, Parallel Computational Sciences
89 // Creation Date :
90 // ----------------------------------------------------------------------------
92 (Param & ndParam, std::string & param, DevicePDEInstance & di)
93 {
94  bool bsuccess = true;
95 
96  return bsuccess;
97 }
98 
99 // ----------------------------------------------------------------------------
100 // Function : SpecieSource::processParams
101 // Purpose :
102 // Special Notes :
103 // Scope : public
104 // Creator : Eric Keiter, SNL, Parallel Computational Sciences
105 // Creation Date :
106 // ----------------------------------------------------------------------------
108 {}
109 
110 } // namespace Device
111 } // namespace Xyce
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...
ParametricData()
Constructs the parameter data map.
Definition: N_DEV_Pars.h:1392
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...