Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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-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_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.7 $
41 //
42 // Revision Date : $Date: 2014/02/24 23:49:12 $
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  AnalysisBase(anaManagerPtr)
69  {
70  // this is the analysis that will be done for each step
71  mainAnalysisRCPtr_ = rcp( anaType, false);
72  };
73 
74  virtual ~Dakota( ) {};
75 
76  virtual bool run();
77  virtual bool init() /* override */ {
78  return true;
79  }
80 
81  virtual bool loopProcess() /* override */ {
82  return true;
83  }
84 
85  virtual bool processSuccessfulStep() /* override */ {
86  return true;
87  }
88 
89  virtual bool processFailedStep() /* override */ {
90  return true;
91  }
92 
93  virtual bool finish() /* override */ {
94  return true;
95  }
96 
97  virtual bool handlePredictor() /* override */ {
98  return true;
99  }
100 
101 private:
102  RefCountPtr< AnalysisBase > mainAnalysisRCPtr_;
103 
104  // these should be part of this class, but are still too entangled in
105  // the AnalysisManager class to be moved
106  //vector <N_TIA_SweepParam> stepParamVec_;
107  //
108  //bool stepLoopInitialized_; // true if the step loop has been set up.
109  //int stepLoopSize_;
110  //int stepLoopIter_;
111 
112 };
113 
114 } // namespace Analysis
115 } // namespace Xyce
116 
118 
119 #endif // Xyce_N_ANP_Dakota_h