Xyce
6.1
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
N_ANP_StepEvent.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_StepEvent.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.5 $
41
//
42
// Revision Date : $Date: 2015/05/12 18:20:10 $
43
//
44
// Current Owner : $Author: dgbaur $
45
//-----------------------------------------------------------------------------
46
47
#ifndef Xyce_N_ANP_StepEvent_h
48
#define Xyce_N_ANP_StepEvent_h
49
50
#include <
N_ANP_fwd.h
>
51
52
namespace
Xyce
{
53
namespace
Analysis {
54
55
struct
StepEvent
56
{
57
public
:
58
enum
State
{
INITIALIZE
,
STEP_STARTED
,
STEP_COMPLETED
,
FINISH
};
59
60
StepEvent
(
State
state,
SweepVector
&step_sweep_vector,
int
count = 0)
61
:
state_
(state),
62
stepSweepVector_
(step_sweep_vector),
63
count_
(count),
64
finalSimTime_
(0.0)
65
{}
66
67
State
state_
;
68
const
SweepVector
&
stepSweepVector_
;
69
int
count_
;
70
// used to report the final simtulation time if the
71
// child analysis of a step was transient.
72
double
currentSimTime_
;
73
double
finalSimTime_
;
74
};
75
76
}
// namespace Analysis
77
}
// namespace Xyce
78
79
#endif // Xyce_N_ANP_StepEvent_h
Xyce::Analysis::StepEvent::StepEvent
StepEvent(State state, SweepVector &step_sweep_vector, int count=0)
Definition:
N_ANP_StepEvent.h:60
Xyce::Analysis::StepEvent::State
State
Definition:
N_ANP_StepEvent.h:58
Xyce::Analysis::StepEvent::count_
int count_
Definition:
N_ANP_StepEvent.h:69
Xyce
Pure virtual class to augment a linear system.
Definition:
AnalysisPKG/index.dox:4
Xyce::Analysis::StepEvent::state_
State state_
Definition:
N_ANP_StepEvent.h:67
Xyce::Analysis::StepEvent::INITIALIZE
Definition:
N_ANP_StepEvent.h:58
Xyce::Analysis::StepEvent::currentSimTime_
double currentSimTime_
Definition:
N_ANP_StepEvent.h:72
Xyce::Analysis::StepEvent::FINISH
Definition:
N_ANP_StepEvent.h:58
Xyce::Analysis::StepEvent::stepSweepVector_
const SweepVector & stepSweepVector_
Definition:
N_ANP_StepEvent.h:68
Xyce::Analysis::StepEvent
Definition:
N_ANP_StepEvent.h:55
Xyce::Analysis::StepEvent::STEP_COMPLETED
Definition:
N_ANP_StepEvent.h:58
Xyce::Analysis::StepEvent::STEP_STARTED
Definition:
N_ANP_StepEvent.h:58
Xyce::Analysis::StepEvent::finalSimTime_
double finalSimTime_
Definition:
N_ANP_StepEvent.h:73
Xyce::Analysis::SweepVector
std::vector< SweepParam > SweepVector
Definition:
N_ANP_fwd.h:94
N_ANP_fwd.h
src
AnalysisPKG
include
N_ANP_StepEvent.h
Generated by
1.8.10