Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
N_ANP_DCSweep.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-2014 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_ANP_DCSweep.h,v $
27 //
28 // Purpose : DC sweep analysis class
29 //
30 // Special Notes : Specify any "hidden" or subtle details of the class here.
31 // Portability details, error handling information, etc.
32 //
33 // Creator : Richard Schiek, SNL, Electrical and Microsystem Modeling
34 //
35 // Creation Date : 01/24/08
36 //
37 // Revision Information:
38 // ---------------------
39 //
40 // Revision Number: $Revision: 1.19 $
41 //
42 // Revision Date : $Date: 2014/02/24 23:49:12 $
43 //
44 // Current Owner : $Author: tvrusso $
45 //-----------------------------------------------------------------------------
46 
47 #ifndef Xyce_N_ANP_DCSweep_h
48 #define Xyce_N_ANP_DCSweep_h
49 
50 #include <Teuchos_RefCountPtr.hpp>
51 using Teuchos::RefCountPtr;
52 using Teuchos::rcp;
53 
54 // ---------- Xyce Includes ----------
55 #include <N_ANP_fwd.h>
56 
57 #include <N_ANP_AnalysisBase.h>
58 
59 namespace Xyce {
60 namespace Analysis {
61 
62 //-------------------------------------------------------------------------
63 // Class : DCSweep
64 // Purpose : Transient analysis class
65 // Special Notes :
66 // Creator : Richard Schiek, SNL, Electrical and Microsystem Modeling
67 // Creation Date : 01/24/08
68 //-------------------------------------------------------------------------
69 class DCSweep : public AnalysisBase
70 {
71  public:
72  DCSweep( AnalysisManager * anaManagerPtr ) :
73  AnalysisBase(anaManagerPtr),
74  dcLoopInitialized_( false ),
75  dcLoopSize_(0)
76  {
77  dcParamVec_ = rcp( new std::vector <SweepParam>() );
78  };
79 
80  virtual ~DCSweep( ) {};
81 
82  bool setAnalysisParams(const N_UTL_OptionBlock & paramsBlock);
83  bool outputFailureStats(std::ostream &os);
84 
86  (RefCountPtr< OutputMgrAdapter > & outputMgrAdapterRCPtr)
87  {
88  outputMgrAdapterRCPtr->setDCParamVec( dcParamVec_ );
89  };
90 
91  bool run();
92  bool init();
93  bool loopProcess();
94  bool processSuccessfulStep();
95  bool processFailedStep();
96  bool finish();
97  bool handlePredictor();
98 
99  // Two Level specific
100  bool twoLevelStep();
101 
102  void dcSweepOutput();
103  void printStepHeader(std::ostream &os);
104  bool printLoopInfo(int start, int finish);
105 
106  protected:
107 
108  private:
109  void initializeSolution_();
110  void takeStep_ ();
111 
112  public:
113  protected:
114  private:
117 
118  std::list < int > dcSweepFailures_;
119  RefCountPtr< std::vector <SweepParam> > dcParamVec_;
120 
121  std::vector<double> objectiveVec_;
122  std::vector<double> dOdpVec_;
123  std::vector<double> dOdpAdjVec_;
124  std::vector<double> scaled_dOdpVec_;
125  std::vector<double> scaled_dOdpAdjVec_;
126 };
127 
128 } // namespace Analysis
129 } // namespace Xyce
130 
132 
133 #endif