Xyce  6.1
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-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_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.31.2.1 $
41 //
42 // Revision Date : $Date: 2015/04/02 18:20:06 $
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 #include <N_ANP_Factory.h>
54 
55 namespace Xyce {
56 namespace Analysis {
57 
58 //-------------------------------------------------------------------------
59 // Class : Step
60 // Purpose : Step analysis class
61 // Special Notes :
62 // Creator : Richard Schiek, SNL, Electrical and Microsystem Modeling
63 // Creation Date : 01/24/08
64 //-------------------------------------------------------------------------
65 class Step : public AnalysisBase
66 {
67 public:
68  Step(AnalysisManager &analysis_manager, AnalysisBase &child_analysis)
69  : AnalysisBase(analysis_manager, "Step"),
70  analysisManager_(analysis_manager),
71  loader_(analysis_manager.getLoader()),
72  outputManagerAdapter_(analysis_manager.getOutputManagerAdapter()),
73  childAnalysis_(child_analysis),
75  stepLoopSize_(0)
76  {}
77 
78  virtual ~Step()
79  {}
80 
81  bool setAnalysisParams(const Util::OptionBlock & paramsBlock);
82 
83  const TimeIntg::TIAParams &getTIAParams() const; // override
84  TimeIntg::TIAParams &getTIAParams(); // override
85 
86  virtual bool getDCOPFlag() const;
87 
88  virtual bool doRun();
89  virtual bool doInit();
90  virtual bool doLoopProcess();
91  virtual bool doProcessSuccessfulStep();
92  virtual bool doProcessFailedStep();
93  virtual bool doFinish();
94  virtual bool doHandlePredictor() { return true; }
95 
96 private:
103 };
104 
105 
107  const std::string & netlist_filename,
108  IO::PkgOptionsMgr & options_manager,
109  AnalysisManager & analysis_manager,
110  Linear::System & linear_system,
111  Nonlinear::Manager & nonlinear_manager);
112 
113 } // namespace Analysis
114 } // namespace Xyce
115 
116 #endif // Xyce_N_ANP_Step_h
virtual bool doHandlePredictor()
Definition: N_ANP_Step.h:94
virtual bool doProcessFailedStep()
Definition: N_ANP_Step.C:218
Pure virtual class to augment a linear system.
AnalysisBase & childAnalysis_
Definition: N_ANP_Step.h:100
SweepVector stepSweepVector_
Definition: N_ANP_Step.h:101
virtual bool doProcessSuccessfulStep()
Definition: N_ANP_Step.C:205
virtual bool doInit()
Definition: N_ANP_Step.C:122
virtual bool doFinish()
Definition: N_ANP_Step.C:232
virtual bool getDCOPFlag() const
Definition: N_ANP_Step.C:95
bool registerStepFactory(const std::string &netlist_filename, IO::PkgOptionsMgr &options_manager, AnalysisManager &analysis_manager, Linear::System &linear_system, Nonlinear::Manager &nonlinear_manager)
Definition: N_ANP_Step.C:376
bool setAnalysisParams(const Util::OptionBlock &paramsBlock)
Definition: N_ANP_Step.C:66
AnalysisManager & analysisManager_
Definition: N_ANP_Step.h:97
Step(AnalysisManager &analysis_manager, AnalysisBase &child_analysis)
Definition: N_ANP_Step.h:68
Factory for creating analysis objects.
Loader::Loader & loader_
Definition: N_ANP_Step.h:98
OutputMgrAdapter & outputManagerAdapter_
Definition: N_ANP_Step.h:99
virtual bool doLoopProcess()
Definition: N_ANP_Step.C:149
virtual bool doRun()
Definition: N_ANP_Step.C:109
std::vector< SweepParam > SweepVector
Definition: N_ANP_fwd.h:85
const TimeIntg::TIAParams & getTIAParams() const
Definition: N_ANP_Step.C:75