Xyce  6.1
N_ANP_Dakota.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_ANP_Dakota.h,v $
27 //
28 // Purpose : Dakota 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.17 $
41 //
42 // Revision Date : $Date: 2015/04/08 19:18:20 $
43 //
44 // Current Owner : $Author: tvrusso $
45 //-----------------------------------------------------------------------------
46 
47 #ifndef Xyce_N_ANP_Dakota_h
48 #define Xyce_N_ANP_Dakota_h
49 
50 // ---------- Xyce Includes ----------
51 #include <N_ANP_fwd.h>
52 
53 #include <N_ANP_AnalysisBase.h>
54 
55 namespace Xyce {
56 namespace Analysis {
57 //-------------------------------------------------------------------------
58 // Class : Dakota
59 // Purpose : Dakota analysis class
60 // Special Notes :
61 // Creator : Richard Schiek, SNL, Electrical and Microsystem Modeling
62 // Creation Date : 01/24/08
63 //-------------------------------------------------------------------------
64 class Dakota : public AnalysisBase
65 {
66  public:
67  Dakota(AnalysisManager &anaManagerPtr, AnalysisBase &anaType );
68 
69  virtual ~Dakota( );
70 
71  virtual bool getDCOPFlag () const {return true;}
72 
73 protected:
74  virtual bool doRun();
75  virtual bool doInit() { return true; }
76  virtual bool doLoopProcess() { return true; }
77  virtual bool doProcessSuccessfulStep() { return true; }
78  virtual bool doProcessFailedStep() { return true; }
79  virtual bool doFinish() { return true; }
80  virtual bool doHandlePredictor() { return true; }
81 
82 private:
84 
85  // these should be part of this class, but are still too entangled in
86  // the AnalysisManager class to be moved
87  //vector <N_TIA_SweepParam> stepParamVec_;
88  //
89  //bool stepLoopInitialized_; // true if the step loop has been set up.
90  //int stepLoopSize_;
91  //int stepLoopIter_;
92 
93 };
94 
95 } // namespace Analysis
96 } // namespace Xyce
97 
98 #endif // Xyce_N_ANP_Dakota_h
virtual bool getDCOPFlag() const
Definition: N_ANP_Dakota.h:71
Pure virtual class to augment a linear system.
virtual bool doLoopProcess()
Definition: N_ANP_Dakota.h:76
virtual bool doInit()
Definition: N_ANP_Dakota.h:75
AnalysisBase & mainAnalysis_
Definition: N_ANP_Dakota.h:83
virtual bool doRun()
Definition: N_ANP_Dakota.C:66
virtual bool doProcessSuccessfulStep()
Definition: N_ANP_Dakota.h:77
virtual bool doProcessFailedStep()
Definition: N_ANP_Dakota.h:78
virtual bool doHandlePredictor()
Definition: N_ANP_Dakota.h:80
Dakota(AnalysisManager &anaManagerPtr, AnalysisBase &anaType)
Definition: N_ANP_Dakota.C:49
virtual bool doFinish()
Definition: N_ANP_Dakota.h:79