Xyce  6.1
Xyce::Nonlinear::N_NLS_NOX::ParameterSet Class Reference

#include <N_NLS_NOX_ParameterSet.h>

Public Member Functions

 ParameterSet (Xyce::Nonlinear::AnalysisMode mode)
 
 ~ParameterSet ()
 
bool setOptions (const Xyce::Util::OptionBlock &OB)
 
bool setLocaOptions (const Xyce::Util::OptionBlock &OB, bool saveCopy=true)
 
bool applySavedLocaOptions ()
 
bool setOutputOptions (int myPID, int outputProcess)
 
bool createStatusTests (Parallel::Machine comm, N_LAS_Vector **currSolnVectorPtrPtr, Xyce::Loader::NonlinearEquationLoader &nonlinear_equation_loader, N_LAS_Vector *maskVectorPtr=0)
 Only used when NLS_MASKED_WRMS_NORMS. More...
 
Teuchos::RCP< 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 Xyce::Nonlinear::ReturnCodes &retCodesTmp)
 
Teuchos::RCP< Teuchos::ParameterList > getAllParams ()
 
Teuchos::RCP< Teuchos::ParameterList > getNoxParams ()
 
Teuchos::RCP< Teuchos::ParameterList > getLocaParams ()
 
Teuchos::RCP< 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::RCP< AugmentLinSyscreateAugmentLinearSystem (Xyce::Linear::System *ls) const
 
Teuchos::RCP< AugmentLinSyscreateAugmentLinearSystem (Xyce::Linear::System *ls, Xyce::IO::InitialConditionsData::NodeNamePairMap &op, const Xyce::NodeNameMap &allNodes, N_PDS_Comm *pdsCommPtr) const
 
Teuchos::RCP< AugmentLinSyscreateAugmentLinearSystem (Xyce::Linear::System *ls, Xyce::IO::InitialConditionsData::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 Xyce::Util::OptionBlock &OB)
 

Private Attributes

Teuchos::RCP< Teuchos::ParameterList > allParams_
 
Teuchos::ParameterList & noxParams_
 
Teuchos::ParameterList & locaParams_
 
Teuchos::ParameterList & debugParams_
 
Teuchos::ParameterList statusTestParams_
 
std::map< std::string, std::vector< Xyce::Util::Param > > vectorParams
 
Teuchos::RCP< NOX::StatusTest::Combo > comboPtr_
 
std::vector< Teuchos::RCP< 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_
 
Xyce::Util::OptionBlock savedLocaOB_
 
int debugLevel_
 
int debugMinTimeStep_
 
int debugMaxTimeStep_
 
double debugMinTime_
 
double debugMaxTime_
 
bool screenOutputFlag_
 
bool maskingFlag_
 

Detailed Description

Definition at line 75 of file N_NLS_NOX_ParameterSet.h.

Member Enumeration Documentation

Enumerator
VLT_DOFS 
VLT_Node 
VLT_None 

Definition at line 213 of file N_NLS_NOX_ParameterSet.h.

Constructor & Destructor Documentation

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

Definition at line 96 of file N_NLS_NOX_ParameterSet.C.

Xyce::Nonlinear::N_NLS_NOX::ParameterSet::~ParameterSet ( )

Definition at line 212 of file N_NLS_NOX_ParameterSet.C.

Member Function Documentation

bool Xyce::Nonlinear::N_NLS_NOX::ParameterSet::applySavedLocaOptions ( )
inline

Definition at line 83 of file N_NLS_NOX_ParameterSet.h.

Teuchos::RCP<AugmentLinSys> Xyce::Nonlinear::N_NLS_NOX::ParameterSet::createAugmentLinearSystem ( Xyce::Linear::System *  ls) const
Teuchos::RCP<AugmentLinSys> Xyce::Nonlinear::N_NLS_NOX::ParameterSet::createAugmentLinearSystem ( Xyce::Linear::System *  ls,
Xyce::IO::InitialConditionsData::NodeNamePairMap &  op,
const Xyce::NodeNameMap &  allNodes,
N_PDS_Comm *  pdsCommPtr 
) const
Teuchos::RCP<AugmentLinSys> Xyce::Nonlinear::N_NLS_NOX::ParameterSet::createAugmentLinearSystem ( Xyce::Linear::System *  ls,
Xyce::IO::InitialConditionsData::NodeNamePairMap &  op,
bool  gminStepping = false 
) const
bool Xyce::Nonlinear::N_NLS_NOX::ParameterSet::createStatusTests ( Parallel::Machine  comm,
N_LAS_Vector **  currSolnVectorPtrPtr,
Xyce::Loader::NonlinearEquationLoader nonlinear_equation_loader,
N_LAS_Vector *  maskVectorPtr = 0 
)

Only used when NLS_MASKED_WRMS_NORMS.

Definition at line 265 of file N_NLS_NOX_ParameterSet.C.

Teuchos::RCP< Teuchos::ParameterList > Xyce::Nonlinear::N_NLS_NOX::ParameterSet::getAllParams ( )

Definition at line 334 of file N_NLS_NOX_ParameterSet.C.

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

Definition at line 114 of file N_NLS_NOX_ParameterSet.h.

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

Definition at line 119 of file N_NLS_NOX_ParameterSet.h.

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

Definition at line 139 of file N_NLS_NOX_ParameterSet.h.

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

Definition at line 129 of file N_NLS_NOX_ParameterSet.h.

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

Definition at line 134 of file N_NLS_NOX_ParameterSet.h.

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

Definition at line 124 of file N_NLS_NOX_ParameterSet.h.

Teuchos::RCP< Teuchos::ParameterList > Xyce::Nonlinear::N_NLS_NOX::ParameterSet::getDebugParams ( )

Definition at line 373 of file N_NLS_NOX_ParameterSet.C.

Teuchos::RCP< Teuchos::ParameterList > Xyce::Nonlinear::N_NLS_NOX::ParameterSet::getLocaParams ( )

Definition at line 360 of file N_NLS_NOX_ParameterSet.C.

double Xyce::Nonlinear::N_NLS_NOX::ParameterSet::getMaxNormF ( ) const

Definition at line 1319 of file N_NLS_NOX_ParameterSet.C.

int Xyce::Nonlinear::N_NLS_NOX::ParameterSet::getMaxNormFindex ( ) const

Definition at line 1341 of file N_NLS_NOX_ParameterSet.C.

Teuchos::RCP< Teuchos::ParameterList > Xyce::Nonlinear::N_NLS_NOX::ParameterSet::getNoxParams ( )

Definition at line 347 of file N_NLS_NOX_ParameterSet.C.

int Xyce::Nonlinear::N_NLS_NOX::ParameterSet::getNoxSolverType ( ) const

Definition at line 1363 of file N_NLS_NOX_ParameterSet.C.

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

Definition at line 144 of file N_NLS_NOX_ParameterSet.h.

int Xyce::Nonlinear::N_NLS_NOX::ParameterSet::getStatusTestReturnCode ( ) const

Definition at line 1274 of file N_NLS_NOX_ParameterSet.C.

Teuchos::RCP< NOX::StatusTest::Generic > Xyce::Nonlinear::N_NLS_NOX::ParameterSet::getStatusTests ( )

Definition at line 315 of file N_NLS_NOX_ParameterSet.C.

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

Definition at line 1204 of file N_NLS_NOX_ParameterSet.C.

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

Definition at line 1226 of file N_NLS_NOX_ParameterSet.C.

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

Definition at line 1248 of file N_NLS_NOX_ParameterSet.C.

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

Definition at line 152 of file N_NLS_NOX_ParameterSet.h.

bool Xyce::Nonlinear::N_NLS_NOX::ParameterSet::parseOptionBlock_ ( const Xyce::Util::OptionBlock &  OB)
private

Definition at line 401 of file N_NLS_NOX_ParameterSet.C.

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

Definition at line 157 of file N_NLS_NOX_ParameterSet.h.

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

Definition at line 162 of file N_NLS_NOX_ParameterSet.h.

bool Xyce::Nonlinear::N_NLS_NOX::ParameterSet::setLocaOptions ( const Xyce::Util::OptionBlock &  OB,
bool  saveCopy = true 
)

Definition at line 897 of file N_NLS_NOX_ParameterSet.C.

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

Definition at line 1368 of file N_NLS_NOX_ParameterSet.C.

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

Definition at line 224 of file N_NLS_NOX_ParameterSet.C.

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

Definition at line 245 of file N_NLS_NOX_ParameterSet.C.

void Xyce::Nonlinear::N_NLS_NOX::ParameterSet::setStatusTestReturnCodes ( const Xyce::Nonlinear::ReturnCodes retCodesTmp)

Definition at line 1297 of file N_NLS_NOX_ParameterSet.C.

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

Definition at line 386 of file N_NLS_NOX_ParameterSet.C.

Member Data Documentation

Teuchos::RCP<Teuchos::ParameterList> Xyce::Nonlinear::N_NLS_NOX::ParameterSet::allParams_
private

Definition at line 189 of file N_NLS_NOX_ParameterSet.h.

Teuchos::RCP<NOX::StatusTest::Combo> Xyce::Nonlinear::N_NLS_NOX::ParameterSet::comboPtr_
private

Definition at line 198 of file N_NLS_NOX_ParameterSet.h.

bool Xyce::Nonlinear::N_NLS_NOX::ParameterSet::continuationSpecified_
private

Definition at line 206 of file N_NLS_NOX_ParameterSet.h.

int Xyce::Nonlinear::N_NLS_NOX::ParameterSet::debugLevel_
private

Definition at line 234 of file N_NLS_NOX_ParameterSet.h.

double Xyce::Nonlinear::N_NLS_NOX::ParameterSet::debugMaxTime_
private

Definition at line 238 of file N_NLS_NOX_ParameterSet.h.

int Xyce::Nonlinear::N_NLS_NOX::ParameterSet::debugMaxTimeStep_
private

Definition at line 236 of file N_NLS_NOX_ParameterSet.h.

double Xyce::Nonlinear::N_NLS_NOX::ParameterSet::debugMinTime_
private

Definition at line 237 of file N_NLS_NOX_ParameterSet.h.

int Xyce::Nonlinear::N_NLS_NOX::ParameterSet::debugMinTimeStep_
private

Definition at line 235 of file N_NLS_NOX_ParameterSet.h.

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

Definition at line 192 of file N_NLS_NOX_ParameterSet.h.

double Xyce::Nonlinear::N_NLS_NOX::ParameterSet::gstepping_min_value_
private

Definition at line 224 of file N_NLS_NOX_ParameterSet.h.

double Xyce::Nonlinear::N_NLS_NOX::ParameterSet::gstepping_minimum_conductance_
private

Definition at line 228 of file N_NLS_NOX_ParameterSet.h.

bool Xyce::Nonlinear::N_NLS_NOX::ParameterSet::isParamsSet_
private

Definition at line 203 of file N_NLS_NOX_ParameterSet.h.

bool Xyce::Nonlinear::N_NLS_NOX::ParameterSet::isStatusTestsSet_
private

Definition at line 204 of file N_NLS_NOX_ParameterSet.h.

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

Definition at line 191 of file N_NLS_NOX_ParameterSet.h.

bool Xyce::Nonlinear::N_NLS_NOX::ParameterSet::maskingFlag_
private

Definition at line 240 of file N_NLS_NOX_ParameterSet.h.

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

Definition at line 208 of file N_NLS_NOX_ParameterSet.h.

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

Definition at line 190 of file N_NLS_NOX_ParameterSet.h.

int Xyce::Nonlinear::N_NLS_NOX::ParameterSet::noxSolver
private

Definition at line 210 of file N_NLS_NOX_ParameterSet.h.

Xyce::Util::OptionBlock Xyce::Nonlinear::N_NLS_NOX::ParameterSet::savedLocaOB_
private

Definition at line 231 of file N_NLS_NOX_ParameterSet.h.

bool Xyce::Nonlinear::N_NLS_NOX::ParameterSet::savedLocaOptions_
private

Definition at line 230 of file N_NLS_NOX_ParameterSet.h.

bool Xyce::Nonlinear::N_NLS_NOX::ParameterSet::screenOutputFlag_
private

Definition at line 239 of file N_NLS_NOX_ParameterSet.h.

Teuchos::ParameterList Xyce::Nonlinear::N_NLS_NOX::ParameterSet::statusTestParams_
private

Definition at line 193 of file N_NLS_NOX_ParameterSet.h.

std::vector< Teuchos::RCP<NOX::StatusTest::Generic> > Xyce::Nonlinear::N_NLS_NOX::ParameterSet::tests_
private

Definition at line 201 of file N_NLS_NOX_ParameterSet.h.

std::map<std::string, std::vector<Xyce::Util::Param> > Xyce::Nonlinear::N_NLS_NOX::ParameterSet::vectorParams
private

Definition at line 195 of file N_NLS_NOX_ParameterSet.h.

VoltageListType Xyce::Nonlinear::N_NLS_NOX::ParameterSet::voltageListType_
private

Definition at line 219 of file N_NLS_NOX_ParameterSet.h.

double Xyce::Nonlinear::N_NLS_NOX::ParameterSet::voltageScaleFactor_
private

Definition at line 221 of file N_NLS_NOX_ParameterSet.h.


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