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

#include <N_NLS_NOX_ParameterSet.h>

Public Member Functions

 ParameterSet (Xyce::Nonlinear::AnalysisMode mode)
 
 ~ParameterSet ()
 
bool setOptions (const N_UTL_OptionBlock &OB)
 
bool setLocaOptions (const N_UTL_OptionBlock &OB, bool saveCopy=true)
 
bool applySavedLocaOptions ()
 
bool setOutputOptions (int myPID, int outputProcess)
 
bool createStatusTests (N_LAS_Vector **currSolnVectorPtrPtr, N_LOA_Loader &l, std::vector< char > &varTypeVec)
 
Teuchos::RefCountPtr
< NOX::StatusTest::Generic > 
getStatusTests ()
 
bool getVectorParam (const std::string &, int, double &)
 
bool getVectorParam (const std::string &, int, std::string &)
 
int getVectorParamSize (const std::string &vectorName)
 
int getStatusTestReturnCode () const
 
void setStatusTestReturnCodes (const N_NLS_ReturnCodes &retCodesTmp)
 
Teuchos::RefCountPtr
< Teuchos::ParameterList > 
getAllParams ()
 
Teuchos::RefCountPtr
< Teuchos::ParameterList > 
getNoxParams ()
 
Teuchos::RefCountPtr
< Teuchos::ParameterList > 
getLocaParams ()
 
Teuchos::RefCountPtr
< Teuchos::ParameterList > 
getDebugParams ()
 
int getNoxSolverType () const
 
void setNoxSolverType (int type)
 
bool getContinuationSpecifiedFlag () const
 
int getDebugLevel () const
 
int getDebugMinTimeStep () const
 
int getDebugMaxTimeStep () const
 
double getDebugMinTime () const
 
double getDebugMaxTime () const
 
bool getScreenOutputFlag () const
 
double getMaxNormF () const
 
int getMaxNormFindex () const
 
bool isParamsSet () const
 
void set_gstepping_min_value (double val)
 
void set_gstepping_minimum_conductance (double val)
 
Teuchos::RefCountPtr
< N_NLS_NOX::AugmentLinSys
createAugmentLinearSystem (N_LAS_System *ls) const
 
Teuchos::RefCountPtr
< N_NLS_NOX::AugmentLinSys
createAugmentLinearSystem (N_LAS_System *ls, Xyce::NodeNamePairMap &op, const Xyce::NodeNamePairMap &allNodes) const
 
Teuchos::RefCountPtr
< N_NLS_NOX::AugmentLinSys
createAugmentLinearSystem (N_LAS_System *ls, Xyce::NodeNamePairMap &op, bool gminStepping=false) const
 

Private Types

enum  VoltageListType {
  VLT_DOFS,
  VLT_Node,
  VLT_None
}
 

Private Member Functions

void unsupportedOption_ (const std::string &tag)
 
bool parseOptionBlock_ (const N_UTL_OptionBlock &OB)
 

Private Attributes

Teuchos::RefCountPtr
< Teuchos::ParameterList > 
allParams_
 
Teuchos::ParameterList & noxParams_
 
Teuchos::ParameterList & locaParams_
 
Teuchos::ParameterList & debugParams_
 
Teuchos::ParameterList statusTestParams_
 
std::map< std::string,
std::vector< N_UTL_Param > > 
vectorParams
 
Teuchos::RefCountPtr
< NOX::StatusTest::Combo > 
comboPtr_
 
std::vector
< Teuchos::RefCountPtr
< NOX::StatusTest::Generic > > 
tests_
 
bool isParamsSet_
 
bool isStatusTestsSet_
 
bool continuationSpecified_
 
Xyce::Nonlinear::AnalysisMode mode_
 
int noxSolver
 
VoltageListType voltageListType_
 
double voltageScaleFactor_
 
double gstepping_min_value_
 
double gstepping_minimum_conductance_
 
bool savedLocaOptions_
 
N_UTL_OptionBlock savedLocaOB_
 
int debugLevel_
 
int debugMinTimeStep_
 
int debugMaxTimeStep_
 
double debugMinTime_
 
double debugMaxTime_
 
bool screenOutputFlag_
 

Detailed Description

Definition at line 84 of file N_NLS_NOX_ParameterSet.h.

Member Enumeration Documentation

Enumerator
VLT_DOFS 
VLT_Node 
VLT_None 

Definition at line 235 of file N_NLS_NOX_ParameterSet.h.

Constructor & Destructor Documentation

N_NLS_NOX::ParameterSet::ParameterSet ( Xyce::Nonlinear::AnalysisMode  mode)

Definition at line 102 of file N_NLS_NOX_ParameterSet.C.

N_NLS_NOX::ParameterSet::~ParameterSet ( )

Definition at line 230 of file N_NLS_NOX_ParameterSet.C.

Member Function Documentation

bool N_NLS_NOX::ParameterSet::applySavedLocaOptions ( )
inline

Definition at line 92 of file N_NLS_NOX_ParameterSet.h.

Teuchos::RefCountPtr< N_NLS_NOX::AugmentLinSys > N_NLS_NOX::ParameterSet::createAugmentLinearSystem ( N_LAS_System *  ls) const

Definition at line 1549 of file N_NLS_NOX_ParameterSet.C.

Teuchos::RefCountPtr< N_NLS_NOX::AugmentLinSys > N_NLS_NOX::ParameterSet::createAugmentLinearSystem ( N_LAS_System *  ls,
Xyce::NodeNamePairMap &  op,
const Xyce::NodeNamePairMap &  allNodes 
) const

Definition at line 1615 of file N_NLS_NOX_ParameterSet.C.

Teuchos::RefCountPtr< N_NLS_NOX::AugmentLinSys > N_NLS_NOX::ParameterSet::createAugmentLinearSystem ( N_LAS_System *  ls,
Xyce::NodeNamePairMap &  op,
bool  gminStepping = false 
) const

Definition at line 1644 of file N_NLS_NOX_ParameterSet.C.

bool N_NLS_NOX::ParameterSet::createStatusTests ( N_LAS_Vector **  currSolnVectorPtrPtr,
N_LOA_Loader &  l,
std::vector< char > &  varTypeVec 
)

Definition at line 282 of file N_NLS_NOX_ParameterSet.C.

Teuchos::RefCountPtr< Teuchos::ParameterList > N_NLS_NOX::ParameterSet::getAllParams ( )

Definition at line 497 of file N_NLS_NOX_ParameterSet.C.

bool N_NLS_NOX::ParameterSet::getContinuationSpecifiedFlag ( ) const
inline

Definition at line 125 of file N_NLS_NOX_ParameterSet.h.

int N_NLS_NOX::ParameterSet::getDebugLevel ( ) const
inline

Definition at line 130 of file N_NLS_NOX_ParameterSet.h.

double N_NLS_NOX::ParameterSet::getDebugMaxTime ( ) const
inline

Definition at line 150 of file N_NLS_NOX_ParameterSet.h.

int N_NLS_NOX::ParameterSet::getDebugMaxTimeStep ( ) const
inline

Definition at line 140 of file N_NLS_NOX_ParameterSet.h.

double N_NLS_NOX::ParameterSet::getDebugMinTime ( ) const
inline

Definition at line 145 of file N_NLS_NOX_ParameterSet.h.

int N_NLS_NOX::ParameterSet::getDebugMinTimeStep ( ) const
inline

Definition at line 135 of file N_NLS_NOX_ParameterSet.h.

Teuchos::RefCountPtr< Teuchos::ParameterList > N_NLS_NOX::ParameterSet::getDebugParams ( )

Definition at line 536 of file N_NLS_NOX_ParameterSet.C.

Teuchos::RefCountPtr< Teuchos::ParameterList > N_NLS_NOX::ParameterSet::getLocaParams ( )

Definition at line 523 of file N_NLS_NOX_ParameterSet.C.

double N_NLS_NOX::ParameterSet::getMaxNormF ( ) const

Definition at line 1486 of file N_NLS_NOX_ParameterSet.C.

int N_NLS_NOX::ParameterSet::getMaxNormFindex ( ) const

Definition at line 1508 of file N_NLS_NOX_ParameterSet.C.

Teuchos::RefCountPtr< Teuchos::ParameterList > N_NLS_NOX::ParameterSet::getNoxParams ( )

Definition at line 510 of file N_NLS_NOX_ParameterSet.C.

int N_NLS_NOX::ParameterSet::getNoxSolverType ( ) const

Definition at line 1530 of file N_NLS_NOX_ParameterSet.C.

bool N_NLS_NOX::ParameterSet::getScreenOutputFlag ( ) const
inline

Definition at line 155 of file N_NLS_NOX_ParameterSet.h.

int N_NLS_NOX::ParameterSet::getStatusTestReturnCode ( ) const

Definition at line 1441 of file N_NLS_NOX_ParameterSet.C.

Teuchos::RefCountPtr< NOX::StatusTest::Generic > N_NLS_NOX::ParameterSet::getStatusTests ( )

Definition at line 478 of file N_NLS_NOX_ParameterSet.C.

bool N_NLS_NOX::ParameterSet::getVectorParam ( const std::string &  tag,
int  index,
double &  value 
)

Definition at line 1371 of file N_NLS_NOX_ParameterSet.C.

bool N_NLS_NOX::ParameterSet::getVectorParam ( const std::string &  tag,
int  index,
std::string &  value 
)

Definition at line 1393 of file N_NLS_NOX_ParameterSet.C.

int N_NLS_NOX::ParameterSet::getVectorParamSize ( const std::string &  vectorName)

Definition at line 1415 of file N_NLS_NOX_ParameterSet.C.

bool N_NLS_NOX::ParameterSet::isParamsSet ( ) const
inline

Definition at line 163 of file N_NLS_NOX_ParameterSet.h.

bool N_NLS_NOX::ParameterSet::parseOptionBlock_ ( const N_UTL_OptionBlock &  OB)
private

Definition at line 564 of file N_NLS_NOX_ParameterSet.C.

void N_NLS_NOX::ParameterSet::set_gstepping_min_value ( double  val)
inline

Definition at line 168 of file N_NLS_NOX_ParameterSet.h.

void N_NLS_NOX::ParameterSet::set_gstepping_minimum_conductance ( double  val)
inline

Definition at line 173 of file N_NLS_NOX_ParameterSet.h.

bool N_NLS_NOX::ParameterSet::setLocaOptions ( const N_UTL_OptionBlock &  OB,
bool  saveCopy = true 
)

Definition at line 1064 of file N_NLS_NOX_ParameterSet.C.

void N_NLS_NOX::ParameterSet::setNoxSolverType ( int  type)

Definition at line 1535 of file N_NLS_NOX_ParameterSet.C.

bool N_NLS_NOX::ParameterSet::setOptions ( const N_UTL_OptionBlock &  OB)

Definition at line 242 of file N_NLS_NOX_ParameterSet.C.

bool N_NLS_NOX::ParameterSet::setOutputOptions ( int  myPID,
int  outputProcess 
)

Definition at line 263 of file N_NLS_NOX_ParameterSet.C.

void N_NLS_NOX::ParameterSet::setStatusTestReturnCodes ( const N_NLS_ReturnCodes retCodesTmp)

Definition at line 1464 of file N_NLS_NOX_ParameterSet.C.

void N_NLS_NOX::ParameterSet::unsupportedOption_ ( const std::string &  tag)
private

Definition at line 549 of file N_NLS_NOX_ParameterSet.C.

Member Data Documentation

Teuchos::RefCountPtr<Teuchos::ParameterList> N_NLS_NOX::ParameterSet::allParams_
private

Definition at line 207 of file N_NLS_NOX_ParameterSet.h.

Teuchos::RefCountPtr<NOX::StatusTest::Combo> N_NLS_NOX::ParameterSet::comboPtr_
private

Definition at line 216 of file N_NLS_NOX_ParameterSet.h.

bool N_NLS_NOX::ParameterSet::continuationSpecified_
private

Definition at line 224 of file N_NLS_NOX_ParameterSet.h.

int N_NLS_NOX::ParameterSet::debugLevel_
private

Definition at line 256 of file N_NLS_NOX_ParameterSet.h.

double N_NLS_NOX::ParameterSet::debugMaxTime_
private

Definition at line 260 of file N_NLS_NOX_ParameterSet.h.

int N_NLS_NOX::ParameterSet::debugMaxTimeStep_
private

Definition at line 258 of file N_NLS_NOX_ParameterSet.h.

double N_NLS_NOX::ParameterSet::debugMinTime_
private

Definition at line 259 of file N_NLS_NOX_ParameterSet.h.

int N_NLS_NOX::ParameterSet::debugMinTimeStep_
private

Definition at line 257 of file N_NLS_NOX_ParameterSet.h.

Teuchos::ParameterList& N_NLS_NOX::ParameterSet::debugParams_
private

Definition at line 210 of file N_NLS_NOX_ParameterSet.h.

double N_NLS_NOX::ParameterSet::gstepping_min_value_
private

Definition at line 246 of file N_NLS_NOX_ParameterSet.h.

double N_NLS_NOX::ParameterSet::gstepping_minimum_conductance_
private

Definition at line 250 of file N_NLS_NOX_ParameterSet.h.

bool N_NLS_NOX::ParameterSet::isParamsSet_
private

Definition at line 221 of file N_NLS_NOX_ParameterSet.h.

bool N_NLS_NOX::ParameterSet::isStatusTestsSet_
private

Definition at line 222 of file N_NLS_NOX_ParameterSet.h.

Teuchos::ParameterList& N_NLS_NOX::ParameterSet::locaParams_
private

Definition at line 209 of file N_NLS_NOX_ParameterSet.h.

Xyce::Nonlinear::AnalysisMode N_NLS_NOX::ParameterSet::mode_
private

Definition at line 226 of file N_NLS_NOX_ParameterSet.h.

Teuchos::ParameterList& N_NLS_NOX::ParameterSet::noxParams_
private

Definition at line 208 of file N_NLS_NOX_ParameterSet.h.

int N_NLS_NOX::ParameterSet::noxSolver
private

Definition at line 232 of file N_NLS_NOX_ParameterSet.h.

N_UTL_OptionBlock N_NLS_NOX::ParameterSet::savedLocaOB_
private

Definition at line 253 of file N_NLS_NOX_ParameterSet.h.

bool N_NLS_NOX::ParameterSet::savedLocaOptions_
private

Definition at line 252 of file N_NLS_NOX_ParameterSet.h.

bool N_NLS_NOX::ParameterSet::screenOutputFlag_
private

Definition at line 261 of file N_NLS_NOX_ParameterSet.h.

Teuchos::ParameterList N_NLS_NOX::ParameterSet::statusTestParams_
private

Definition at line 211 of file N_NLS_NOX_ParameterSet.h.

std::vector< Teuchos::RefCountPtr<NOX::StatusTest::Generic> > N_NLS_NOX::ParameterSet::tests_
private

Definition at line 219 of file N_NLS_NOX_ParameterSet.h.

std::map<std::string, std::vector<N_UTL_Param> > N_NLS_NOX::ParameterSet::vectorParams
private

Definition at line 213 of file N_NLS_NOX_ParameterSet.h.

VoltageListType N_NLS_NOX::ParameterSet::voltageListType_
private

Definition at line 241 of file N_NLS_NOX_ParameterSet.h.

double N_NLS_NOX::ParameterSet::voltageScaleFactor_
private

Definition at line 243 of file N_NLS_NOX_ParameterSet.h.


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