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

#include <N_NLS_NLParams.h>

Public Member Functions

 N_NLS_NLParams (AnalysisMode mode, N_IO_CmdParse &cp)
 
 N_NLS_NLParams (const N_NLS_NLParams &right)
 
 ~N_NLS_NLParams ()
 
N_NLS_NLParamsoperator= (const N_NLS_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 108 of file N_NLS_NLParams.h.

Constructor & Destructor Documentation

N_NLS_NLParams::N_NLS_NLParams ( AnalysisMode  mode,
N_IO_CmdParse &  cp 
)

Definition at line 73 of file N_NLS_NLParams.C.

N_NLS_NLParams::N_NLS_NLParams ( const N_NLS_NLParams right)

Definition at line 166 of file N_NLS_NLParams.C.

N_NLS_NLParams::~N_NLS_NLParams ( )

Definition at line 209 of file N_NLS_NLParams.C.

Member Function Documentation

void N_NLS_NLParams::clearPrintParamsFlag ( )
inline

Definition at line 345 of file N_NLS_NLParams.h.

double N_NLS_NLParams::getAbsTol ( ) const
inline

Definition at line 701 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::getConstraintBT ( ) const
inline

Definition at line 1072 of file N_NLS_NLParams.h.

int N_NLS_NLParams::getDebugLevel ( ) const
inline

Definition at line 1231 of file N_NLS_NLParams.h.

double N_NLS_NLParams::getDebugMaxTime ( ) const
inline

Definition at line 1388 of file N_NLS_NLParams.h.

int N_NLS_NLParams::getDebugMaxTimeStep ( ) const
inline

Definition at line 1310 of file N_NLS_NLParams.h.

double N_NLS_NLParams::getDebugMinTime ( ) const
inline

Definition at line 1349 of file N_NLS_NLParams.h.

int N_NLS_NLParams::getDebugMinTimeStep ( ) const
inline

Definition at line 1271 of file N_NLS_NLParams.h.

double N_NLS_NLParams::getDeltaXTol ( ) const
inline

Definition at line 582 of file N_NLS_NLParams.h.

Direction N_NLS_NLParams::getDirection ( ) const
inline

Definition at line 542 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::getEnforceDeviceConvFlag ( ) const
inline

Definition at line 912 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::getForcingFlag ( ) const
inline

Definition at line 872 of file N_NLS_NLParams.h.

double N_NLS_NLParams::getForcingTerm ( ) const
inline

Definition at line 952 of file N_NLS_NLParams.h.

double N_NLS_NLParams::getGlobalBTChange ( ) const
inline

Definition at line 1192 of file N_NLS_NLParams.h.

double N_NLS_NLParams::getGlobalBTMax ( ) const
inline

Definition at line 1111 of file N_NLS_NLParams.h.

double N_NLS_NLParams::getGlobalBTMin ( ) const
inline

Definition at line 1150 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::getLinearOpt ( ) const
inline

Definition at line 1032 of file N_NLS_NLParams.h.

unsigned N_NLS_NLParams::getMaxNewtonStep ( ) const
inline

Definition at line 781 of file N_NLS_NLParams.h.

unsigned N_NLS_NLParams::getMaxSearchStep ( ) const
inline

Definition at line 823 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::getMMFormat ( ) const
inline

Definition at line 1466 of file N_NLS_NLParams.h.

NLStrategy N_NLS_NLParams::getNLStrategy ( ) const
inline

Definition at line 429 of file N_NLS_NLParams.h.

int N_NLS_NLParams::getNormLevel ( ) const
inline

Definition at line 992 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::getPrintParamsFlag ( ) const
inline

Definition at line 358 of file N_NLS_NLParams.h.

double N_NLS_NLParams::getRelTol ( ) const
inline

Definition at line 741 of file N_NLS_NLParams.h.

double N_NLS_NLParams::getRHSTol ( ) const
inline

Definition at line 661 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::getScreenOutputFlag ( ) const
inline

Definition at line 1427 of file N_NLS_NLParams.h.

LineSearchMethod N_NLS_NLParams::getSearchMethod ( ) const
inline

Definition at line 499 of file N_NLS_NLParams.h.

double N_NLS_NLParams::getSmallUpdateTol ( ) const
inline

Definition at line 621 of file N_NLS_NLParams.h.

N_NLS_NLParams & N_NLS_NLParams::operator= ( const N_NLS_NLParams right)

Definition at line 439 of file N_NLS_NLParams.C.

void N_NLS_NLParams::printParams ( std::ostream &  os)

Definition at line 368 of file N_NLS_NLParams.C.

void N_NLS_NLParams::resetAbsTol ( )
inline

Definition at line 688 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetConstraintBT ( )
inline

Definition at line 1059 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetDebugLevel ( )
inline

Definition at line 1218 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetDebugMaxTime ( )
inline

Definition at line 1375 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetDebugMaxTimeStep ( )
inline

Definition at line 1297 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetDebugMinTime ( )
inline

Definition at line 1336 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetDebugMinTimeStep ( )
inline

Definition at line 1258 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetDeltaXTol ( )
inline

Definition at line 569 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetDirection ( )
inline

Definition at line 529 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetEnforceDeviceConvFlag ( )
inline

Definition at line 899 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetForcingFlag ( )
inline

Definition at line 859 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetForcingTerm ( )
inline

Definition at line 939 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetGlobalBTChange ( )
inline

Definition at line 1178 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetGlobalBTMax ( )
inline

Definition at line 1098 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetGlobalBTMin ( )
inline

Definition at line 1137 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetLinearOpt ( )
inline

Definition at line 1019 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetMaxNewtonStep ( )
inline

Definition at line 768 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetMaxSearchStep ( )
inline

Definition at line 809 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetMMFormat ( )
inline

Definition at line 1453 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetNLStrategy ( )
inline

Definition at line 416 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetNormLevel ( )
inline

Definition at line 979 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetRelTol ( )
inline

Definition at line 728 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetRHSTol ( )
inline

Definition at line 648 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetScreenOutputFlag ( )
inline

Definition at line 1414 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetSearchMethod ( )
inline

Definition at line 486 of file N_NLS_NLParams.h.

void N_NLS_NLParams::resetSmallUpdateTol ( )
inline

Definition at line 608 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setAbsTol ( double  Tolerance)
inline

Definition at line 674 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::setCmdLineOptions ( )

Definition at line 485 of file N_NLS_NLParams.C.

void N_NLS_NLParams::setConstraintBT ( bool  flag)
inline

Definition at line 1045 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setDebugLevel ( int  value)
inline

Definition at line 1205 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setDebugMaxTime ( double  value)
inline

Definition at line 1362 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setDebugMaxTimeStep ( int  value)
inline

Definition at line 1284 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setDebugMinTime ( double  value)
inline

Definition at line 1323 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setDebugMinTimeStep ( int  value)
inline

Definition at line 1245 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setDeltaXTol ( double  Tolerance)
inline

Definition at line 555 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setDirection ( Direction  value)
inline

Definition at line 512 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setEnforceDeviceConvFlag ( bool  flag)
inline

Definition at line 885 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setForcingFlag ( bool  flag)
inline

Definition at line 836 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setForcingTerm ( double  value)
inline

Definition at line 925 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setGlobalBTChange ( double  value)
inline

Definition at line 1164 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setGlobalBTMax ( double  value)
inline

Definition at line 1085 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setGlobalBTMin ( double  value)
inline

Definition at line 1124 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setLinearOpt ( bool  flag)
inline

Definition at line 1005 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setMaxNewtonStep ( unsigned  maxNewtonStep)
inline

Definition at line 754 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setMaxSearchStep ( unsigned  maxSearchStep)
inline

Definition at line 795 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setMMFormat ( bool  value)
inline

Definition at line 1440 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setNLStrategy ( NLStrategy  strategy)
inline

Definition at line 371 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setNLStrategy ( int  strategy)
inline

Definition at line 393 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setNormLevel ( int  level)
inline

Definition at line 965 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::setOptions ( const N_UTL_OptionBlock &  OB)

Definition at line 228 of file N_NLS_NLParams.C.

void N_NLS_NLParams::setPrintParamsFlag ( )
inline

Definition at line 330 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setRelTol ( double  Tolerance)
inline

Definition at line 714 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setRHSTol ( double  Tolerance)
inline

Definition at line 634 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setScreenOutputFlag ( bool  bval)
inline

Definition at line 1401 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setSearchMethod ( LineSearchMethod  method)
inline

Definition at line 442 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setSearchMethod ( int  method)
inline

Definition at line 464 of file N_NLS_NLParams.h.

void N_NLS_NLParams::setSmallUpdateTol ( double  Tolerance)
inline

Definition at line 595 of file N_NLS_NLParams.h.

Member Data Documentation

double N_NLS_NLParams::absTol_
protected

Definition at line 263 of file N_NLS_NLParams.h.

AnalysisMode N_NLS_NLParams::analysisMode_
protected

Definition at line 249 of file N_NLS_NLParams.h.

N_IO_CmdParse* N_NLS_NLParams::commandLine_
protected

Definition at line 246 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::constraintBT_
protected

Definition at line 300 of file N_NLS_NLParams.h.

int N_NLS_NLParams::debugLevel_
protected

Definition at line 311 of file N_NLS_NLParams.h.

double N_NLS_NLParams::debugMaxTime_
protected

Definition at line 315 of file N_NLS_NLParams.h.

int N_NLS_NLParams::debugMaxTimeStep_
protected

Definition at line 313 of file N_NLS_NLParams.h.

double N_NLS_NLParams::debugMinTime_
protected

Definition at line 314 of file N_NLS_NLParams.h.

int N_NLS_NLParams::debugMinTimeStep_
protected

Definition at line 312 of file N_NLS_NLParams.h.

double N_NLS_NLParams::deltaXTol_
protected

Definition at line 269 of file N_NLS_NLParams.h.

Direction N_NLS_NLParams::direction_
protected

Definition at line 260 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::enforceDeviceConvFlag_
protected

Definition at line 288 of file N_NLS_NLParams.h.

double N_NLS_NLParams::eta_
protected

Definition at line 291 of file N_NLS_NLParams.h.

double N_NLS_NLParams::globalBTChange_
protected

Definition at line 308 of file N_NLS_NLParams.h.

double N_NLS_NLParams::globalBTMax_
protected

Definition at line 306 of file N_NLS_NLParams.h.

double N_NLS_NLParams::globalBTMin_
protected

Definition at line 307 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::INForcingFlag_
protected

Definition at line 285 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::linearOptimization_
protected

Definition at line 297 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::matrixMarketFormat_
protected

Definition at line 317 of file N_NLS_NLParams.h.

unsigned N_NLS_NLParams::maxNewtonStep_
protected

Definition at line 279 of file N_NLS_NLParams.h.

unsigned N_NLS_NLParams::maxSearchStep_
protected

Definition at line 282 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::modeToggled_
protected

Definition at line 250 of file N_NLS_NLParams.h.

NLStrategy N_NLS_NLParams::nlStrategy_
protected

Definition at line 253 of file N_NLS_NLParams.h.

int N_NLS_NLParams::normLevel_
protected

Definition at line 294 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::printParamsFlag_
protected

Definition at line 243 of file N_NLS_NLParams.h.

double N_NLS_NLParams::relTol_
protected

Definition at line 266 of file N_NLS_NLParams.h.

double N_NLS_NLParams::RHSTol_
protected

Definition at line 276 of file N_NLS_NLParams.h.

bool N_NLS_NLParams::screenOutputFlag_
protected

Definition at line 316 of file N_NLS_NLParams.h.

LineSearchMethod N_NLS_NLParams::searchMethod_
protected

Definition at line 256 of file N_NLS_NLParams.h.

double N_NLS_NLParams::smallUpdateTol_
protected

Definition at line 273 of file N_NLS_NLParams.h.


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