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 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 bool getDCOPFlag () const =0
 
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 ()
 

Public Attributes

StatCounts stats_
 

Protected Member Functions

virtual bool doRun ()=0
 
virtual bool doInit ()=0
 
virtual bool doProcessSuccessfulStep ()=0
 
virtual bool doProcessFailedStep ()=0
 
virtual bool doFinish ()=0
 
virtual bool doHandlePredictor ()=0
 

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
 
std::vector< StatCountssaveStatCountsVector_
 

Private Member Functions

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

Private Attributes

const char * name_
 
bool NOOP_
 if true, disable DCOP More...
 
bool inputOPFlag_
 true if starting from an initial condition. More...
 
bool doubleDCOPEnabled_
 true if doing a double-DCOP is possible. More...
 
int doubleDCOPStep_
 current step in the DCOP loop. More...
 
int firstDCOPStep_
 
int lastDCOPStep_
 

Detailed Description

Definition at line 106 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 180 of file N_ANP_AnalysisBase.C.

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

Definition at line 222 of file N_ANP_AnalysisBase.h.

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

Definition at line 251 of file N_ANP_AnalysisBase.h.

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

Definition at line 187 of file N_ANP_AnalysisBase.h.

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

Reimplemented in Xyce::Analysis::HB.

Definition at line 199 of file N_ANP_AnalysisBase.h.

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

Definition at line 271 of file N_ANP_AnalysisBase.h.

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

Definition at line 261 of file N_ANP_AnalysisBase.h.

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

Definition at line 293 of file N_ANP_AnalysisBase.h.

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

Definition at line 234 of file N_ANP_AnalysisBase.h.

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

Definition at line 285 of file N_ANP_AnalysisBase.h.

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

Definition at line 127 of file N_ANP_AnalysisBase.h.

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

Definition at line 342 of file N_ANP_AnalysisBase.h.

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

Definition at line 330 of file N_ANP_AnalysisBase.h.

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

Definition at line 336 of file N_ANP_AnalysisBase.h.

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

Definition at line 122 of file N_ANP_AnalysisBase.h.

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

Definition at line 187 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 184 of file N_ANP_AnalysisBase.h.

void Xyce::Analysis::AnalysisBase::nextDCOPStep ( )
inline

Definition at line 227 of file N_ANP_AnalysisBase.h.

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 140 of file N_ANP_AnalysisBase.h.

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

Reimplemented in Xyce::Analysis::DCSweep.

Definition at line 282 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 178 of file N_ANP_AnalysisBase.h.

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

Definition at line 174 of file N_ANP_AnalysisBase.C.

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

Definition at line 168 of file N_ANP_AnalysisBase.C.

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

Definition at line 221 of file N_ANP_AnalysisBase.C.

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

Definition at line 202 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 237 of file N_ANP_AnalysisBase.C.

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

Definition at line 246 of file N_ANP_AnalysisBase.h.

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

Definition at line 337 of file N_ANP_AnalysisBase.C.

void Xyce::Analysis::AnalysisBase::setDoubleDCOPEnabled ( bool  enable)
inline

Definition at line 192 of file N_ANP_AnalysisBase.h.

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

Definition at line 266 of file N_ANP_AnalysisBase.h.

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

Definition at line 256 of file N_ANP_AnalysisBase.h.

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

Definition at line 239 of file N_ANP_AnalysisBase.h.

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

Definition at line 132 of file N_ANP_AnalysisBase.h.

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

Definition at line 117 of file N_ANP_AnalysisBase.h.

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

Member Data Documentation

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

Current time-integration method flag.

Definition at line 309 of file N_ANP_AnalysisBase.h.

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

Definition at line 308 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::doubleDCOPEnabled_
private

true if doing a double-DCOP is possible.

Definition at line 302 of file N_ANP_AnalysisBase.h.

int Xyce::Analysis::AnalysisBase::doubleDCOPStep_
private

current step in the DCOP loop.

Definition at line 303 of file N_ANP_AnalysisBase.h.

int Xyce::Analysis::AnalysisBase::firstDCOPStep_
private

Definition at line 304 of file N_ANP_AnalysisBase.h.

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

true if starting from an initial condition.

Definition at line 301 of file N_ANP_AnalysisBase.h.

int Xyce::Analysis::AnalysisBase::lastDCOPStep_
private

Definition at line 305 of file N_ANP_AnalysisBase.h.

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

Definition at line 299 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::NOOP_
private

if true, disable DCOP

Definition at line 300 of file N_ANP_AnalysisBase.h.

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

Definition at line 321 of file N_ANP_AnalysisBase.h.

StatCounts Xyce::Analysis::AnalysisBase::stats_

Definition at line 324 of file N_ANP_AnalysisBase.h.

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

Time-integration step number counter.

Definition at line 315 of file N_ANP_AnalysisBase.h.

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

Definition at line 318 of file N_ANP_AnalysisBase.h.


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