Xyce  6.1
Xyce::TimeIntg::OneStep Class Reference

#include <N_TIA_OneStep.h>

Inheritance diagram for Xyce::TimeIntg::OneStep:
Collaboration diagram for Xyce::TimeIntg::OneStep:

Public Member Functions

 OneStep (const TIAParams &tiaP, StepErrorControl &secTmp, DataStore &dsTmp)
 
 ~OneStep ()
 
const char * getName () const
 
void obtainPredictor ()
 
void obtainPredictorDeriv ()
 
void obtainCorrectorDeriv ()
 
void updateDerivsBlock (const std::list< IndexPair > &solGIDList, const std::list< IndexPair > &staGIDList)
 
double computeErrorEstimate () const
 
bool interpolateSolution (double timepoint, Linear::Vector *tmpSolVectorPtr, std::vector< Linear::Vector * > &historyVec)
 
bool interpolateMPDESolution (std::vector< double > &timepoint, Linear::Vector *tmpSolVectorPtr)
 
bool printOutputSolution (Analysis::OutputMgrAdapter &outputManagerAdapter, const TIAParams &tia_params, const double time, Linear::Vector *solnVecPtr, const bool doNotInterpolate, const std::vector< double > &outputInterpolationTimes, bool skipPrintLineOutput)
 
bool printMPDEOutputSolution (Analysis::OutputMgrAdapter &outputManagerAdapter, const double time, Linear::Vector *solnVecPtr, const std::vector< double > &fastTimes)
 
bool printWaMPDEOutputSolution (Analysis::OutputMgrAdapter &outputManagerAdapter, const double time, Linear::Vector *solnVecPtr, const std::vector< double > &fastTimes, const int phiGID)
 
bool saveOutputSolution (Analysis::OutputMgrAdapter &outputManagerAdapter, const TIAParams &tia_params, Linear::Vector *solnVecPtr, const double saveTime, const bool doNotInterpolate)
 
double computeExpoStepAdjust (double stepadjust)
 
int getOrder () const
 
int getNumberOfSteps () const
 
int getUsedOrder () const
 
int getNscsco () const
 
int getMaxOrder () const
 Return max order of method (this should obey user option maxorder) More...
 
void getInitialQnorm (TwoLevelError &tle) const
 
void getTwoLevelError (TwoLevelError &tle) const
 
void updateStateDeriv ()
 
void updateLeadCurrent ()
 
void updateLeadCurrentVec ()
 
double partialTimeDeriv () const
 
double getLeadingCoeff () const
 
void setLeadingCoeff (double &LC)
 
void obtainResidual ()
 
void obtainSensitivityResiduals ()
 
void loadFinalSensitivityDerivatives ()
 
void obtainJacobian ()
 
void updateHistory ()
 
void restoreHistory ()
 
void updateCoeffs ()
 
void initialize (const TIAParams &tia_params)
 
void setTwoLevelTimeInfo (const TimeIntInfo &tiInfo)
 
void rejectStep (const TIAParams &tia_params)
 
void rejectStepForHabanero ()
 
void completeStep (const TIAParams &tia_params)
 
- Public Member Functions inherited from Xyce::TimeIntg::TimeIntegrationMethod
virtual ~TimeIntegrationMethod ()
 
virtual void applyJacobian (const Linear::Vector &input, Linear::Vector &result)
 

Static Public Member Functions

static TimeIntegrationMethodfactory (const TIAParams &tia_params, StepErrorControl &step_error_control, DataStore &data_store)
 

Static Public Attributes

static const int type = 7
 
static const char * name = "Onestep: Trapezoidal"
 

Private Member Functions

void initializeSensitivities ()
 
void obtainSensitivityPredictors ()
 
void updateSensitivityHistory ()
 
void checkReduceOrder ()
 

Private Attributes

double timeStepForHistory2_
 
double timept_
 Keep track of last interpolation point in printMPDEOutputSolution. More...
 
DataStoreds
 Reference to the TIA data-store object. More...
 
StepErrorControlsec
 Reference to step-error control object. More...
 
double leadingCoeff
 Time-integration method leading coefficient value. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Xyce::TimeIntg::TimeIntegrationMethod
 TimeIntegrationMethod ()
 

Detailed Description

Definition at line 71 of file N_TIA_OneStep.h.

Constructor & Destructor Documentation

Xyce::TimeIntg::OneStep::OneStep ( const TIAParams tiaP,
StepErrorControl secTmp,
DataStore dsTmp 
)

Definition at line 107 of file N_TIA_OneStep.C.

Xyce::TimeIntg::OneStep::~OneStep ( )
inline

Definition at line 84 of file N_TIA_OneStep.h.

Member Function Documentation

void Xyce::TimeIntg::OneStep::checkReduceOrder ( )
private

Definition at line 1810 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::completeStep ( const TIAParams tia_params)
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 2032 of file N_TIA_OneStep.C.

double Xyce::TimeIntg::OneStep::computeErrorEstimate ( ) const
inlinevirtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 105 of file N_TIA_OneStep.h.

double Xyce::TimeIntg::OneStep::computeExpoStepAdjust ( double  stepadjust)
inlinevirtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 149 of file N_TIA_OneStep.h.

TimeIntegrationMethod * Xyce::TimeIntg::OneStep::factory ( const TIAParams tia_params,
StepErrorControl step_error_control,
DataStore data_store 
)
static

Definition at line 90 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::getInitialQnorm ( TwoLevelError tle) const
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 2322 of file N_TIA_OneStep.C.

double Xyce::TimeIntg::OneStep::getLeadingCoeff ( ) const
inlinevirtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 196 of file N_TIA_OneStep.h.

int Xyce::TimeIntg::OneStep::getMaxOrder ( ) const
inlinevirtual

Return max order of method (this should obey user option maxorder)

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 175 of file N_TIA_OneStep.h.

const char* Xyce::TimeIntg::OneStep::getName ( ) const
inlinevirtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 87 of file N_TIA_OneStep.h.

int Xyce::TimeIntg::OneStep::getNscsco ( ) const
inlinevirtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 170 of file N_TIA_OneStep.h.

int Xyce::TimeIntg::OneStep::getNumberOfSteps ( ) const
inlinevirtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 160 of file N_TIA_OneStep.h.

int Xyce::TimeIntg::OneStep::getOrder ( ) const
inlinevirtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 155 of file N_TIA_OneStep.h.

void Xyce::TimeIntg::OneStep::getTwoLevelError ( TwoLevelError tle) const
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 2335 of file N_TIA_OneStep.C.

int Xyce::TimeIntg::OneStep::getUsedOrder ( ) const
inlinevirtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 165 of file N_TIA_OneStep.h.

void Xyce::TimeIntg::OneStep::initialize ( const TIAParams tia_params)
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 1587 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::initializeSensitivities ( )
private

Definition at line 1745 of file N_TIA_OneStep.C.

bool Xyce::TimeIntg::OneStep::interpolateMPDESolution ( std::vector< double > &  timepoint,
Linear::Vector *  tmpSolVectorPtr 
)

Definition at line 540 of file N_TIA_OneStep.C.

bool Xyce::TimeIntg::OneStep::interpolateSolution ( double  timepoint,
Linear::Vector *  tmpSolVectorPtr,
std::vector< Linear::Vector * > &  historyVec 
)
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 499 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::loadFinalSensitivityDerivatives ( )
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 408 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::obtainCorrectorDeriv ( )
inlinevirtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 98 of file N_TIA_OneStep.h.

void Xyce::TimeIntg::OneStep::obtainJacobian ( )
virtual

Reimplemented from Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 444 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::obtainPredictor ( )
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 138 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::obtainPredictorDeriv ( )
inlinevirtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 95 of file N_TIA_OneStep.h.

void Xyce::TimeIntg::OneStep::obtainResidual ( )
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 256 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::obtainSensitivityPredictors ( )
private

Definition at line 242 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::obtainSensitivityResiduals ( )
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 335 of file N_TIA_OneStep.C.

double Xyce::TimeIntg::OneStep::partialTimeDeriv ( ) const
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 2356 of file N_TIA_OneStep.C.

bool Xyce::TimeIntg::OneStep::printMPDEOutputSolution ( Analysis::OutputMgrAdapter outputManagerAdapter,
const double  time,
Linear::Vector *  solnVecPtr,
const std::vector< double > &  fastTimes 
)
virtual

Reimplemented from Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 621 of file N_TIA_OneStep.C.

bool Xyce::TimeIntg::OneStep::printOutputSolution ( Analysis::OutputMgrAdapter outputManagerAdapter,
const TIAParams tia_params,
const double  time,
Linear::Vector *  solnVecPtr,
const bool  doNotInterpolate,
const std::vector< double > &  outputInterpolationTimes,
bool  skipPrintLineOutput 
)
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 1191 of file N_TIA_OneStep.C.

bool Xyce::TimeIntg::OneStep::printWaMPDEOutputSolution ( Analysis::OutputMgrAdapter outputManagerAdapter,
const double  time,
Linear::Vector *  solnVecPtr,
const std::vector< double > &  fastTimes,
const int  phiGID 
)
virtual

Reimplemented from Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 885 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::rejectStep ( const TIAParams tia_params)
virtual

11/11/05 erkeite: If the Newton solver fails, don't

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 1824 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::rejectStepForHabanero ( )
virtual

Reimplemented from Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 2018 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::restoreHistory ( )
virtual

Reimplemented from Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 1457 of file N_TIA_OneStep.C.

bool Xyce::TimeIntg::OneStep::saveOutputSolution ( Analysis::OutputMgrAdapter outputManagerAdapter,
const TIAParams tia_params,
Linear::Vector *  solnVecPtr,
const double  saveTime,
const bool  doNotInterpolate 
)
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 1274 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::setLeadingCoeff ( double &  LC)
inlinevirtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 202 of file N_TIA_OneStep.h.

void Xyce::TimeIntg::OneStep::setTwoLevelTimeInfo ( const TimeIntInfo tiInfo)
virtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 1775 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::updateCoeffs ( )
virtual

Reimplemented from Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 1501 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::updateDerivsBlock ( const std::list< IndexPair > &  solGIDList,
const std::list< IndexPair > &  staGIDList 
)
inlinevirtual

Implements Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 101 of file N_TIA_OneStep.h.

void Xyce::TimeIntg::OneStep::updateHistory ( )
virtual

Reimplemented from Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 1309 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::updateLeadCurrent ( )
virtual

Reimplemented from Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 2259 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::updateLeadCurrentVec ( )
virtual

Reimplemented from Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 2292 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::updateSensitivityHistory ( )
private

Definition at line 1414 of file N_TIA_OneStep.C.

void Xyce::TimeIntg::OneStep::updateStateDeriv ( )
virtual

Reimplemented from Xyce::TimeIntg::TimeIntegrationMethod.

Definition at line 2219 of file N_TIA_OneStep.C.

Member Data Documentation

DataStore& Xyce::TimeIntg::OneStep::ds
private

Reference to the TIA data-store object.

Definition at line 264 of file N_TIA_OneStep.h.

double Xyce::TimeIntg::OneStep::leadingCoeff
private

Time-integration method leading coefficient value.

Definition at line 266 of file N_TIA_OneStep.h.

const char * Xyce::TimeIntg::OneStep::name = "Onestep: Trapezoidal"
static

Definition at line 75 of file N_TIA_OneStep.h.

StepErrorControl& Xyce::TimeIntg::OneStep::sec
private

Reference to step-error control object.

Definition at line 265 of file N_TIA_OneStep.h.

double Xyce::TimeIntg::OneStep::timept_
private

Keep track of last interpolation point in printMPDEOutputSolution.

Definition at line 263 of file N_TIA_OneStep.h.

double Xyce::TimeIntg::OneStep::timeStepForHistory2_
private

Definition at line 262 of file N_TIA_OneStep.h.

const int Xyce::TimeIntg::OneStep::type = 7
static

Definition at line 74 of file N_TIA_OneStep.h.


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