Xyce  6.1
N_DEV_Op.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_Op.h,v $
27 //
28 // Purpose : Generate global id structures and proc maps
29 // and distribute nodes to processors
30 //
31 // Special Notes :
32 //
33 // Creator : Robert J. Hoekstra, SNL, Parallel Computational Sciences
34 //
35 // Creation Date : 10/10/00
36 //
37 // Revision Information:
38 // ---------------------
39 //
40 // Revision Number: $Revision: 1.7 $
41 //
42 // Revision Date : $Date: 2015/07/02 13:00:10 $
43 //
44 // Current Owner : $Author: dgbaur $
45 //-----------------------------------------------------------------------------
46 
47 #ifndef Xyce_N_DEV_Op_h
48 #define Xyce_N_DEV_Op_h
49 
50 #include <iterator>
51 
52 #include <N_DEV_fwd.h>
53 #include <N_UTL_Op.h>
54 
55 namespace Xyce {
56 namespace Device {
57 
58 class DeviceMgrGlobalParameterOp : public Util::Op::Op<DeviceMgrGlobalParameterOp, Util::Op::ReduceNone, Util::Op::EvalNoop>
59 {
60 public:
61  DeviceMgrGlobalParameterOp(const std::string &name, const DeviceMgr &device_manager, const double &global_parameter_value)
62  : Base(name),
63  globalParameterValue_(global_parameter_value)
64  {}
65 
67  {}
68 
69  static complex get(const DeviceMgrGlobalParameterOp &op, const Util::Op::OpData &op_data);
70 
71  const double & globalParameterValue_;
72 };
73 
74 class DeviceEntityParameterOp : public Util::Op::Op<DeviceEntityParameterOp, Util::Op::ReduceSum, Util::Op::EvalNoop>
75 {
76 public:
77  DeviceEntityParameterOp(const std::string &name, const DeviceEntity &device_entity, const std::string &device_parameter_name)
78  : Base(name),
79  deviceEntity_(device_entity),
80  deviceParameterName_(device_parameter_name)
81  {}
82 
84  {}
85 
86  static complex get(const DeviceEntityParameterOp &op, const Util::Op::OpData &op_data);
87 
88  const std::string deviceParameterName_;
90 };
91 
92 class ArtificialParameterOp : public Util::Op::Op<ArtificialParameterOp, Util::Op::ReduceNone, Util::Op::EvalNoop>
93 {
94 public:
95  ArtificialParameterOp(const std::string &name, const DeviceMgr &device_manager, const ArtificialParameters::ArtificialParameter &artificial_parameter, const std::string &artificial_parameter_name)
96  : Base(name),
97  deviceManager_(device_manager),
98  artificialParameterName_(artificial_parameter_name),
99  artificialParameter_(artificial_parameter)
100  {}
101 
103  {}
104 
105  static complex get(const ArtificialParameterOp &op, const Util::Op::OpData &op_data);
106 
108  const std::string artificialParameterName_;
110 };
111 
112 // class DeviceMgrParameterOp : public Util::Op::Op<DeviceMgrParameterOp, Util::Op::ReduceNone, Util::Op::EvalNoop>
113 // {
114 // public:
115 // DeviceMgrParameterOp(const std::string &name, const DeviceMgr &device_manager, const std::string &device_parameter_name)
116 // : Base(name),
117 // deviceManager_(device_manager),
118 // deviceParameterName_(device_parameter_name)
119 // {}
120 
121 
122 // virtual ~DeviceMgrParameterOp()
123 // {}
124 
125 // static complex get(const DeviceMgrParameterOp &op, const Util::Op::OpData &op_data);
126 
127 // const std::string deviceParameterName_;
128 // const DeviceMgr & deviceManager_;
129 // };
130 
131 class DeviceOptionsOp : public Util::Op::Op<DeviceOptionsOp, Util::Op::ReduceNone, Util::Op::EvalNoop>
132 {
133 public:
134  DeviceOptionsOp(const std::string &name, const DeviceOptions &device_options, const std::string &option_name)
135  : Base(name),
136  deviceOptions_(device_options),
137  optionName_(option_name)
138  {}
139 
140 
142  {}
143 
144  static complex get(const DeviceOptionsOp &op, const Util::Op::OpData &op_data);
145 
146  const std::string optionName_;
148 };
149 
150 } // namespace Device
151 } // namespace Xyce
152 
153 #endif // Xyce_N_DEV_Op_h
const ArtificialParameters::ArtificialParameter & artificialParameter_
Definition: N_DEV_Op.h:109
DeviceOptionsOp(const std::string &name, const DeviceOptions &device_options, const std::string &option_name)
Definition: N_DEV_Op.h:134
Pure virtual class to augment a linear system.
DeviceMgrGlobalParameterOp(const std::string &name, const DeviceMgr &device_manager, const double &global_parameter_value)
Definition: N_DEV_Op.h:61
DeviceEntityParameterOp(const std::string &name, const DeviceEntity &device_entity, const std::string &device_parameter_name)
Definition: N_DEV_Op.h:77
const DeviceOptions & deviceOptions_
Definition: N_DEV_Op.h:147
const DeviceEntity & deviceEntity_
Definition: N_DEV_Op.h:89
const std::string artificialParameterName_
Definition: N_DEV_Op.h:108
const DeviceMgr & deviceManager_
Definition: N_DEV_Op.h:107
const std::string optionName_
Definition: N_DEV_Op.h:146
const std::string deviceParameterName_
Definition: N_DEV_Op.h:88
ArtificialParameterOp(const std::string &name, const DeviceMgr &device_manager, const ArtificialParameters::ArtificialParameter &artificial_parameter, const std::string &artificial_parameter_name)
Definition: N_DEV_Op.h:95