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.11 $
41 // Revision Date : $Date: 2014/02/24 23:49:12 $
42 // Current Owner : $Author: tvrusso $
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 
53 namespace Xyce {
54 namespace Analysis {
55 
56 //-------------------------------------------------------------------------
57 // Class : MPDE
58 // Purpose : MPDE analysis class
59 // Special Notes :
60 // Creator : Richard Schiek, SNL, Electrical and Microsystem Modeling
61 // Creation Date : 01/24/08
62 //-------------------------------------------------------------------------
63 class MPDE : public AnalysisBase
64 {
65 public:
66  MPDE( AnalysisManager * anaManagerPtr );
67 
68  virtual ~MPDE() {};
69 
70  virtual bool run(); /* override */
71  virtual bool init(); /* override */
72  virtual bool loopProcess(); /* override */
73  virtual bool processSuccessfulDCOP(); /* override */
74  virtual bool processFailedDCOP(); /* override */
75  virtual bool processSuccessfulStep(); /* override */
76  virtual bool processFailedStep(); /* override */
77  virtual bool finish(); /* override */
78  virtual bool handlePredictor(); /* override */
79 
80  virtual bool resetForStepAnalysis(); /* override */
81 
82  bool finalVerboseOutput();
83 
84 private:
85 
87 
88  // a flag to indicate of the simulation is paused
89  bool isPaused;
90 
91  double startDCOPtime, endTRANtime; // startTRANtime
92  // Timing/loop count info
93  RefCountPtr<N_DEV_DeviceInterface> devInterfacePtr_;
94  RefCountPtr<N_TOP_Topology> topoMgrPtr_;
95  RefCountPtr<N_LOA_NonlinearEquationLoader> nonlinearEquationLoaderPtr_;
96  RefCountPtr<N_LAS_Builder> appBuilderPtr_;
97 };
98 
99 } // namespace Analysis
100 } // namespace Xyce
101 
103 
104 #endif // Xyce_N_ANP_MPDE_h
105