Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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)
 
virtual ~AnalysisBase ()
 
virtual bool setAnalysisParams (const Util::OptionBlock &paramsBlock)
 
virtual bool outputFailureStats ()
 
virtual void setParamsWithOutputMgrAdapter (OutputMgrAdapter &outputManagerAdapter)
 
virtual int getStepIter ()
 
virtual int getStepNumber ()
 
virtual void setStepNumber (int step)
 
virtual void setTranStepNumber (int step)
 
virtual int getTranStepNumber ()
 
virtual void setSensFlag ()
 
virtual bool getDCOPFlag ()=0
 
virtual bool run ()=0
 
virtual bool init ()=0
 
virtual bool loopProcess ()=0
 
virtual bool processSuccessfulStep ()=0
 
virtual bool processFailedStep ()=0
 
virtual bool finish ()=0
 
virtual bool handlePredictor ()=0
 
virtual void printStepHeader (std::ostream &os)
 
virtual void printProgress (std::ostream &os)
 
virtual void preStepDetails (double maxTimeStepFromHabanero)
 
virtual bool mixedSignalStep ()
 
virtual bool finalizeStep ()
 
virtual bool twoLevelStep ()
 
virtual bool isAnalysis (int analysis_type)
 
virtual bool printLoopInfo (int start, int finish)
 
virtual void setBeginningIntegrationFlag (bool bif)
 
virtual bool getBeginningIntegrationFlag ()
 
virtual void setIntegrationMethod (int im)
 
virtual unsigned int getIntegrationMethod ()
 
virtual bool getInputOPFlag ()
 
bool resetForStepAnalysis ()
 
void resetAll ()
 
int saveLoopInfo ()
 
void gatherStepStatistics_ ()
 
double getTotalLinearSolutionTime () const
 
double getTotalResidualLoadTime () const
 
double getTotalJacobianLoadTime () const
 
bool getDoubleDCOPEnabled ()
 
virtual int getDoubleDCOPStep ()
 
bool firstDoubleDCOPStep_ ()
 
const StatCountsgetStatCounts (int index=-1) const
 

Public Attributes

StatCounts stats_
 

Protected Attributes

AnalysisManageranalysisManager_
 
N_LAS_System & linearSystem_
 
N_LOA_Loader & loader_
 
N_LOA_Loader & nonlinearEquationLoader_
 
Nonlinear::ManagernonlinearSolverManager_
 
OutputMgrAdapteroutputManagerAdapter_
 
N_TIA_StepErrorControl *& stepErrorControl_
 Ref to pointer since AnalysisManager will change pointer. More...
 
N_TIA_WorkingIntegrationMethod *& workingIntgMethod_
 Ref to pointer since AnalysisManager will change pointer. More...
 
N_TIA_TIAParamstiaParams_
 
bool beginningIntegration
 
unsigned int integrationMethod_
 Current time-integration method flag. More...
 
unsigned int stepNumber
 Time-integration step number counter. More...
 
unsigned int tranStepNumber
 
bool doubleDCOPFlag_
 true if doing a double-DCOP is possible. More...
 
int doubleDCOPStep_
 current step in the DCOP loop. More...
 
bool sensFlag_
 
bool inputOPFlag_
 true if starting from an initial condition. More...
 
std::vector< StatCountssaveStatCountsVector_
 

Detailed Description

Definition at line 93 of file N_ANP_AnalysisBase.h.

Constructor & Destructor Documentation

Xyce::Analysis::AnalysisBase::AnalysisBase ( AnalysisManager analysis_manager)

Definition at line 119 of file N_ANP_AnalysisBase.C.

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

Definition at line 149 of file N_ANP_AnalysisBase.C.

Member Function Documentation

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

Reimplemented in Xyce::Analysis::Transient.

Definition at line 150 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::firstDoubleDCOPStep_ ( )

Definition at line 308 of file N_ANP_AnalysisBase.C.

void Xyce::Analysis::AnalysisBase::gatherStepStatistics_ ( )

Definition at line 271 of file N_ANP_AnalysisBase.C.

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

Reimplemented in Xyce::Analysis::HB.

Definition at line 164 of file N_ANP_AnalysisBase.h.

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

Definition at line 250 of file N_ANP_AnalysisBase.h.

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

Reimplemented in Xyce::Analysis::HB.

Definition at line 256 of file N_ANP_AnalysisBase.h.

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

Definition at line 169 of file N_ANP_AnalysisBase.h.

virtual unsigned int Xyce::Analysis::AnalysisBase::getIntegrationMethod ( )
inlinevirtual

Reimplemented in Xyce::Analysis::HB.

Definition at line 167 of file N_ANP_AnalysisBase.h.

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

Definition at line 186 of file N_ANP_AnalysisBase.h.

virtual int Xyce::Analysis::AnalysisBase::getStepIter ( )
inlinevirtual

Reimplemented in Xyce::Analysis::Step.

Definition at line 105 of file N_ANP_AnalysisBase.h.

virtual int Xyce::Analysis::AnalysisBase::getStepNumber ( )
inlinevirtual

Reimplemented in Xyce::Analysis::HB.

Definition at line 106 of file N_ANP_AnalysisBase.h.

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

Definition at line 244 of file N_ANP_AnalysisBase.h.

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

Definition at line 232 of file N_ANP_AnalysisBase.h.

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

Definition at line 238 of file N_ANP_AnalysisBase.h.

virtual int Xyce::Analysis::AnalysisBase::getTranStepNumber ( )
inlinevirtual

Definition at line 110 of file N_ANP_AnalysisBase.h.

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

Reimplemented in Xyce::Analysis::HB.

Definition at line 159 of file N_ANP_AnalysisBase.h.

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

Reimplemented in Xyce::Analysis::Transient.

Definition at line 149 of file N_ANP_AnalysisBase.h.

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

Definition at line 101 of file N_ANP_AnalysisBase.h.

virtual void Xyce::Analysis::AnalysisBase::preStepDetails ( double  maxTimeStepFromHabanero)
inlinevirtual

Reimplemented in Xyce::Analysis::Transient.

Definition at line 148 of file N_ANP_AnalysisBase.h.

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

Reimplemented in Xyce::Analysis::DCSweep.

Definition at line 241 of file N_ANP_AnalysisBase.C.

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

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

Definition at line 144 of file N_ANP_AnalysisBase.h.

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

Definition at line 180 of file N_ANP_AnalysisBase.C.

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

Definition at line 161 of file N_ANP_AnalysisBase.C.

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

Definition at line 196 of file N_ANP_AnalysisBase.C.

virtual bool Xyce::Analysis::AnalysisBase::setAnalysisParams ( const Util::OptionBlock &  paramsBlock)
inlinevirtual

Reimplemented in Xyce::Analysis::Transient.

Definition at line 100 of file N_ANP_AnalysisBase.h.

virtual void Xyce::Analysis::AnalysisBase::setBeginningIntegrationFlag ( bool  bif)
inlinevirtual

Reimplemented in Xyce::Analysis::HB.

Definition at line 163 of file N_ANP_AnalysisBase.h.

virtual void Xyce::Analysis::AnalysisBase::setIntegrationMethod ( int  im)
inlinevirtual

Reimplemented in Xyce::Analysis::HB.

Definition at line 166 of file N_ANP_AnalysisBase.h.

virtual void Xyce::Analysis::AnalysisBase::setParamsWithOutputMgrAdapter ( OutputMgrAdapter outputManagerAdapter)
inlinevirtual

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

Definition at line 103 of file N_ANP_AnalysisBase.h.

virtual void Xyce::Analysis::AnalysisBase::setSensFlag ( )
inlinevirtual

Definition at line 112 of file N_ANP_AnalysisBase.h.

virtual void Xyce::Analysis::AnalysisBase::setStepNumber ( int  step)
inlinevirtual

Reimplemented in Xyce::Analysis::HB.

Definition at line 107 of file N_ANP_AnalysisBase.h.

virtual void Xyce::Analysis::AnalysisBase::setTranStepNumber ( int  step)
inlinevirtual

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

Member Data Documentation

AnalysisManager& Xyce::Analysis::AnalysisBase::analysisManager_
protected

Definition at line 195 of file N_ANP_AnalysisBase.h.

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

Definition at line 205 of file N_ANP_AnalysisBase.h.

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

true if doing a double-DCOP is possible.

Definition at line 217 of file N_ANP_AnalysisBase.h.

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

current step in the DCOP loop.

Definition at line 218 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::inputOPFlag_
protected

true if starting from an initial condition.

Definition at line 221 of file N_ANP_AnalysisBase.h.

unsigned int Xyce::Analysis::AnalysisBase::integrationMethod_
protected

Current time-integration method flag.

Definition at line 207 of file N_ANP_AnalysisBase.h.

N_LAS_System& Xyce::Analysis::AnalysisBase::linearSystem_
protected

Definition at line 196 of file N_ANP_AnalysisBase.h.

N_LOA_Loader& Xyce::Analysis::AnalysisBase::loader_
protected

Definition at line 197 of file N_ANP_AnalysisBase.h.

N_LOA_Loader& Xyce::Analysis::AnalysisBase::nonlinearEquationLoader_
protected

Definition at line 198 of file N_ANP_AnalysisBase.h.

Nonlinear::Manager& Xyce::Analysis::AnalysisBase::nonlinearSolverManager_
protected

Definition at line 199 of file N_ANP_AnalysisBase.h.

OutputMgrAdapter& Xyce::Analysis::AnalysisBase::outputManagerAdapter_
protected

Definition at line 200 of file N_ANP_AnalysisBase.h.

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

Definition at line 223 of file N_ANP_AnalysisBase.h.

bool Xyce::Analysis::AnalysisBase::sensFlag_
protected

Definition at line 220 of file N_ANP_AnalysisBase.h.

StatCounts Xyce::Analysis::AnalysisBase::stats_

Definition at line 226 of file N_ANP_AnalysisBase.h.

N_TIA_StepErrorControl*& Xyce::Analysis::AnalysisBase::stepErrorControl_
protected

Ref to pointer since AnalysisManager will change pointer.

Definition at line 201 of file N_ANP_AnalysisBase.h.

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

Time-integration step number counter.

Definition at line 214 of file N_ANP_AnalysisBase.h.

N_TIA_TIAParams& Xyce::Analysis::AnalysisBase::tiaParams_
protected

Definition at line 203 of file N_ANP_AnalysisBase.h.

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

Definition at line 215 of file N_ANP_AnalysisBase.h.

N_TIA_WorkingIntegrationMethod*& Xyce::Analysis::AnalysisBase::workingIntgMethod_
protected

Ref to pointer since AnalysisManager will change pointer.

Definition at line 202 of file N_ANP_AnalysisBase.h.


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