Inheritance diagram for NOX::TSF::Group:

Public Member Functions
	Group (const TSFExtended::Vector< double > &initcond, const TSFExtended::NonlinearOperator< double > &nonlinOp, const TSFExtended::LinearSolver< double > &solver)
	Constructor.
	Group (const TSFExtended::NonlinearOperator< double > &nonlinOp, const TSFExtended::LinearSolver< double > &solver)
	Constructor.
	Group (const TSFExtended::Vector< double > &initcond, const TSFExtended::NonlinearOperator< double > &nonlinOp, const TSFExtended::LinearSolver< double > &solver, int numdigits)
	Constructor.
	Group (const TSFExtended::NonlinearOperator< double > &nonlinOp, const TSFExtended::LinearSolver< double > &solver, int numdigits)
	Constructor.
	Group (const NOX::TSF::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::TSF::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::TSF::Vector &y)
	See above.
void	computeX (const NOX::Abstract::Group &grp, const NOX::Abstract::Vector &d, double step)
void	computeX (const NOX::TSF::Group &grp, const NOX::TSF::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::TSF::Vector &input, NOX::TSF::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::TSF::Vector &input, NOX::TSF::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::TSF::Vector &input, NOX::TSF::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
Protected Member Functions
void	resetIsValid ()
	resets all isValid flags to false
Protected Attributes
int	precision
	user-specified precision
TSFExtended::LinearSolver< double >	solver
	Linear solver that will be used to solve J*step = resid.
TSFExtended::LinearOperator < double >	jacobian
	Linear solver that will be used to solve J*step = resid.
TSFExtended::NonlinearOperator < double >	nonlinearOp
	Problem interface: reference to nonlinear operator passed to group.
double	normF
	Norm of F.
Vectors
NOX::TSF::Vector	xVector
	Solution vector.
NOX::TSF::Vector	fVector
	Right-hand-side vector (function evaluation).
NOX::TSF::Vector	newtonVector
	Newton direction vector.
NOX::TSF::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 60 of file NOX_TSF_Group.H.

Constructor & Destructor Documentation

NOX::TSF::Group::Group	(	const TSFExtended::Vector< double > &	initcond,
		const TSFExtended::NonlinearOperator< double > &	nonlinOp,
		const TSFExtended::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 41 of file NOX_TSF_Group.C.

References NOX::TSF::Vector::getTSFVector(), nonlinearOp, resetIsValid(), TSFExtended::NonlinearOperator< Scalar >::setEvalPt(), and xVector.

NOX::TSF::Group::Group	(	const TSFExtended::NonlinearOperator< double > &	nonlinOp,
		const TSFExtended::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 59 of file NOX_TSF_Group.C.

References NOX::TSF::Vector::getTSFVector(), nonlinearOp, resetIsValid(), TSFExtended::NonlinearOperator< Scalar >::setEvalPt(), and xVector.

NOX::TSF::Group::Group	(	const TSFExtended::Vector< double > &	initcond,
		const TSFExtended::NonlinearOperator< double > &	nonlinOp,
		const TSFExtended::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 76 of file NOX_TSF_Group.C.

References NOX::TSF::Vector::getTSFVector(), nonlinearOp, resetIsValid(), TSFExtended::NonlinearOperator< Scalar >::setEvalPt(), and xVector.

NOX::TSF::Group::Group	(	const TSFExtended::NonlinearOperator< double > &	nonlinOp,
		const TSFExtended::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 95 of file NOX_TSF_Group.C.

References NOX::TSF::Vector::getTSFVector(), nonlinearOp, resetIsValid(), TSFExtended::NonlinearOperator< Scalar >::setEvalPt(), and xVector.

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

Copy constructor.

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

Definition at line 114 of file NOX_TSF_Group.C.

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

NOX::TSF::Group::~Group ( )

Destructor.

Definition at line 153 of file NOX_TSF_Group.C.

Member Function Documentation

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

Definition at line 396 of file NOX_TSF_Group.C.

References NOX::TSF::Vector::getTSFVector().

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

See above.

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

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