Xyce  6.1
N_DEV_Source.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_Source.h,v $
27 //
28 // Purpose : Source base lasses.
29 //
30 // Special Notes :
31 //
32 // Creator : Eric R. Keiter, SNL, Parallel Computational Sciences
33 //
34 // Creation Date : 02/28/00
35 //
36 // Revision Information:
37 // ---------------------
38 //
39 // Revision Number: $Revision: 1.31 $
40 //
41 // Revision Date : $Date: 2015/04/24 20:25:43 $
42 //
43 // Current Owner : $Author: dgbaur $
44 //-----------------------------------------------------------------------------
45 
46 #ifndef Xyce_N_DEV_Source_h
47 #define Xyce_N_DEV_Source_h
48 
49 // ---------- Xyce Includes ----------
50 #include <N_DEV_fwd.h>
51 #include <N_DEV_Device.h>
52 #include <N_DEV_DeviceInstance.h>
53 
54 namespace Xyce {
55 namespace Device {
56 
57 //-----------------------------------------------------------------------------
58 // Class : SourceInstance
59 // Purpose :
60 // Special Notes :
61 // Creator : Eric Keiter
62 // Creation Date : 3/27/04
63 //-----------------------------------------------------------------------------
65 {
66 public:
68  const InstanceBlock & IB,
69  ParametricData<void> & parametric_data,
70  const FactoryBlock & factory_block);
71 
73 
74 private:
77 
78 public:
79  void setFastSourceFlag(bool value);
80  bool getFastSourceFlag() const;
81  bool getResetFlag() const;
82 
83  double period() const;
84 
85  virtual bool getInstanceBreakPoints(std::vector<Util::BreakPoint> &breakPointTimes);
86  virtual bool updateSource();
87 
88  virtual bool loadBVectorsforAC(double * bVecReal, double * bVecImag ) { return true; }
89 
90 protected:
91  int sourceType; ///< type of source data
95 };
96 
97 } // namespace Device
98 } // namespace Xyce
99 
100 #endif
SourceInstance & operator=(const SourceInstance &)
virtual bool loadBVectorsforAC(double *bVecReal, double *bVecImag)
Definition: N_DEV_Source.h:88
SourceInstance(const InstanceBlock &IB, ParametricData< void > &parametric_data, const FactoryBlock &factory_block)
Definition: N_DEV_Source.C:64
Pure virtual class to augment a linear system.
int sourceType
type of source data
Definition: N_DEV_Source.h:91
const T & value(const ParameterBase &entity, const Descriptor &descriptor)
Returns the value of the parameter for the entity.
Definition: N_DEV_Pars.h:1224
The FactoryBlock contains parameters needed by the device, instance and model creation functions...
Class ParametricData manages the configuration information and the parameter binding map...
Definition: N_DEV_Pars.h:1303
virtual bool getInstanceBreakPoints(std::vector< Util::BreakPoint > &breakPointTimes)
Definition: N_DEV_Source.C:166
void setFastSourceFlag(bool value)
Definition: N_DEV_Source.C:96
InstanceBlock represent a device instance line from the netlist.