Xyce  6.1
Xyce::Analysis::Step Class Reference

#include <N_ANP_Step.h>

Inheritance diagram for Xyce::Analysis::Step:
Collaboration diagram for Xyce::Analysis::Step:

Public Member Functions

 Step (AnalysisManager &analysis_manager, Loader::Loader &loader, AnalysisBase &child_analysis)
 
virtual ~Step ()
 
bool setAnalysisParams (const Util::OptionBlock &paramsBlock)
 
const TimeIntg::TIAParamsgetTIAParams () const
 
TimeIntg::TIAParamsgetTIAParams ()
 
virtual bool getDCOPFlag () const
 
- Public Member Functions inherited from Xyce::Analysis::AnalysisBase
 AnalysisBase (AnalysisManager &analysis_manager, const char *name)
 
virtual ~AnalysisBase ()
 
void setTranStepNumber (int step)
 
int getTranStepNumber ()
 
int getStepNumber ()
 
void setStepNumber (int step)
 
virtual bool outputFailureStats (std::ostream &os)
 
bool run ()
 
bool init ()
 
bool processSuccessfulStep ()
 
bool processFailedStep ()
 
bool finish ()
 
bool handlePredictor ()
 
virtual void printStepHeader (std::ostream &os)
 
virtual void printProgress (std::ostream &os)
 
virtual bool twoLevelStep ()
 
virtual bool isAnalysis (int analysis_type) const
 
bool getDoubleDCOPEnabled () const
 
void setDoubleDCOPEnabled (bool enable)
 
virtual int getDoubleDCOPStep () const
 
bool firstDoubleDCOPStep () const
 
void nextDCOPStep ()
 
bool setDCOPOption (const Util::Param &param)
 
bool getNOOP () const
 
void setNOOP (bool noop)
 
virtual bool printLoopInfo (int start, int finish)
 
void setBeginningIntegrationFlag (bool bif)
 
bool getBeginningIntegrationFlag () const
 
void setIntegrationMethod (int im)
 
int getIntegrationMethod () const
 
void setInputOPFlag (bool initial_conditions_loaded)
 
bool getInputOPFlag () const
 
bool resetForStepAnalysis ()
 
void resetAll ()
 
int saveLoopInfo ()
 
double getTotalLinearSolutionTime () const
 
double getTotalResidualLoadTime () const
 
double getTotalJacobianLoadTime () const
 
const StatCountsgetStatCounts (int index=-1) const
 
const char * getName () const
 
- Public Member Functions inherited from Xyce::Analysis::ProcessorBase
 ProcessorBase ()
 
virtual ~ProcessorBase ()
 

Protected Member Functions

virtual bool doRun ()
 
virtual bool doInit ()
 
virtual bool doLoopProcess ()
 
virtual bool doProcessSuccessfulStep ()
 
virtual bool doProcessFailedStep ()
 
virtual bool doFinish ()
 
virtual bool doHandlePredictor ()
 

Private Attributes

AnalysisManageranalysisManager_
 
Loader::Loaderloader_
 
OutputMgrAdapteroutputManagerAdapter_
 
AnalysisBasechildAnalysis_
 
SweepVector stepSweepVector_
 
int stepLoopSize_
 

Additional Inherited Members

- Public Attributes inherited from Xyce::Analysis::AnalysisBase
StatCounts stats_
 
- Protected Attributes inherited from Xyce::Analysis::AnalysisBase
bool beginningIntegration
 
unsigned int baseIntegrationMethod_
 Current time-integration method flag. More...
 
unsigned int stepNumber
 Time-integration step number counter. More...
 
unsigned int tranStepNumber
 
std::vector< StatCountssaveStatCountsVector_
 

Detailed Description

Definition at line 65 of file N_ANP_Step.h.

Constructor & Destructor Documentation

Xyce::Analysis::Step::Step ( AnalysisManager analysis_manager,
Loader::Loader loader,
AnalysisBase child_analysis 
)
inline

Definition at line 68 of file N_ANP_Step.h.

virtual Xyce::Analysis::Step::~Step ( )
inlinevirtual

Definition at line 78 of file N_ANP_Step.h.

Member Function Documentation

bool Xyce::Analysis::Step::doFinish ( )
protectedvirtual

Implements Xyce::Analysis::AnalysisBase.

Definition at line 225 of file N_ANP_Step.C.

virtual bool Xyce::Analysis::Step::doHandlePredictor ( )
inlineprotectedvirtual

Implements Xyce::Analysis::AnalysisBase.

Definition at line 95 of file N_ANP_Step.h.

bool Xyce::Analysis::Step::doInit ( )
protectedvirtual

Implements Xyce::Analysis::AnalysisBase.

Definition at line 129 of file N_ANP_Step.C.

bool Xyce::Analysis::Step::doLoopProcess ( )
protectedvirtual

Definition at line 154 of file N_ANP_Step.C.

bool Xyce::Analysis::Step::doProcessFailedStep ( )
protectedvirtual

Implements Xyce::Analysis::AnalysisBase.

Definition at line 211 of file N_ANP_Step.C.

bool Xyce::Analysis::Step::doProcessSuccessfulStep ( )
protectedvirtual

Implements Xyce::Analysis::AnalysisBase.

Definition at line 198 of file N_ANP_Step.C.

bool Xyce::Analysis::Step::doRun ( )
protectedvirtual

Implements Xyce::Analysis::AnalysisBase.

Definition at line 116 of file N_ANP_Step.C.

bool Xyce::Analysis::Step::getDCOPFlag ( ) const
virtual

Implements Xyce::Analysis::AnalysisBase.

Definition at line 102 of file N_ANP_Step.C.

const TimeIntg::TIAParams & Xyce::Analysis::Step::getTIAParams ( ) const
virtual

Implements Xyce::Analysis::AnalysisBase.

Definition at line 82 of file N_ANP_Step.C.

TimeIntg::TIAParams & Xyce::Analysis::Step::getTIAParams ( )
virtual

Implements Xyce::Analysis::AnalysisBase.

Definition at line 88 of file N_ANP_Step.C.

bool Xyce::Analysis::Step::setAnalysisParams ( const Util::OptionBlock &  paramsBlock)

Definition at line 73 of file N_ANP_Step.C.

Member Data Documentation

AnalysisManager& Xyce::Analysis::Step::analysisManager_
private

Definition at line 98 of file N_ANP_Step.h.

AnalysisBase& Xyce::Analysis::Step::childAnalysis_
private

Definition at line 101 of file N_ANP_Step.h.

Loader::Loader& Xyce::Analysis::Step::loader_
private

Definition at line 99 of file N_ANP_Step.h.

OutputMgrAdapter& Xyce::Analysis::Step::outputManagerAdapter_
private

Definition at line 100 of file N_ANP_Step.h.

int Xyce::Analysis::Step::stepLoopSize_
private

Definition at line 103 of file N_ANP_Step.h.

SweepVector Xyce::Analysis::Step::stepSweepVector_
private

Definition at line 102 of file N_ANP_Step.h.


The documentation for this class was generated from the following files: