Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
N_ANP_MPDE.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_MPDE.h,v $
27 //
28 // Purpose : MPDE 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 : Todd Coffey, 1414, Ting Mei 1437
34 //
35 // Creation Date : 07/23/08
36 //
37 // Revision Information:
38 // ---------------------
39 //
40 // Revision Number: $Revision: 1.17 $
41 // Revision Date : $Date: 2014/07/23 20:30:56 $
42 // Current Owner : $Author: dgbaur $
43 //-----------------------------------------------------------------------------
44 
45 #ifndef Xyce_N_ANP_MPDE_h
46 #define Xyce_N_ANP_MPDE_h
47 
48 // ---------- Xyce Includes ----------
49 #include <N_ANP_fwd.h>
50 
51 #include <N_ANP_AnalysisBase.h>
52 #include <N_ANP_StepEvent.h>
53 #include <N_UTL_Listener.h>
54 
55 namespace Xyce {
56 namespace Analysis {
57 
58 //-------------------------------------------------------------------------
59 // Class : MPDE
60 // Purpose : MPDE analysis class
61 // Special Notes :
62 // Creator : Richard Schiek, SNL, Electrical and Microsystem Modeling
63 // Creation Date : 01/24/08
64 //-------------------------------------------------------------------------
65 class MPDE : public AnalysisBase, public Util::ListenerAutoSubscribe<StepEvent>
66 {
67 public:
68  MPDE(AnalysisManager &analysis_manager);
69 
70  virtual ~MPDE() {};
71 
72  void notify(const StepEvent &event);
73 
74  bool getDCOPFlag();
75 
76  bool run();
77  bool init();
78  bool loopProcess();
79  bool processSuccessfulDCOP();
80  bool processFailedDCOP();
81  bool processSuccessfulStep();
82  bool processFailedStep();
83  bool finish();
84  bool handlePredictor();
85 
86  bool finalVerboseOutput();
87 
88 private:
89 
91 
92  // a flag to indicate of the simulation is paused
93  bool isPaused;
94 
95  double startDCOPtime, endTRANtime; // startTRANtime
96  // Timing/loop count info
97  // Device::DeviceInterface * devInterfacePtr_;
98  // N_TOP_Topology * topoMgrPtr_;
99  // N_LOA_NonlinearEquationLoader * nonlinearEquationLoaderPtr_;
100  // N_LAS_Builder * appBuilderPtr_;
101 };
102 
103 } // namespace Analysis
104 } // namespace Xyce
105 
107 
108 #endif // Xyce_N_ANP_MPDE_h
109