Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
N_ANP_Step.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_Step.h,v $
27 //
28 // Purpose : Step 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.11 $
41 //
42 // Revision Date : $Date: 2014/02/24 23:49:12 $
43 //
44 // Current Owner : $Author: tvrusso $
45 //-----------------------------------------------------------------------------
46 
47 #ifndef Xyce_N_ANP_Step_h
48 #define Xyce_N_ANP_Step_h
49 
50 #include <N_ANP_fwd.h>
51 
52 #include <N_ANP_AnalysisBase.h>
53 
54 namespace Xyce {
55 namespace Analysis {
56 
57 //-------------------------------------------------------------------------
58 // Class : Step
59 // Purpose : Step analysis class
60 // Special Notes :
61 // Creator : Richard Schiek, SNL, Electrical and Microsystem Modeling
62 // Creation Date : 01/24/08
63 //-------------------------------------------------------------------------
64 class Step : public AnalysisBase
65 {
66  public:
67  Step( AnalysisManager * anaManagerPtr, AnalysisBase * anaType ) :
68  AnalysisBase(anaManagerPtr),
69  stepLoopSize_(0),
70  stepLoopIter_(0)
71  {
72  // this is the analysis that will be done for each step
73  mainAnalysisRCPtr_ = rcp( anaType, false);
74 
75  stepParamVec_ = rcp( new std::vector <SweepParam>() );
76  };
77 
78  virtual ~Step( ) {};
79 
80  bool setAnalysisParams(const N_UTL_OptionBlock & paramsBlock);
81 
83  (RefCountPtr< OutputMgrAdapter > & outputMgrAdapterRCPtr)
84  {
85  outputMgrAdapterRCPtr_->setStepParamVec( stepParamVec_ );
86  };
87 
88  int getStepIter () { return stepLoopIter_; }
89 
90  virtual bool run(); /* override */
91  virtual bool init(); /* override */
92  virtual bool loopProcess(); /* override */
93  virtual bool processSuccessfulStep(); /* override */
94  virtual bool processFailedStep(); /* override */
95  virtual bool finish(); /* override */
96  virtual bool handlePredictor() /* override */ {
97  return true;
98  }
99 
100  private:
101  RefCountPtr< AnalysisBase > mainAnalysisRCPtr_;
102 
103  RefCountPtr< std::vector <SweepParam> > stepParamVec_;
104  //
105  //bool stepLoopInitialized_; // true if the step loop has been set up.
106 
109 };
110 
111 } // namespace Analysis
112 } // namespace Xyce
113 
115 
116 #endif // Xyce_N_ANP_Step_h