Public Member Functions
	Group (const Playa::Vector< double > &initcond, const Playa::NonlinearOperator< double > &nonlinOp, const Playa::LinearSolver< double > &solver)
	Constructor.
	Group (const Playa::NonlinearOperator< double > &nonlinOp, const Playa::LinearSolver< double > &solver)
	Constructor.
	Group (const Playa::Vector< double > &initcond, const Playa::NonlinearOperator< double > &nonlinOp, const Playa::LinearSolver< double > &solver, int numdigits)
	Constructor.
	Group (const Playa::NonlinearOperator< double > &nonlinOp, const Playa::LinearSolver< double > &solver, int numdigits)
	Constructor.
	Group (const NOX::NOXPlaya::Group &source, NOX::CopyType type=DeepCopy)
	Copy constructor.
	~Group ()
	Destructor.
NOX::Abstract::Group &	operator= (const NOX::Abstract::Group &source)
NOX::Abstract::Group &	operator= (const NOX::NOXPlaya::Group &source)
	See above.
virtual RCP< NOX::Abstract::Group >	clone (NOX::CopyType type=NOX::DeepCopy) const
void	print () const
	Print out the group.
"Compute" functions.
void	setX (const NOX::Abstract::Vector &y)
void	setX (const NOX::NOXPlaya::Vector &y)
	See above.
void	computeX (const NOX::Abstract::Group &grp, const NOX::Abstract::Vector &d, double step)
void	computeX (const NOX::NOXPlaya::Group &grp, const NOX::NOXPlaya::Vector &d, double step)
	See above.
NOX::Abstract::Group::ReturnType	computeF ()
NOX::Abstract::Group::ReturnType	computeJacobian ()
NOX::Abstract::Group::ReturnType	computeGradient ()
NOX::Abstract::Group::ReturnType	computeNewton (Teuchos::ParameterList &params)
Jacobian operations.
Operations using the Jacobian matrix. These may not be defined in matrix-free scenarios.
NOX::Abstract::Group::ReturnType	applyJacobian (const NOX::NOXPlaya::Vector &input, NOX::NOXPlaya::Vector &result) const
NOX::Abstract::Group::ReturnType	applyJacobian (const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
	See above.
NOX::Abstract::Group::ReturnType	applyJacobianTranspose (const NOX::NOXPlaya::Vector &input, NOX::NOXPlaya::Vector &result) const
NOX::Abstract::Group::ReturnType	applyJacobianTranspose (const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
	See above.
NOX::Abstract::Group::ReturnType	applyJacobianInverse (Teuchos::ParameterList &params, const NOX::NOXPlaya::Vector &input, NOX::NOXPlaya::Vector &result) const
NOX::Abstract::Group::ReturnType	applyJacobianInverse (Teuchos::ParameterList &params, const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
"Is" functions
Checks to see if various objects have been computed. Returns true if the corresponding "compute" function has been called since the last update to the solution vector (via instantiation or computeX).
bool	isF () const
bool	isJacobian () const
bool	isGradient () const
bool	isNewton () const
"Get" functions
Note that these function do not check whether or not the vectors are valid. Must use the "Is" functions for that purpose.
const NOX::Abstract::Vector &	getX () const
const NOX::Abstract::Vector &	getF () const
double	getNormF () const
const NOX::Abstract::Vector &	getGradient () const
const NOX::Abstract::Vector &	getNewton () const
virtual Teuchos::RCP< const NOX::Abstract::Vector >	getXPtr () const
	Return RCP to solution vector.
virtual Teuchos::RCP< const NOX::Abstract::Vector >	getFPtr () const
	Return RCP to F(x)
virtual Teuchos::RCP< const NOX::Abstract::Vector >	getGradientPtr () const
	Return RCP to gradient.
virtual Teuchos::RCP< const NOX::Abstract::Vector >	getNewtonPtr () const
	Return RCP to Newton direction.
Protected Member Functions
void	resetIsValid ()
	resets all isValid flags to false
Protected Attributes
int	precision
	user-specified precision
Playa::LinearSolver< double >	solver
	Linear solver that will be used to solve J*step = resid.
Playa::LinearOperator< double >	jacobian
	Linear solver that will be used to solve J*step = resid.
Playa::NonlinearOperator< double >	nonlinearOp
	Problem interface: reference to nonlinear operator passed to group.
double	normF
	Norm of F.
Vectors
RCP< NOX::NOXPlaya::Vector >	xVector
	Solution vector.
RCP< NOX::NOXPlaya::Vector >	fVector
	Right-hand-side vector (function evaluation).
RCP< NOX::NOXPlaya::Vector >	newtonVector
	Newton direction vector.
RCP< NOX::NOXPlaya::Vector >	gradientVector
	Gradient vector (steepest descent vector).
IsValid flags
True if the current solution is up-to-date with respect to the currect xVector.
bool	isValidF
bool	isValidJacobian
bool	isValidGradient
bool	isValidNewton

Detailed Description

Definition at line 80 of file NOX_Playa_Group.hpp.

Constructor & Destructor Documentation

NOX::NOXPlaya::Group::Group	(	const Playa::Vector< double > &	initcond,
		const Playa::NonlinearOperator< double > &	nonlinOp,
		const Playa::LinearSolver< double > &	solver
	)

Constructor.

Construct a group given an initial condition, the nonlinear operator that describes the problem to be solved, and the linear solver

Definition at line 66 of file NOX_Playa_Group.cpp.

References nonlinearOp, resetIsValid(), Playa::NonlinearOperator< Scalar >::setEvalPt(), and xVector.

NOX::NOXPlaya::Group::Group	(	const Playa::NonlinearOperator< double > &	nonlinOp,
		const Playa::LinearSolver< double > &	solver
	)

Constructor.

Construct a group given an initial condition and the nonlinear operator that describes the problem to be solved.

Definition at line 84 of file NOX_Playa_Group.cpp.

References nonlinearOp, resetIsValid(), Playa::NonlinearOperator< Scalar >::setEvalPt(), and xVector.

NOX::NOXPlaya::Group::Group	(	const Playa::Vector< double > &	initcond,
		const Playa::NonlinearOperator< double > &	nonlinOp,
		const Playa::LinearSolver< double > &	solver,
		int	numdigits
	)

Constructor.

Construct a group given an initial condition, the nonlinear operator that describes the problem to be solved, the linear solver, and user-specified precision.

Definition at line 101 of file NOX_Playa_Group.cpp.

References nonlinearOp, resetIsValid(), Playa::NonlinearOperator< Scalar >::setEvalPt(), and xVector.

NOX::NOXPlaya::Group::Group	(	const Playa::NonlinearOperator< double > &	nonlinOp,
		const Playa::LinearSolver< double > &	solver,
		int	numdigits
	)

Constructor.

Construct a group given an initial condition, the nonlinear operator that describes the problem to be solved, and user-specified precision.

Definition at line 120 of file NOX_Playa_Group.cpp.

References nonlinearOp, resetIsValid(), Playa::NonlinearOperator< Scalar >::setEvalPt(), and xVector.

NOX::NOXPlaya::Group::Group	(	const NOX::NOXPlaya::Group &	source,
		NOX::CopyType	type = `DeepCopy`
	)

Copy constructor.

Construct a new group given an existing group to copy from.

Definition at line 139 of file NOX_Playa_Group.cpp.

References isValidF, isValidGradient, isValidJacobian, isValidNewton, normF, and resetIsValid().

NOX::NOXPlaya::Group::~Group ( )

Destructor.

Definition at line 178 of file NOX_Playa_Group.cpp.

Member Function Documentation

NOX::Abstract::Group::ReturnType NOX::NOXPlaya::Group::applyJacobian	(	const NOX::NOXPlaya::Vector &	input,
		NOX::NOXPlaya::Vector &	result
	)		const

Definition at line 416 of file NOX_Playa_Group.cpp.

References NOX::NOXPlaya::Vector::getPlayaVector().

NOX::Abstract::Group::ReturnType NOX::NOXPlaya::Group::applyJacobian	(	const NOX::Abstract::Vector &	input,
		NOX::Abstract::Vector &	result
	)		const

See above.

NOX::Abstract::Group::ReturnType NOX::NOXPlaya::Group::applyJacobianInverse	(	Teuchos::ParameterList &	params,
		const NOX::NOXPlaya::Vector &	input,
		NOX::NOXPlaya::Vector &	result
	)		const

Definition at line 469 of file NOX_Playa_Group.cpp.

References Playa::SolverState< Scalar >::finalState(), NOX::NOXPlaya::Vector::getPlayaVector(), Playa::Vector< Scalar >::print(), and Playa::SolveConverged.

NOX::Abstract::Group::ReturnType NOX::NOXPlaya::Group::applyJacobianInverse	(	Teuchos::ParameterList &	params,
		const NOX::Abstract::Vector &	input,
		NOX::Abstract::Vector &	result
	)		const

NOX::Abstract::Group::ReturnType NOX::NOXPlaya::Group::applyJacobianTranspose	(	const NOX::NOXPlaya::Vector &	input,
		NOX::NOXPlaya::Vector &	result
	)		const

Definition at line 442 of file NOX_Playa_Group.cpp.

References NOX::NOXPlaya::Vector::getPlayaVector().

NOX::Abstract::Group::ReturnType NOX::NOXPlaya::Group::applyJacobianTranspose	(	const NOX::Abstract::Vector &	input,
		NOX::Abstract::Vector &	result
	)		const

See above.

Definition at line 433 of file NOX_Playa_Group.cpp.

RCP< NOX::Abstract::Group > NOX::NOXPlaya::Group::clone ( NOX::CopyType type = NOX::DeepCopy ) const [virtual]

Definition at line 191 of file NOX_Playa_Group.cpp.

NOX::Abstract::Group::ReturnType NOX::NOXPlaya::Group::computeF ( )

Definition at line 267 of file NOX_Playa_Group.cpp.

NOX::Abstract::Group::ReturnType NOX::NOXPlaya::Group::computeGradient ( )

Definition at line 321 of file NOX_Playa_Group.cpp.

NOX::Abstract::Group::ReturnType NOX::NOXPlaya::Group::computeJacobian ( )

Definition at line 298 of file NOX_Playa_Group.cpp.

NOX::Abstract::Group::ReturnType NOX::NOXPlaya::Group::computeNewton ( Teuchos::ParameterList & params )

Definition at line 357 of file NOX_Playa_Group.cpp.

void NOX::NOXPlaya::Group::computeX	(	const NOX::Abstract::Group &	grp,
		const NOX::Abstract::Vector &	d,
		double	step
	)

Definition at line 250 of file NOX_Playa_Group.cpp.

void NOX::NOXPlaya::Group::computeX	(	const NOX::NOXPlaya::Group &	grp,
		const NOX::NOXPlaya::Vector &	d,
		double	step
	)

See above.

Definition at line 260 of file NOX_Playa_Group.cpp.

References xVector.

const NOX::Abstract::Vector & NOX::NOXPlaya::Group::getF ( ) const

Definition at line 541 of file NOX_Playa_Group.cpp.

virtual Teuchos::RCP< const NOX::Abstract::Vector > NOX::NOXPlaya::Group::getFPtr ( ) const [inline, virtual]

Return RCP to F(x)

Definition at line 236 of file NOX_Playa_Group.hpp.

References fVector.

const NOX::Abstract::Vector & NOX::NOXPlaya::Group::getGradient ( ) const

Definition at line 563 of file NOX_Playa_Group.cpp.

virtual Teuchos::RCP< const NOX::Abstract::Vector > NOX::NOXPlaya::Group::getGradientPtr ( ) const [inline, virtual]

Return RCP to gradient.

Definition at line 242 of file NOX_Playa_Group.hpp.

References gradientVector.

const NOX::Abstract::Vector & NOX::NOXPlaya::Group::getNewton ( ) const

Definition at line 568 of file NOX_Playa_Group.cpp.

virtual Teuchos::RCP< const NOX::Abstract::Vector > NOX::NOXPlaya::Group::getNewtonPtr ( ) const [inline, virtual]

Return RCP to Newton direction.

Definition at line 246 of file NOX_Playa_Group.hpp.

References newtonVector.

double NOX::NOXPlaya::Group::getNormF ( ) const

Definition at line 552 of file NOX_Playa_Group.cpp.

Referenced by Playa::NOXSolver::solve().

const NOX::Abstract::Vector & NOX::NOXPlaya::Group::getX ( ) const

Definition at line 536 of file NOX_Playa_Group.cpp.

Referenced by Playa::NOXSolver::solve().

virtual Teuchos::RCP< const NOX::Abstract::Vector > NOX::NOXPlaya::Group::getXPtr ( ) const [inline, virtual]

Return RCP to solution vector.

Definition at line 232 of file NOX_Playa_Group.hpp.

References xVector.

bool NOX::NOXPlaya::Group::isF ( ) const

Definition at line 516 of file NOX_Playa_Group.cpp.

bool NOX::NOXPlaya::Group::isGradient ( ) const

Definition at line 526 of file NOX_Playa_Group.cpp.

bool NOX::NOXPlaya::Group::isJacobian ( ) const

Definition at line 521 of file NOX_Playa_Group.cpp.

bool NOX::NOXPlaya::Group::isNewton ( ) const

Definition at line 531 of file NOX_Playa_Group.cpp.

NOX::Abstract::Group & NOX::NOXPlaya::Group::operator= ( const NOX::Abstract::Group & source )

Definition at line 196 of file NOX_Playa_Group.cpp.

NOX::Abstract::Group & NOX::NOXPlaya::Group::operator= ( const NOX::NOXPlaya::Group & source )

See above.

Definition at line 201 of file NOX_Playa_Group.cpp.

References fVector, gradientVector, isValidF, isValidGradient, isValidJacobian, isValidNewton, jacobian, newtonVector, nonlinearOp, normF, precision, solver, and xVector.

void NOX::NOXPlaya::Group::print ( ) const

Print out the group.

Definition at line 573 of file NOX_Playa_Group.cpp.

void NOX::NOXPlaya::Group::resetIsValid ( ) [protected]

resets all isValid flags to false

Definition at line 182 of file NOX_Playa_Group.cpp.

Referenced by Group().

void NOX::NOXPlaya::Group::setX ( const NOX::Abstract::Vector & y )

Definition at line 238 of file NOX_Playa_Group.cpp.

void NOX::NOXPlaya::Group::setX ( const NOX::NOXPlaya::Vector & y )

See above.

Definition at line 243 of file NOX_Playa_Group.cpp.

References NOX::NOXPlaya::Vector::getPlayaVector().

Member Data Documentation

RCP<NOX::NOXPlaya::Vector> NOX::NOXPlaya::Group::fVector [protected]

Right-hand-side vector (function evaluation).

Definition at line 274 of file NOX_Playa_Group.hpp.

Referenced by getFPtr(), and operator=().

RCP<NOX::NOXPlaya::Vector> NOX::NOXPlaya::Group::gradientVector [protected]

Gradient vector (steepest descent vector).

Definition at line 278 of file NOX_Playa_Group.hpp.

Referenced by getGradientPtr(), and operator=().

bool NOX::NOXPlaya::Group::isValidF [protected]

Definition at line 296 of file NOX_Playa_Group.hpp.

Referenced by Group(), and operator=().

bool NOX::NOXPlaya::Group::isValidGradient [protected]

Definition at line 298 of file NOX_Playa_Group.hpp.

Referenced by Group(), and operator=().

bool NOX::NOXPlaya::Group::isValidJacobian [protected]

Definition at line 297 of file NOX_Playa_Group.hpp.

Referenced by Group(), and operator=().

bool NOX::NOXPlaya::Group::isValidNewton [protected]

Definition at line 299 of file NOX_Playa_Group.hpp.

Referenced by Group(), and operator=().

Playa::LinearOperator<double> NOX::NOXPlaya::Group::jacobian [protected]

Linear solver that will be used to solve J*step = resid.

Definition at line 285 of file NOX_Playa_Group.hpp.

Referenced by operator=().

RCP<NOX::NOXPlaya::Vector> NOX::NOXPlaya::Group::newtonVector [protected]

Newton direction vector.

Definition at line 276 of file NOX_Playa_Group.hpp.

Referenced by getNewtonPtr(), and operator=().

Playa::NonlinearOperator<double> NOX::NOXPlaya::Group::nonlinearOp [protected]

Problem interface: reference to nonlinear operator passed to group.

Definition at line 289 of file NOX_Playa_Group.hpp.

Referenced by Group(), and operator=().

double NOX::NOXPlaya::Group::normF [protected]

Norm of F.

Definition at line 303 of file NOX_Playa_Group.hpp.

Referenced by Group(), and operator=().

int NOX::NOXPlaya::Group::precision [protected]

user-specified precision

Definition at line 267 of file NOX_Playa_Group.hpp.

Referenced by operator=().

Playa::LinearSolver<double> NOX::NOXPlaya::Group::solver [mutable, protected]

Linear solver that will be used to solve J*step = resid.

Definition at line 282 of file NOX_Playa_Group.hpp.

Referenced by operator=().

RCP<NOX::NOXPlaya::Vector> NOX::NOXPlaya::Group::xVector [protected]

Solution vector.

Definition at line 272 of file NOX_Playa_Group.hpp.

Referenced by computeX(), getXPtr(), Group(), and operator=().

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation