Xyce
6.1
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
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.16 $
41
//
42
// Revision Date : $Date: 2014/07/16 17:32:40 $
43
//
44
// Current Owner : $Author: dgbaur $
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
&analysis_manager,
AnalysisBase
&main_analysis )
68
:
AnalysisBase
(analysis_manager),
69
mainAnalysis_
(main_analysis),
70
stepLoopSize_
(0),
71
stepLoopIter_
(0),
72
stepParamVec_
()
73
{}
74
75
virtual
~Step
()
76
{}
77
78
bool
setAnalysisParams
(
const
N_UTL_OptionBlock & paramsBlock);
79
80
void
setParamsWithOutputMgrAdapter
(
OutputMgrAdapter
& outputManagerAdapter)
81
{
82
outputManagerAdapter_
.
setStepParamVec
(
stepParamVec_
);
83
}
84
85
int
getStepIter
()
86
{
return
stepLoopIter_
; }
87
88
virtual
bool
getDCOPFlag
();
89
90
virtual
bool
run
();
91
virtual
bool
init
();
92
virtual
bool
loopProcess
();
93
virtual
bool
processSuccessfulStep
();
94
virtual
bool
processFailedStep
();
95
virtual
bool
finish
();
96
virtual
bool
handlePredictor
() {
return
true
; }
97
98
private
:
99
AnalysisBase
&
mainAnalysis_
;
100
std::vector <SweepParam>
stepParamVec_
;
101
int
stepLoopSize_
;
102
int
stepLoopIter_
;
103
};
104
105
}
// namespace Analysis
106
}
// namespace Xyce
107
108
typedef
Xyce::Analysis::Step
N_ANP_Step
;
109
110
#endif // Xyce_N_ANP_Step_h
src
AnalysisPKG
include
N_ANP_Step.h
Generated on Thu Sep 25 2014 15:20:21 for Xyce by
1.8.3.1