Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Xyce::Nonlinear::NLParams Class Reference

#include <N_NLS_NLParams.h>

Public Member Functions

 NLParams (AnalysisMode mode, N_IO_CmdParse &cp)
 
 NLParams (const NLParams &right)
 
 ~NLParams ()
 
NLParamsoperator= (const NLParams &right)
 
void setPrintParamsFlag ()
 
void clearPrintParamsFlag ()
 
bool getPrintParamsFlag () const
 
bool setOptions (const N_UTL_OptionBlock &OB)
 
bool setCmdLineOptions ()
 
void setNLStrategy (NLStrategy strategy)
 
void setNLStrategy (int strategy)
 
void resetNLStrategy ()
 
NLStrategy getNLStrategy () const
 
void setSearchMethod (LineSearchMethod method)
 
void setSearchMethod (int method)
 
void resetSearchMethod ()
 
LineSearchMethod getSearchMethod () const
 
void setDirection (Direction value)
 
void resetDirection ()
 
Direction getDirection () const
 
void setDeltaXTol (double Tolerance)
 
void resetDeltaXTol ()
 
double getDeltaXTol () const
 
void setSmallUpdateTol (double Tolerance)
 
void resetSmallUpdateTol ()
 
double getSmallUpdateTol () const
 
void setEnforceDeviceConvFlag (bool flag)
 
void resetEnforceDeviceConvFlag ()
 
bool getEnforceDeviceConvFlag () const
 
void setRHSTol (double Tolerance)
 
void resetRHSTol ()
 
double getRHSTol () const
 
void setAbsTol (double Tolerance)
 
void resetAbsTol ()
 
double getAbsTol () const
 
void setRelTol (double Tolerance)
 
void resetRelTol ()
 
double getRelTol () const
 
void setMaxNewtonStep (unsigned maxNewtonStep)
 
void resetMaxNewtonStep ()
 
unsigned getMaxNewtonStep () const
 
void setMaxSearchStep (unsigned maxSearchStep)
 
void resetMaxSearchStep ()
 
unsigned getMaxSearchStep () const
 
void setForcingFlag (bool flag)
 
void resetForcingFlag ()
 
bool getForcingFlag () const
 
void setForcingTerm (double value)
 
void resetForcingTerm ()
 
double getForcingTerm () const
 
void setNormLevel (int level)
 
void resetNormLevel ()
 
int getNormLevel () const
 
void setLinearOpt (bool flag)
 
void resetLinearOpt ()
 
bool getLinearOpt () const
 
void setConstraintBT (bool flag)
 
void resetConstraintBT ()
 
bool getConstraintBT () const
 
void setGlobalBTMax (double value)
 
void resetGlobalBTMax ()
 
double getGlobalBTMax () const
 
void setGlobalBTMin (double value)
 
void resetGlobalBTMin ()
 
double getGlobalBTMin () const
 
void setGlobalBTChange (double value)
 
void resetGlobalBTChange ()
 
double getGlobalBTChange () const
 
void printParams (std::ostream &os)
 
void setDebugLevel (int value)
 
void resetDebugLevel ()
 
int getDebugLevel () const
 
void setDebugMinTimeStep (int value)
 
void resetDebugMinTimeStep ()
 
int getDebugMinTimeStep () const
 
void setDebugMaxTimeStep (int value)
 
void resetDebugMaxTimeStep ()
 
int getDebugMaxTimeStep () const
 
void setDebugMinTime (double value)
 
void resetDebugMinTime ()
 
double getDebugMinTime () const
 
void setDebugMaxTime (double value)
 
void resetDebugMaxTime ()
 
double getDebugMaxTime () const
 
void setScreenOutputFlag (bool bval)
 
void resetScreenOutputFlag ()
 
bool getScreenOutputFlag () const
 
void setMMFormat (bool value)
 
void resetMMFormat ()
 
bool getMMFormat () const
 

Protected Attributes

bool printParamsFlag_
 
N_IO_CmdParse * commandLine_
 
AnalysisMode analysisMode_
 
bool modeToggled_
 
NLStrategy nlStrategy_
 
LineSearchMethod searchMethod_
 
Direction direction_
 
double absTol_
 
double relTol_
 
double deltaXTol_
 
double smallUpdateTol_
 
double RHSTol_
 
unsigned maxNewtonStep_
 
unsigned maxSearchStep_
 
bool INForcingFlag_
 
bool enforceDeviceConvFlag_
 
double eta_
 
int normLevel_
 
bool linearOptimization_
 
bool constraintBT_
 
double globalBTMax_
 
double globalBTMin_
 
double globalBTChange_
 
int debugLevel_
 
int debugMinTimeStep_
 
int debugMaxTimeStep_
 
double debugMinTime_
 
double debugMaxTime_
 
bool screenOutputFlag_
 
bool matrixMarketFormat_
 

Detailed Description

Definition at line 111 of file N_NLS_NLParams.h.

Constructor & Destructor Documentation

Xyce::Nonlinear::NLParams::NLParams ( AnalysisMode  mode,
N_IO_CmdParse &  cp 
)

Definition at line 76 of file N_NLS_NLParams.C.

Xyce::Nonlinear::NLParams::NLParams ( const NLParams right)

Definition at line 169 of file N_NLS_NLParams.C.

Xyce::Nonlinear::NLParams::~NLParams ( )

Definition at line 212 of file N_NLS_NLParams.C.

Member Function Documentation

void Xyce::Nonlinear::NLParams::clearPrintParamsFlag ( )
inline

Definition at line 348 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::getAbsTol ( ) const
inline

Definition at line 704 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::getConstraintBT ( ) const
inline

Definition at line 1075 of file N_NLS_NLParams.h.

int Xyce::Nonlinear::NLParams::getDebugLevel ( ) const
inline

Definition at line 1234 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::getDebugMaxTime ( ) const
inline

Definition at line 1391 of file N_NLS_NLParams.h.

int Xyce::Nonlinear::NLParams::getDebugMaxTimeStep ( ) const
inline

Definition at line 1313 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::getDebugMinTime ( ) const
inline

Definition at line 1352 of file N_NLS_NLParams.h.

int Xyce::Nonlinear::NLParams::getDebugMinTimeStep ( ) const
inline

Definition at line 1274 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::getDeltaXTol ( ) const
inline

Definition at line 585 of file N_NLS_NLParams.h.

Direction Xyce::Nonlinear::NLParams::getDirection ( ) const
inline

Definition at line 545 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::getEnforceDeviceConvFlag ( ) const
inline

Definition at line 915 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::getForcingFlag ( ) const
inline

Definition at line 875 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::getForcingTerm ( ) const
inline

Definition at line 955 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::getGlobalBTChange ( ) const
inline

Definition at line 1195 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::getGlobalBTMax ( ) const
inline

Definition at line 1114 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::getGlobalBTMin ( ) const
inline

Definition at line 1153 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::getLinearOpt ( ) const
inline

Definition at line 1035 of file N_NLS_NLParams.h.

unsigned Xyce::Nonlinear::NLParams::getMaxNewtonStep ( ) const
inline

Definition at line 784 of file N_NLS_NLParams.h.

unsigned Xyce::Nonlinear::NLParams::getMaxSearchStep ( ) const
inline

Definition at line 826 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::getMMFormat ( ) const
inline

Definition at line 1469 of file N_NLS_NLParams.h.

NLStrategy Xyce::Nonlinear::NLParams::getNLStrategy ( ) const
inline

Definition at line 432 of file N_NLS_NLParams.h.

int Xyce::Nonlinear::NLParams::getNormLevel ( ) const
inline

Definition at line 995 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::getPrintParamsFlag ( ) const
inline

Definition at line 361 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::getRelTol ( ) const
inline

Definition at line 744 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::getRHSTol ( ) const
inline

Definition at line 664 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::getScreenOutputFlag ( ) const
inline

Definition at line 1430 of file N_NLS_NLParams.h.

LineSearchMethod Xyce::Nonlinear::NLParams::getSearchMethod ( ) const
inline

Definition at line 502 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::getSmallUpdateTol ( ) const
inline

Definition at line 624 of file N_NLS_NLParams.h.

NLParams & Xyce::Nonlinear::NLParams::operator= ( const NLParams right)

Definition at line 442 of file N_NLS_NLParams.C.

void Xyce::Nonlinear::NLParams::printParams ( std::ostream &  os)

Definition at line 371 of file N_NLS_NLParams.C.

void Xyce::Nonlinear::NLParams::resetAbsTol ( )
inline

Definition at line 691 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetConstraintBT ( )
inline

Definition at line 1062 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetDebugLevel ( )
inline

Definition at line 1221 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetDebugMaxTime ( )
inline

Definition at line 1378 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetDebugMaxTimeStep ( )
inline

Definition at line 1300 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetDebugMinTime ( )
inline

Definition at line 1339 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetDebugMinTimeStep ( )
inline

Definition at line 1261 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetDeltaXTol ( )
inline

Definition at line 572 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetDirection ( )
inline

Definition at line 532 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetEnforceDeviceConvFlag ( )
inline

Definition at line 902 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetForcingFlag ( )
inline

Definition at line 862 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetForcingTerm ( )
inline

Definition at line 942 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetGlobalBTChange ( )
inline

Definition at line 1181 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetGlobalBTMax ( )
inline

Definition at line 1101 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetGlobalBTMin ( )
inline

Definition at line 1140 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetLinearOpt ( )
inline

Definition at line 1022 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetMaxNewtonStep ( )
inline

Definition at line 771 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetMaxSearchStep ( )
inline

Definition at line 812 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetMMFormat ( )
inline

Definition at line 1456 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetNLStrategy ( )
inline

Definition at line 419 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetNormLevel ( )
inline

Definition at line 982 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetRelTol ( )
inline

Definition at line 731 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetRHSTol ( )
inline

Definition at line 651 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetScreenOutputFlag ( )
inline

Definition at line 1417 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetSearchMethod ( )
inline

Definition at line 489 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::resetSmallUpdateTol ( )
inline

Definition at line 611 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setAbsTol ( double  Tolerance)
inline

Definition at line 677 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::setCmdLineOptions ( )

Definition at line 488 of file N_NLS_NLParams.C.

void Xyce::Nonlinear::NLParams::setConstraintBT ( bool  flag)
inline

Definition at line 1048 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setDebugLevel ( int  value)
inline

Definition at line 1208 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setDebugMaxTime ( double  value)
inline

Definition at line 1365 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setDebugMaxTimeStep ( int  value)
inline

Definition at line 1287 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setDebugMinTime ( double  value)
inline

Definition at line 1326 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setDebugMinTimeStep ( int  value)
inline

Definition at line 1248 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setDeltaXTol ( double  Tolerance)
inline

Definition at line 558 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setDirection ( Direction  value)
inline

Definition at line 515 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setEnforceDeviceConvFlag ( bool  flag)
inline

Definition at line 888 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setForcingFlag ( bool  flag)
inline

Definition at line 839 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setForcingTerm ( double  value)
inline

Definition at line 928 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setGlobalBTChange ( double  value)
inline

Definition at line 1167 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setGlobalBTMax ( double  value)
inline

Definition at line 1088 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setGlobalBTMin ( double  value)
inline

Definition at line 1127 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setLinearOpt ( bool  flag)
inline

Definition at line 1008 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setMaxNewtonStep ( unsigned  maxNewtonStep)
inline

Definition at line 757 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setMaxSearchStep ( unsigned  maxSearchStep)
inline

Definition at line 798 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setMMFormat ( bool  value)
inline

Definition at line 1443 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setNLStrategy ( NLStrategy  strategy)
inline

Definition at line 374 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setNLStrategy ( int  strategy)
inline

Definition at line 396 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setNormLevel ( int  level)
inline

Definition at line 968 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::setOptions ( const N_UTL_OptionBlock &  OB)

Definition at line 231 of file N_NLS_NLParams.C.

void Xyce::Nonlinear::NLParams::setPrintParamsFlag ( )
inline

Definition at line 333 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setRelTol ( double  Tolerance)
inline

Definition at line 717 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setRHSTol ( double  Tolerance)
inline

Definition at line 637 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setScreenOutputFlag ( bool  bval)
inline

Definition at line 1404 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setSearchMethod ( LineSearchMethod  method)
inline

Definition at line 445 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setSearchMethod ( int  method)
inline

Definition at line 467 of file N_NLS_NLParams.h.

void Xyce::Nonlinear::NLParams::setSmallUpdateTol ( double  Tolerance)
inline

Definition at line 598 of file N_NLS_NLParams.h.

Member Data Documentation

double Xyce::Nonlinear::NLParams::absTol_
protected

Definition at line 266 of file N_NLS_NLParams.h.

AnalysisMode Xyce::Nonlinear::NLParams::analysisMode_
protected

Definition at line 252 of file N_NLS_NLParams.h.

N_IO_CmdParse* Xyce::Nonlinear::NLParams::commandLine_
protected

Definition at line 249 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::constraintBT_
protected

Definition at line 303 of file N_NLS_NLParams.h.

int Xyce::Nonlinear::NLParams::debugLevel_
protected

Definition at line 314 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::debugMaxTime_
protected

Definition at line 318 of file N_NLS_NLParams.h.

int Xyce::Nonlinear::NLParams::debugMaxTimeStep_
protected

Definition at line 316 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::debugMinTime_
protected

Definition at line 317 of file N_NLS_NLParams.h.

int Xyce::Nonlinear::NLParams::debugMinTimeStep_
protected

Definition at line 315 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::deltaXTol_
protected

Definition at line 272 of file N_NLS_NLParams.h.

Direction Xyce::Nonlinear::NLParams::direction_
protected

Definition at line 263 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::enforceDeviceConvFlag_
protected

Definition at line 291 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::eta_
protected

Definition at line 294 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::globalBTChange_
protected

Definition at line 311 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::globalBTMax_
protected

Definition at line 309 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::globalBTMin_
protected

Definition at line 310 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::INForcingFlag_
protected

Definition at line 288 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::linearOptimization_
protected

Definition at line 300 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::matrixMarketFormat_
protected

Definition at line 320 of file N_NLS_NLParams.h.

unsigned Xyce::Nonlinear::NLParams::maxNewtonStep_
protected

Definition at line 282 of file N_NLS_NLParams.h.

unsigned Xyce::Nonlinear::NLParams::maxSearchStep_
protected

Definition at line 285 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::modeToggled_
protected

Definition at line 253 of file N_NLS_NLParams.h.

NLStrategy Xyce::Nonlinear::NLParams::nlStrategy_
protected

Definition at line 256 of file N_NLS_NLParams.h.

int Xyce::Nonlinear::NLParams::normLevel_
protected

Definition at line 297 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::printParamsFlag_
protected

Definition at line 246 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::relTol_
protected

Definition at line 269 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::RHSTol_
protected

Definition at line 279 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::screenOutputFlag_
protected

Definition at line 319 of file N_NLS_NLParams.h.

LineSearchMethod Xyce::Nonlinear::NLParams::searchMethod_
protected

Definition at line 259 of file N_NLS_NLParams.h.

double Xyce::Nonlinear::NLParams::smallUpdateTol_
protected

Definition at line 276 of file N_NLS_NLParams.h.


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