Xyce  6.1
Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased Class Reference

#include <N_NLS_NOX_PseudoTransientSolver.h>

Inheritance diagram for Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased:
Collaboration diagram for Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased:

Public Member Functions

 PseudoTransientBased (const Teuchos::RCP< AugmentLinSys > &als, const Teuchos::RCP< NOX::Abstract::Group > &grp, const Teuchos::RCP< NOX::StatusTest::Generic > &tests, const Teuchos::RCP< Teuchos::ParameterList > &params, double initialStepSize, double minStepSize, double maxStepSize)
 Constructor. More...
 
virtual ~PseudoTransientBased ()
 Destructor. More...
 
virtual void reset (const NOX::Abstract::Vector &initial_guess)
 
virtual void reset (const NOX::Abstract::Vector &initial_guess, const Teuchos::RCP< NOX::StatusTest::Generic > &test)
 
virtual NOX::StatusTest::StatusType getStatus ()
 
virtual NOX::StatusTest::StatusType step ()
 
virtual NOX::StatusTest::StatusType solve ()
 
virtual const NOX::Abstract::Group & getSolutionGroup () const
 
virtual const NOX::Abstract::Group & getPreviousSolutionGroup () const
 
virtual int getNumIterations () const
 
virtual const Teuchos::ParameterList & getList () const
 
virtual double getStepSize () const
 Return the line search step size from the current iteration. More...
 
virtual double getPseudoTransientStepSize () const
 Return the pseudo transient step size. More...
 

Protected Member Functions

virtual void init ()
 Print out initialization information and calcuation the RHS. More...
 
virtual void printUpdate ()
 Prints the current iteration information. More...
 

Protected Attributes

Teuchos::RCP< NOX::GlobalData > globalData
 Global Data. More...
 
Teuchos::RCP< AugmentLinSysaugmentLSStrategy
 RCP to the strategy for augmenting the linear system. More...
 
Teuchos::RCP< NOX::Abstract::Group > solnPtr
 Current solution. More...
 
Teuchos::RCP< NOX::Abstract::Group > oldSolnPtr
 Previous solution pointer. More...
 
NOX::Abstract::Group & oldSoln
 Previous solution reference. More...
 
Teuchos::RCP< NOX::Abstract::Vector > dirPtr
 Current search direction.pointer. More...
 
NOX::Abstract::Vector & dir
 Current search direction.reference. More...
 
Teuchos::RCP< NOX::StatusTest::Generic > testPtr
 Stopping test. More...
 
Teuchos::RCP< Teuchos::ParameterList > paramsPtr
 Input parameters. More...
 
NOX::Utils & utils
 Utils. More...
 
Teuchos::RCP< NOX::LineSearch::Generic > lineSearch
 Linesearch. More...
 
Teuchos::RCP< NOX::Direction::Generic > direction
 Search Direction. More...
 
double step_
 Current step. More...
 
int nIter
 Number of nonlinear iterations. More...
 
NOX::StatusTest::StatusType status
 Status of nonlinear solver. More...
 
NOX::Solver::PrePostOperator prePostOperator
 Pointer to a user defined NOX::Abstract::PrePostOperator object. More...
 
double initialStepSize_
 
double minStepSize_
 
double maxStepSize_
 
double stepSize_
 
double previousStepSize_
 
double scaleFactor_
 
N_NLS_LOCA::Groupgroup_
 
N_NLS_LOCA::GrouppreviousGroup_
 
NOX::StatusTest::FiniteValue fvTest_
 
NOX::StatusTest::CheckType checkType
 Type of check to use for status tests. More...
 

Detailed Description

Definition at line 67 of file N_NLS_NOX_PseudoTransientSolver.h.

Constructor & Destructor Documentation

Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::PseudoTransientBased ( const Teuchos::RCP< AugmentLinSys > &  als,
const Teuchos::RCP< NOX::Abstract::Group > &  grp,
const Teuchos::RCP< NOX::StatusTest::Generic > &  tests,
const Teuchos::RCP< Teuchos::ParameterList > &  params,
double  initialStepSize,
double  minStepSize,
double  maxStepSize 
)

Constructor.

Definition at line 73 of file N_NLS_NOX_PseudoTransientSolver.C.

Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::~PseudoTransientBased ( )
virtual

Destructor.

Definition at line 140 of file N_NLS_NOX_PseudoTransientSolver.C.

Member Function Documentation

const Teuchos::ParameterList & Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::getList ( ) const
virtual

Definition at line 352 of file N_NLS_NOX_PseudoTransientSolver.C.

int Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::getNumIterations ( ) const
virtual

Definition at line 346 of file N_NLS_NOX_PseudoTransientSolver.C.

const NOX::Abstract::Group & Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::getPreviousSolutionGroup ( ) const
virtual

Definition at line 341 of file N_NLS_NOX_PseudoTransientSolver.C.

double Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::getPseudoTransientStepSize ( ) const
virtual

Return the pseudo transient step size.

Definition at line 411 of file N_NLS_NOX_PseudoTransientSolver.C.

const NOX::Abstract::Group & Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::getSolutionGroup ( ) const
virtual

Definition at line 335 of file N_NLS_NOX_PseudoTransientSolver.C.

NOX::StatusTest::StatusType Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::getStatus ( )
virtual

Definition at line 145 of file N_NLS_NOX_PseudoTransientSolver.C.

double Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::getStepSize ( ) const
virtual

Return the line search step size from the current iteration.

Definition at line 406 of file N_NLS_NOX_PseudoTransientSolver.C.

void Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::init ( )
protectedvirtual

Print out initialization information and calcuation the RHS.

Definition at line 106 of file N_NLS_NOX_PseudoTransientSolver.C.

void Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::printUpdate ( )
protectedvirtual

Prints the current iteration information.

Definition at line 358 of file N_NLS_NOX_PseudoTransientSolver.C.

void Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::reset ( const NOX::Abstract::Vector &  initial_guess)
virtual

Definition at line 125 of file N_NLS_NOX_PseudoTransientSolver.C.

void Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::reset ( const NOX::Abstract::Vector &  initial_guess,
const Teuchos::RCP< NOX::StatusTest::Generic > &  test 
)
virtual

Definition at line 132 of file N_NLS_NOX_PseudoTransientSolver.C.

NOX::StatusTest::StatusType Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::solve ( )
virtual

Definition at line 288 of file N_NLS_NOX_PseudoTransientSolver.C.

NOX::StatusTest::StatusType Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::step ( )
virtual

Definition at line 150 of file N_NLS_NOX_PseudoTransientSolver.C.

Member Data Documentation

Teuchos::RCP<AugmentLinSys> Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::augmentLSStrategy
protected

RCP to the strategy for augmenting the linear system.

Definition at line 114 of file N_NLS_NOX_PseudoTransientSolver.h.

NOX::StatusTest::CheckType Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::checkType
protected

Type of check to use for status tests.

Definition at line 173 of file N_NLS_NOX_PseudoTransientSolver.h.

NOX::Abstract::Vector& Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::dir
protected

Current search direction.reference.

Definition at line 131 of file N_NLS_NOX_PseudoTransientSolver.h.

Teuchos::RCP<NOX::Direction::Generic> Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::direction
protected

Search Direction.

Definition at line 146 of file N_NLS_NOX_PseudoTransientSolver.h.

Teuchos::RCP<NOX::Abstract::Vector> Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::dirPtr
protected

Current search direction.pointer.

We have both a pointer and a reference because we need to create a DERIVED object and then want to have a reference to it.

Definition at line 129 of file N_NLS_NOX_PseudoTransientSolver.h.

NOX::StatusTest::FiniteValue Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::fvTest_
protected

Definition at line 170 of file N_NLS_NOX_PseudoTransientSolver.h.

Teuchos::RCP<NOX::GlobalData> Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::globalData
protected

Global Data.

Definition at line 111 of file N_NLS_NOX_PseudoTransientSolver.h.

N_NLS_LOCA::Group* Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::group_
protected

Definition at line 167 of file N_NLS_NOX_PseudoTransientSolver.h.

double Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::initialStepSize_
protected

Definition at line 160 of file N_NLS_NOX_PseudoTransientSolver.h.

Teuchos::RCP<NOX::LineSearch::Generic> Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::lineSearch
protected

Linesearch.

Definition at line 143 of file N_NLS_NOX_PseudoTransientSolver.h.

double Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::maxStepSize_
protected

Definition at line 162 of file N_NLS_NOX_PseudoTransientSolver.h.

double Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::minStepSize_
protected

Definition at line 161 of file N_NLS_NOX_PseudoTransientSolver.h.

int Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::nIter
protected

Number of nonlinear iterations.

Definition at line 152 of file N_NLS_NOX_PseudoTransientSolver.h.

NOX::Abstract::Group& Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::oldSoln
protected

Previous solution reference.

Definition at line 124 of file N_NLS_NOX_PseudoTransientSolver.h.

Teuchos::RCP<NOX::Abstract::Group> Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::oldSolnPtr
protected

Previous solution pointer.

We have both a pointer and a reference because we need to create a DERIVED object and then want to have a reference to it.

Definition at line 122 of file N_NLS_NOX_PseudoTransientSolver.h.

Teuchos::RCP<Teuchos::ParameterList> Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::paramsPtr
protected

Input parameters.

Definition at line 137 of file N_NLS_NOX_PseudoTransientSolver.h.

NOX::Solver::PrePostOperator Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::prePostOperator
protected

Pointer to a user defined NOX::Abstract::PrePostOperator object.

Definition at line 158 of file N_NLS_NOX_PseudoTransientSolver.h.

N_NLS_LOCA::Group* Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::previousGroup_
protected

Definition at line 168 of file N_NLS_NOX_PseudoTransientSolver.h.

double Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::previousStepSize_
protected

Definition at line 164 of file N_NLS_NOX_PseudoTransientSolver.h.

double Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::scaleFactor_
protected

Definition at line 165 of file N_NLS_NOX_PseudoTransientSolver.h.

Teuchos::RCP<NOX::Abstract::Group> Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::solnPtr
protected

Current solution.

Definition at line 117 of file N_NLS_NOX_PseudoTransientSolver.h.

NOX::StatusTest::StatusType Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::status
protected

Status of nonlinear solver.

Definition at line 155 of file N_NLS_NOX_PseudoTransientSolver.h.

double Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::step_
protected

Current step.

Definition at line 149 of file N_NLS_NOX_PseudoTransientSolver.h.

double Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::stepSize_
protected

Definition at line 163 of file N_NLS_NOX_PseudoTransientSolver.h.

Teuchos::RCP<NOX::StatusTest::Generic> Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::testPtr
protected

Stopping test.

Definition at line 134 of file N_NLS_NOX_PseudoTransientSolver.h.

NOX::Utils& Xyce::Nonlinear::N_NLS_NOX::PseudoTransientBased::utils
protected

Utils.

Definition at line 140 of file N_NLS_NOX_PseudoTransientSolver.h.


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