Xyce  6.1
Xyce::Analysis::AnalysisBase Class Referenceabstract

#include <N_ANP_AnalysisBase.h>

Inheritance diagram for Xyce::Analysis::AnalysisBase:
Collaboration diagram for Xyce::Analysis::AnalysisBase:

Public Member Functions

 AnalysisBase (AnalysisManager &analysis_manager, const char *name)
 
virtual ~AnalysisBase ()
 
void setTranStepNumber (int step)
 
int getTranStepNumber ()
 
int getStepNumber ()
 
void setStepNumber (int step)
 
virtual const TimeIntg::TIAParamsgetTIAParams () const =0
 
virtual TimeIntg::TIAParamsgetTIAParams ()=0
 
virtual bool outputFailureStats (std::ostream &os)
 
bool run ()
 
bool init ()
 
bool loopProcess ()
 
bool processSuccessfulStep ()
 
bool processFailedStep ()
 
bool finish ()
 
bool handlePredictor ()
 
virtual bool doRun ()=0
 
virtual bool doInit ()=0
 
virtual bool doLoopProcess ()=0
 
virtual bool doProcessSuccessfulStep ()=0
 
virtual bool doProcessFailedStep ()=0
 
virtual bool doFinish ()=0
 
virtual bool doHandlePredictor ()=0
 
virtual void printStepHeader (std::ostream &os)
 
virtual void printProgress (std::ostream &os)
 
virtual bool twoLevelStep ()
 
virtual bool isAnalysis (int analysis_type) const
 
virtual bool getDCOPFlag () const =0
 
virtual int getDoubleDCOPStep () const
 
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
 
bool getDoubleDCOPEnabled () const
 
bool firstDoubleDCOPStep ()
 
const StatCountsgetStatCounts (int index=-1) const
 
bool setDCOPOption (const Util::Param &param)
 
int getLastDCOPStep () const
 
int getFirstDCOPStep () const
 
bool getNOOP () const
 
void setNOOP (bool noop)
 
const char * getName () const
 

Public Attributes

StatCounts stats_
 

Protected Attributes

bool beginningIntegration
 
unsigned int baseIntegrationMethod_
 Current time-integration method flag. More...
 
unsigned int stepNumber
 Time-integration step number counter. More...
 
unsigned int tranStepNumber
 
bool NOOP_
 
bool doubleDCOPFlag_
 true if doing a double-DCOP is possible. More...
 
int doubleDCOPStep_
 current step in the DCOP loop. More...
 
int firstDCOPStep_
 
int lastDCOPStep_
 
std::vector< StatCountssaveStatCountsVector_
 

Private Member Functions

 AnalysisBase (const AnalysisBase &)
 No copying. More...
 
AnalysisBaseoperator= (const AnalysisBase &)
 No assignment. More...
 

Private Attributes

const char * name_
 
bool inputOPFlag_
 true if starting from an initial condition. More...
 

Detailed Description

Definition at line 92 of file N_ANP_AnalysisBase.h.

Constructor & Destructor Documentation

Xyce::Analysis::AnalysisBase::AnalysisBase ( AnalysisManager analysis_manager,
const char *  name 
)

Definition at line 124 of file N_ANP_AnalysisBase.C.

Xyce::Analysis::AnalysisBase::~AnalysisBase ( )
virtual

Definition at line 148 of file N_ANP_AnalysisBase.C.

Xyce::Analysis::AnalysisBase::AnalysisBase ( const AnalysisBase )
private

No copying.

Member Function Documentation

bool Xyce::Analysis::AnalysisBase::finish ( )

Definition at line 189 of file N_ANP_AnalysisBase.C.

bool Xyce::Analysis::AnalysisBase::firstDoubleDCOPStep ( )

Definition at line 340 of file N_ANP_AnalysisBase.C.

bool Xyce::Analysis::AnalysisBase::getBeginningIntegrationFlag ( ) const
inline

Definition at line 187 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::getDoubleDCOPEnabled ( ) const
inline

Definition at line 221 of file N_ANP_AnalysisBase.h.

virtual int Xyce::Analysis::AnalysisBase::getDoubleDCOPStep ( ) const
inlinevirtual

Reimplemented in Xyce::Analysis::HB.

Definition at line 175 of file N_ANP_AnalysisBase.h.

int Xyce::Analysis::AnalysisBase::getFirstDCOPStep ( ) const
inline

Definition at line 242 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::getInputOPFlag ( ) const
inline

Definition at line 206 of file N_ANP_AnalysisBase.h.

int Xyce::Analysis::AnalysisBase::getIntegrationMethod ( ) const
inline

Definition at line 197 of file N_ANP_AnalysisBase.h.

int Xyce::Analysis::AnalysisBase::getLastDCOPStep ( ) const
inline

Definition at line 238 of file N_ANP_AnalysisBase.h.

const char* Xyce::Analysis::AnalysisBase::getName ( ) const
inline

Definition at line 257 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::getNOOP ( ) const
inline

Definition at line 247 of file N_ANP_AnalysisBase.h.

const StatCounts& Xyce::Analysis::AnalysisBase::getStatCounts ( int  index = -1) const
inline

Definition at line 228 of file N_ANP_AnalysisBase.h.

int Xyce::Analysis::AnalysisBase::getStepNumber ( )
inline

Definition at line 112 of file N_ANP_AnalysisBase.h.

double Xyce::Analysis::AnalysisBase::getTotalJacobianLoadTime ( ) const
inline

Definition at line 309 of file N_ANP_AnalysisBase.h.

double Xyce::Analysis::AnalysisBase::getTotalLinearSolutionTime ( ) const
inline

Definition at line 297 of file N_ANP_AnalysisBase.h.

double Xyce::Analysis::AnalysisBase::getTotalResidualLoadTime ( ) const
inline

Definition at line 303 of file N_ANP_AnalysisBase.h.

int Xyce::Analysis::AnalysisBase::getTranStepNumber ( )
inline

Definition at line 107 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::handlePredictor ( )

Definition at line 196 of file N_ANP_AnalysisBase.C.

bool Xyce::Analysis::AnalysisBase::init ( )

Definition at line 160 of file N_ANP_AnalysisBase.C.

virtual bool Xyce::Analysis::AnalysisBase::isAnalysis ( int  analysis_type) const
inlinevirtual

Reimplemented in Xyce::Analysis::HB.

Definition at line 171 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::loopProcess ( )

Definition at line 169 of file N_ANP_AnalysisBase.C.

AnalysisBase& Xyce::Analysis::AnalysisBase::operator= ( const AnalysisBase )
private

No assignment.

virtual bool Xyce::Analysis::AnalysisBase::outputFailureStats ( std::ostream &  os)
inlinevirtual

Reimplemented in Xyce::Analysis::DCSweep.

Definition at line 123 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::printLoopInfo ( int  start,
int  finish 
)
virtual

Reimplemented in Xyce::Analysis::DCSweep.

Definition at line 291 of file N_ANP_AnalysisBase.C.

virtual void Xyce::Analysis::AnalysisBase::printProgress ( std::ostream &  os)
inlinevirtual

Reimplemented in Xyce::Analysis::Transient, Xyce::Analysis::AC, and Xyce::Analysis::NOISE.

Definition at line 161 of file N_ANP_AnalysisBase.h.

virtual void Xyce::Analysis::AnalysisBase::printStepHeader ( std::ostream &  os)
inlinevirtual
bool Xyce::Analysis::AnalysisBase::processFailedStep ( )

Definition at line 183 of file N_ANP_AnalysisBase.C.

bool Xyce::Analysis::AnalysisBase::processSuccessfulStep ( )

Definition at line 177 of file N_ANP_AnalysisBase.C.

void Xyce::Analysis::AnalysisBase::resetAll ( )

Definition at line 230 of file N_ANP_AnalysisBase.C.

bool Xyce::Analysis::AnalysisBase::resetForStepAnalysis ( )

Definition at line 211 of file N_ANP_AnalysisBase.C.

bool Xyce::Analysis::AnalysisBase::run ( )

Definition at line 152 of file N_ANP_AnalysisBase.C.

int Xyce::Analysis::AnalysisBase::saveLoopInfo ( )

Definition at line 246 of file N_ANP_AnalysisBase.C.

void Xyce::Analysis::AnalysisBase::setBeginningIntegrationFlag ( bool  bif)
inline

Definition at line 182 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::setDCOPOption ( const Util::Param &  param)

Definition at line 553 of file N_ANP_AnalysisBase.C.

void Xyce::Analysis::AnalysisBase::setInputOPFlag ( bool  initial_conditions_loaded)
inline

Definition at line 202 of file N_ANP_AnalysisBase.h.

void Xyce::Analysis::AnalysisBase::setIntegrationMethod ( int  im)
inline

Definition at line 192 of file N_ANP_AnalysisBase.h.

void Xyce::Analysis::AnalysisBase::setNOOP ( bool  noop)
inline

Definition at line 252 of file N_ANP_AnalysisBase.h.

void Xyce::Analysis::AnalysisBase::setStepNumber ( int  step)
inline

Definition at line 116 of file N_ANP_AnalysisBase.h.

void Xyce::Analysis::AnalysisBase::setTranStepNumber ( int  step)
inline

Definition at line 103 of file N_ANP_AnalysisBase.h.

virtual bool Xyce::Analysis::AnalysisBase::twoLevelStep ( )
inlinevirtual

Reimplemented in Xyce::Analysis::Transient, and Xyce::Analysis::DCSweep.

Definition at line 165 of file N_ANP_AnalysisBase.h.

Member Data Documentation

unsigned int Xyce::Analysis::AnalysisBase::baseIntegrationMethod_
protected

Current time-integration method flag.

Definition at line 271 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::beginningIntegration
protected

Definition at line 270 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::doubleDCOPFlag_
protected

true if doing a double-DCOP is possible.

Definition at line 283 of file N_ANP_AnalysisBase.h.

int Xyce::Analysis::AnalysisBase::doubleDCOPStep_
protected

current step in the DCOP loop.

Definition at line 284 of file N_ANP_AnalysisBase.h.

int Xyce::Analysis::AnalysisBase::firstDCOPStep_
protected

Definition at line 285 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::inputOPFlag_
private

true if starting from an initial condition.

Definition at line 267 of file N_ANP_AnalysisBase.h.

int Xyce::Analysis::AnalysisBase::lastDCOPStep_
protected

Definition at line 286 of file N_ANP_AnalysisBase.h.

const char* Xyce::Analysis::AnalysisBase::name_
private

Definition at line 265 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::NOOP_
protected

Definition at line 282 of file N_ANP_AnalysisBase.h.

std::vector<StatCounts> Xyce::Analysis::AnalysisBase::saveStatCountsVector_
protected

Definition at line 288 of file N_ANP_AnalysisBase.h.

StatCounts Xyce::Analysis::AnalysisBase::stats_

Definition at line 291 of file N_ANP_AnalysisBase.h.

unsigned int Xyce::Analysis::AnalysisBase::stepNumber
protected

Time-integration step number counter.

Definition at line 277 of file N_ANP_AnalysisBase.h.

unsigned int Xyce::Analysis::AnalysisBase::tranStepNumber
protected

Definition at line 280 of file N_ANP_AnalysisBase.h.


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