Xyce  6.1
Xyce::Nonlinear::NLParams Class Reference

#include <N_NLS_NLParams.h>

Public Member Functions

 NLParams (AnalysisMode mode, const IO::CmdParse &cp)
 
 NLParams (const NLParams &right)
 
 ~NLParams ()
 
NLParamsoperator= (const NLParams &right)
 
void setPrintParamsFlag ()
 
void clearPrintParamsFlag ()
 
bool getPrintParamsFlag () const
 
bool setOptions (const Util::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 setMaskingFlag (bool bval)
 
void resetMaskingFlag ()
 
bool getMaskingFlag () const
 
void setMMFormat (bool value)
 
void resetMMFormat ()
 
bool getMMFormat () const
 

Static Public Member Functions

static void populateMetadata (IO::PkgOptionsMgr &options_manager)
 

Protected Attributes

bool printParamsFlag_
 
const 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_
 
bool maskingFlag_
 

Detailed Description

Definition at line 99 of file N_NLS_NLParams.h.

Constructor & Destructor Documentation

Xyce::Nonlinear::NLParams::NLParams ( AnalysisMode  mode,
const IO::CmdParse &  cp 
)

Definition at line 70 of file N_NLS_NLParams.C.

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

Definition at line 151 of file N_NLS_NLParams.C.

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

Definition at line 189 of file N_NLS_NLParams.C.

Member Function Documentation

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

Definition at line 343 of file N_NLS_NLParams.h.

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

Definition at line 699 of file N_NLS_NLParams.h.

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

Definition at line 1070 of file N_NLS_NLParams.h.

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

Definition at line 1230 of file N_NLS_NLParams.h.

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

Definition at line 1387 of file N_NLS_NLParams.h.

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

Definition at line 1309 of file N_NLS_NLParams.h.

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

Definition at line 1348 of file N_NLS_NLParams.h.

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

Definition at line 1270 of file N_NLS_NLParams.h.

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

Definition at line 580 of file N_NLS_NLParams.h.

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

Definition at line 540 of file N_NLS_NLParams.h.

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

Definition at line 910 of file N_NLS_NLParams.h.

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

Definition at line 870 of file N_NLS_NLParams.h.

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

Definition at line 950 of file N_NLS_NLParams.h.

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

Definition at line 1190 of file N_NLS_NLParams.h.

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

Definition at line 1109 of file N_NLS_NLParams.h.

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

Definition at line 1148 of file N_NLS_NLParams.h.

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

Definition at line 1030 of file N_NLS_NLParams.h.

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

Definition at line 1465 of file N_NLS_NLParams.h.

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

Definition at line 779 of file N_NLS_NLParams.h.

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

Definition at line 821 of file N_NLS_NLParams.h.

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

Definition at line 1504 of file N_NLS_NLParams.h.

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

Definition at line 427 of file N_NLS_NLParams.h.

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

Definition at line 990 of file N_NLS_NLParams.h.

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

Definition at line 356 of file N_NLS_NLParams.h.

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

Definition at line 739 of file N_NLS_NLParams.h.

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

Definition at line 659 of file N_NLS_NLParams.h.

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

Definition at line 1426 of file N_NLS_NLParams.h.

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

Definition at line 497 of file N_NLS_NLParams.h.

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

Definition at line 619 of file N_NLS_NLParams.h.

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

Definition at line 433 of file N_NLS_NLParams.C.

void Xyce::Nonlinear::NLParams::populateMetadata ( IO::PkgOptionsMgr &  options_manager)
static

Definition at line 490 of file N_NLS_NLParams.C.

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

Definition at line 359 of file N_NLS_NLParams.C.

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

Definition at line 686 of file N_NLS_NLParams.h.

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

Definition at line 1057 of file N_NLS_NLParams.h.

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

Definition at line 1217 of file N_NLS_NLParams.h.

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

Definition at line 1374 of file N_NLS_NLParams.h.

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

Definition at line 1296 of file N_NLS_NLParams.h.

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

Definition at line 1335 of file N_NLS_NLParams.h.

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

Definition at line 1257 of file N_NLS_NLParams.h.

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

Definition at line 567 of file N_NLS_NLParams.h.

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

Definition at line 527 of file N_NLS_NLParams.h.

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

Definition at line 897 of file N_NLS_NLParams.h.

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

Definition at line 857 of file N_NLS_NLParams.h.

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

Definition at line 937 of file N_NLS_NLParams.h.

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

Definition at line 1176 of file N_NLS_NLParams.h.

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

Definition at line 1096 of file N_NLS_NLParams.h.

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

Definition at line 1135 of file N_NLS_NLParams.h.

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

Definition at line 1017 of file N_NLS_NLParams.h.

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

Definition at line 1452 of file N_NLS_NLParams.h.

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

Definition at line 766 of file N_NLS_NLParams.h.

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

Definition at line 807 of file N_NLS_NLParams.h.

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

Definition at line 1491 of file N_NLS_NLParams.h.

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

Definition at line 414 of file N_NLS_NLParams.h.

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

Definition at line 977 of file N_NLS_NLParams.h.

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

Definition at line 726 of file N_NLS_NLParams.h.

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

Definition at line 646 of file N_NLS_NLParams.h.

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

Definition at line 1413 of file N_NLS_NLParams.h.

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

Definition at line 484 of file N_NLS_NLParams.h.

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

Definition at line 606 of file N_NLS_NLParams.h.

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

Definition at line 672 of file N_NLS_NLParams.h.

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

Definition at line 480 of file N_NLS_NLParams.C.

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

Definition at line 1043 of file N_NLS_NLParams.h.

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

Definition at line 1203 of file N_NLS_NLParams.h.

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

Definition at line 1361 of file N_NLS_NLParams.h.

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

Definition at line 1283 of file N_NLS_NLParams.h.

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

Definition at line 1322 of file N_NLS_NLParams.h.

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

Definition at line 1244 of file N_NLS_NLParams.h.

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

Definition at line 553 of file N_NLS_NLParams.h.

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

Definition at line 510 of file N_NLS_NLParams.h.

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

Definition at line 883 of file N_NLS_NLParams.h.

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

Definition at line 834 of file N_NLS_NLParams.h.

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

Definition at line 923 of file N_NLS_NLParams.h.

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

Definition at line 1162 of file N_NLS_NLParams.h.

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

Definition at line 1083 of file N_NLS_NLParams.h.

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

Definition at line 1122 of file N_NLS_NLParams.h.

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

Definition at line 1003 of file N_NLS_NLParams.h.

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

Definition at line 1439 of file N_NLS_NLParams.h.

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

Definition at line 752 of file N_NLS_NLParams.h.

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

Definition at line 793 of file N_NLS_NLParams.h.

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

Definition at line 1478 of file N_NLS_NLParams.h.

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

Definition at line 369 of file N_NLS_NLParams.h.

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

Definition at line 391 of file N_NLS_NLParams.h.

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

Definition at line 963 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::setOptions ( const Util::OptionBlock &  OB)

Definition at line 208 of file N_NLS_NLParams.C.

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

Definition at line 328 of file N_NLS_NLParams.h.

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

Definition at line 712 of file N_NLS_NLParams.h.

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

Definition at line 632 of file N_NLS_NLParams.h.

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

Definition at line 1400 of file N_NLS_NLParams.h.

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

Definition at line 440 of file N_NLS_NLParams.h.

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

Definition at line 462 of file N_NLS_NLParams.h.

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

Definition at line 593 of file N_NLS_NLParams.h.

Member Data Documentation

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

Definition at line 260 of file N_NLS_NLParams.h.

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

Definition at line 246 of file N_NLS_NLParams.h.

const IO::CmdParse* Xyce::Nonlinear::NLParams::commandLine_
protected

Definition at line 243 of file N_NLS_NLParams.h.

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

Definition at line 297 of file N_NLS_NLParams.h.

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

Definition at line 308 of file N_NLS_NLParams.h.

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

Definition at line 312 of file N_NLS_NLParams.h.

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

Definition at line 310 of file N_NLS_NLParams.h.

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

Definition at line 311 of file N_NLS_NLParams.h.

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

Definition at line 309 of file N_NLS_NLParams.h.

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

Definition at line 266 of file N_NLS_NLParams.h.

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

Definition at line 257 of file N_NLS_NLParams.h.

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

Definition at line 285 of file N_NLS_NLParams.h.

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

Definition at line 288 of file N_NLS_NLParams.h.

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

Definition at line 305 of file N_NLS_NLParams.h.

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

Definition at line 303 of file N_NLS_NLParams.h.

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

Definition at line 304 of file N_NLS_NLParams.h.

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

Definition at line 282 of file N_NLS_NLParams.h.

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

Definition at line 294 of file N_NLS_NLParams.h.

bool Xyce::Nonlinear::NLParams::maskingFlag_
protected

Definition at line 315 of file N_NLS_NLParams.h.

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

Definition at line 314 of file N_NLS_NLParams.h.

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

Definition at line 276 of file N_NLS_NLParams.h.

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

Definition at line 279 of file N_NLS_NLParams.h.

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

Definition at line 247 of file N_NLS_NLParams.h.

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

Definition at line 250 of file N_NLS_NLParams.h.

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

Definition at line 291 of file N_NLS_NLParams.h.

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

Definition at line 240 of file N_NLS_NLParams.h.

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

Definition at line 263 of file N_NLS_NLParams.h.

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

Definition at line 273 of file N_NLS_NLParams.h.

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

Definition at line 313 of file N_NLS_NLParams.h.

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

Definition at line 253 of file N_NLS_NLParams.h.

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

Definition at line 270 of file N_NLS_NLParams.h.


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