NOX::Epetra::Group Class Reference

Concrete implementation of NOX::Abstract::Group for Trilinos/Epetra. More...

#include <NOX_Epetra_Group.H>

Inheritance diagram for NOX::Epetra::Group:

Inheritance graph
[legend]
Collaboration diagram for NOX::Epetra::Group:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Group (Teuchos::ParameterList &printingParams, const Teuchos::RCP< NOX::Epetra::Interface::Required > &i, const NOX::Epetra::Vector &initialGuess)
 Constructor with NO linear system (VERY LIMITED).
 Group (Teuchos::ParameterList &printingParams, const Teuchos::RCP< NOX::Epetra::Interface::Required > &i, const NOX::Epetra::Vector &initialGuess, const Teuchos::RCP< NOX::Epetra::LinearSystem > &linSys)
 Standard Constructor.
 Group (const NOX::Epetra::Group &source, NOX::CopyType type=NOX::DeepCopy)
 Copy constructor. If type is DeepCopy, takes ownership of valid shared linear system.
virtual ~Group ()
 Destructor.
virtual NOX::Abstract::Groupoperator= (const NOX::Abstract::Group &source)
 Copies the source group into this group.
virtual NOX::Abstract::Groupoperator= (const NOX::Epetra::Group &source)
 See operator=(const NOX::Abstract::Group&);.
virtual Teuchos::RCP< NOX::Abstract::Groupclone (CopyType type=DeepCopy) const
 Create a new Group of the same derived type as this one by cloning this one, and return a ref count pointer to the new group.
virtual Teuchos::RCP< NOX::Epetra::Interface::RequiredgetRequiredInterface ()
 Return the userInterface.
virtual Teuchos::RCP< const
NOX::Epetra::LinearSystem
getLinearSystem () const
 Return the Linear System.
virtual Teuchos::RCP< NOX::Epetra::LinearSystemgetLinearSystem ()
 Return the Linear System.
virtual NOX::Abstract::Group::ReturnType computeJacobianConditionNumber (int maxIters, double tolerance, int krylovSubspaceSize=100, bool printOutput=false)
virtual double getJacobianConditionNumber () const
 Returns the condition number of the Jacobian matrix.
"Compute" functions.
virtual void setX (const NOX::Epetra::Vector &y)
virtual void setX (const NOX::Abstract::Vector &y)
 Set the solution vector x to y.
virtual void computeX (const Group &grp, const NOX::Epetra::Vector &d, double step)
virtual void computeX (const NOX::Abstract::Group &grp, const NOX::Abstract::Vector &d, double step)
 Compute x = grp.x + step * d.
virtual NOX::Abstract::Group::ReturnType computeF ()
 Compute and store F(x).
virtual NOX::Abstract::Group::ReturnType computeJacobian ()
 Compute and store Jacobian.
virtual NOX::Abstract::Group::ReturnType computeGradient ()
 Compute and store gradient.
virtual NOX::Abstract::Group::ReturnType computeNewton (Teuchos::ParameterList &params)
 Compute the Newton direction, using parameters for the linear solve.
Jacobian operations.
Operations using the Jacobian matrix. These may not be defined in matrix-free scenarios.

virtual NOX::Abstract::Group::ReturnType applyJacobian (const NOX::Epetra::Vector &input, NOX::Epetra::Vector &result) const
virtual NOX::Abstract::Group::ReturnType applyJacobian (const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
 Applies Jacobian to the given input vector and puts the answer in the result.
virtual NOX::Abstract::Group::ReturnType applyJacobianTranspose (const NOX::Epetra::Vector &input, NOX::Epetra::Vector &result) const
virtual NOX::Abstract::Group::ReturnType applyJacobianTranspose (const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
 Applies Jacobian-Transpose to the given input vector and puts the answer in the result.
virtual NOX::Abstract::Group::ReturnType applyJacobianInverse (Teuchos::ParameterList &params, const NOX::Epetra::Vector &input, NOX::Epetra::Vector &result) const
 Applies the inverse of the Jacobian matrix to the given input vector and puts the answer in result.
virtual NOX::Abstract::Group::ReturnType applyJacobianInverse (Teuchos::ParameterList &params, const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
 Applies the inverse of the Jacobian matrix to the given input vector and puts the answer in result.
virtual NOX::Abstract::Group::ReturnType applyRightPreconditioning (bool useTranspose, Teuchos::ParameterList &params, const NOX::Epetra::Vector &input, NOX::Epetra::Vector &result) const
virtual NOX::Abstract::Group::ReturnType applyRightPreconditioning (bool useTranspose, Teuchos::ParameterList &params, const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
 Apply right preconditiong to the given input vector.
"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).

virtual bool isF () const
 Return true if F is valid.
virtual bool isJacobian () const
 Return true if the Jacobian is valid.
virtual bool isGradient () const
 Return true if the gradient is valid.
virtual bool isNewton () const
 Return true if the Newton direction is valid.
virtual bool isNormNewtonSolveResidual () const
 Returns true if the value of the Norm of the linear model for a full Newton step ||Js + f|| is valid with respect to the current solution vector.
virtual bool isPreconditioner () const
 Returns true if an explicitly constructed preconditioner exists (i.e. one that is computed and saved for further use in multiple calls to applyRightPreconditioner).
virtual bool isConditionNumber () const
 Returns true if the condition number has been computed.
"Get" functions
Note that these function do not check whether or not the vectors are valid. Must use the "Is" functions for that purpose.

virtual const NOX::Abstract::VectorgetX () const
 Return solution vector.
virtual const NOX::Abstract::VectorgetF () const
 Return F(x).
virtual double getNormF () const
 Return 2-norm of F(x).
virtual const NOX::Abstract::VectorgetGradient () const
 Return gradient.
virtual const NOX::Abstract::VectorgetNewton () const
 Return Newton direction.
virtual NOX::Abstract::Group::ReturnType getNormLastLinearSolveResidual (double &residual) const
 Returns the 2-norm of the residual of the linear model used in the Newton solve computation, ||Js+f||. This does not account for line search adjustments to the step length!

Protected Member Functions

virtual void resetIsValid ()
 resets the isValid flags to false
virtual bool computeNormNewtonSolveResidual ()
 Computes the 2-norm of the residual of the linear model used in the Newton solve computation, ||Js+f||.

Protected Attributes

const NOX::Utils utils
 Printing Utilities object.
double normNewtonSolveResidual
 2-Norm of the Newton solve residual: ||Js+f||
double conditionNumber
 condition number of Jacobian
Teuchos::RCP< AztecOOConditionNumber > azConditionNumberPtr
 Pointer to the condition number object.
Teuchos::RCP< NOX::Epetra::Interface::RequireduserInterfacePtr
 Reference to the user supplied interface functions.
Vectors
Teuchos::RCP< NOX::Epetra::VectorxVectorPtr
 Solution vector pointer.
NOX::Epetra::VectorxVector
 Solution vector.
Teuchos::RCP< NOX::Epetra::VectorRHSVectorPtr
 Right-hand-side vector (function evaluation).
NOX::Epetra::VectorRHSVector
 Right-hand-side vector pointer (function evaluation).
Teuchos::RCP< NOX::Epetra::VectorgradVectorPtr
 Gradient vector pointer(steepest descent vector).
NOX::Epetra::VectorgradVector
 Gradient vector (steepest descent vector).
Teuchos::RCP< NOX::Epetra::VectorNewtonVectorPtr
 Newton direction vector pointer.
NOX::Epetra::VectorNewtonVector
 Newton direction vector.
Teuchos::RCP< Epetra_VectortmpVectorPtr
 An extra temporary vector, only allocated if needed.
IsValid flags
True if the current solution is up-to-date with respect to the currect xVector.

bool isValidRHS
bool isValidJacobian
bool isValidGrad
bool isValidNewton
bool isValidNormNewtonSolveResidual
bool isValidPreconditioner
bool isValidSolverJacOp
bool isValidConditionNumber
Shared Operators
Teuchos::RCP< NOX::SharedObject<
NOX::Epetra::LinearSystem,
NOX::Epetra::Group > > 
sharedLinearSystemPtr
 Pointer to shared Jacobian matrix.
NOX::SharedObject< NOX::Epetra::LinearSystem,
NOX::Epetra::Group > & 
sharedLinearSystem
 Reference to shared Jacobian matrix.

Detailed Description

Concrete implementation of NOX::Abstract::Group for Trilinos/Epetra.

This group is set up to use the linear algebra services provided through the Trilinos/Epetra package with AztecOO for the linear solver.


Constructor & Destructor Documentation

Group::Group ( Teuchos::ParameterList printingParams,
const Teuchos::RCP< NOX::Epetra::Interface::Required > &  i,
const NOX::Epetra::Vector initialGuess 
)

Constructor with NO linear system (VERY LIMITED).

WARNING: If this constructor is used, then methods that require a Jacobian or preconditioning will not be available. You will be limited to simple algorithms like nonlinear-CG with no preconditioning.


Member Function Documentation

Abstract::Group::ReturnType Group::applyJacobian ( const NOX::Abstract::Vector input,
NOX::Abstract::Vector result 
) const [virtual]

Applies Jacobian to the given input vector and puts the answer in the result.

Computes

\[ v = J u, \]

where $J$ is the Jacobian, $u$ is the input vector, and $v$ is the result vector.

Returns:

Reimplemented from NOX::Abstract::Group.

Abstract::Group::ReturnType Group::applyJacobianInverse ( Teuchos::ParameterList params,
const NOX::Abstract::Vector input,
NOX::Abstract::Vector result 
) const [virtual]

Applies the inverse of the Jacobian matrix to the given input vector and puts the answer in result.

Computes

\[ v = J^{-1} u, \]

where $J$ is the Jacobian, $u$ is the input vector, and $v$ is the result vector.

The "Tolerance" parameter specifies that the solution should be such that

\[ \frac{\| J v - u \|_2}{\max \{ 1, \|u\|_2\} } < \mbox{Tolerance} \]

Returns:
The parameter "Tolerance" may be added/modified in the list of parameters - this is the ideal solution tolerance for an iterative linear solve.

Reimplemented from NOX::Abstract::Group.

Abstract::Group::ReturnType Group::applyJacobianInverse ( Teuchos::ParameterList params,
const NOX::Epetra::Vector input,
NOX::Epetra::Vector result 
) const [virtual]

Applies the inverse of the Jacobian matrix to the given input vector and puts the answer in result.

Computes

\[ v = J^{-1} u, \]

where $J$ is the Jacobian, $u$ is the input vector, and $v$ is the result vector.

The "Tolerance" parameter specifies that the solution should be such that

\[ \frac{\| J v - u \|_2}{\max \{ 1, \|u\|_2\} } < \mbox{Tolerance} \]

Returns:
The parameter "Tolerance" may be added/modified in the list of parameters - this is the ideal solution tolerance for an iterative linear solve.

The parameter "Reuse Preconditioner" is a boolean that tells the group to turn off control of preconditioner recalculation. This is a dangerous flag but can really speed the computations if the user knows what they are doing. Toggling this flag is left to the user (ideally it should be done through a status test). Defaults to false.

Abstract::Group::ReturnType Group::applyJacobianTranspose ( const NOX::Abstract::Vector input,
NOX::Abstract::Vector result 
) const [virtual]

Applies Jacobian-Transpose to the given input vector and puts the answer in the result.

Computes

\[ v = J^T u, \]

where $J$ is the Jacobian, $u$ is the input vector, and $v$ is the result vector.

Returns:

Reimplemented from NOX::Abstract::Group.

Abstract::Group::ReturnType Group::applyRightPreconditioning ( bool  useTranspose,
Teuchos::ParameterList params,
const NOX::Abstract::Vector input,
NOX::Abstract::Vector result 
) const [virtual]

Apply right preconditiong to the given input vector.

Let $M$ be a right preconditioner for the Jacobian $J$; in other words, $M$ is a matrix such that

\[ JM \approx I. \]

Compute

\[ u = M^{-1} v, \]

where $u$ is the input vector and $v$ is the result vector.

If useTranspose is true, then the transpose of the preconditioner is applied:

\[ u = {M^{-1}}^T v, \]

The transpose preconditioner is currently only required for Tensor methods.

The "Tolerance" parameter specifies that the solution should be such that

\[ \frac{\| M v - u \|_2}{\max \{ 1, \|u\|_2\} } < \mbox{Tolerance} \]

Returns:
The parameters are from the "Linear %Solver" sublist of the "Direction" sublist that is passed to solver during construction.

Reimplemented from NOX::Abstract::Group.

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

Create a new Group of the same derived type as this one by cloning this one, and return a ref count pointer to the new group.

If type is NOX::DeepCopy, then we need to create an exact replica of "this". Otherwise, if type is NOX::ShapeCopy, we need only replicate the shape of "this" (only the memory is allocated, the values are not copied into the vectors and Jacobian). Returns NULL if clone is not supported.

Note:
Any shared data should have its ownership transfered to this group from the source for a NOX::DeepCopy.

Implements NOX::Abstract::Group.

Reimplemented in LOCA::Epetra::Group.

Abstract::Group::ReturnType Group::computeF (  )  [virtual]

Compute and store F(x).

Note:
It's generally useful to also compute and store the 2-norm of F(x) at this point for later access by the getNormF() function.
Returns:

Implements NOX::Abstract::Group.

Reimplemented in LOCA::Epetra::Group.

Abstract::Group::ReturnType Group::computeGradient (  )  [virtual]

Compute and store gradient.

We can pose the nonlinear equation problem $F(x) = 0$ as an optimization problem as follows:

\[ \min f(x) \equiv \frac{1}{2} \|F(x)\|_2^2. \]

In that case, the gradient (of $f$) is defined as

\[ g \equiv J^T F. \]

Returns:

Reimplemented from NOX::Abstract::Group.

Abstract::Group::ReturnType Group::computeJacobian (  )  [virtual]

Compute and store Jacobian.

Recall that

\[ F(x) = \left[ \begin{array}{c} F_1(x) \\ F_2(x) \\ \vdots \\ F_n(x) \\ \end{array} \right]. \]

The Jacobian is denoted by $J$ and defined by

\[ J_{ij} = \frac{\partial F_i}{\partial x_j} (x). \]

Note:
If this is a shared object, this group should taken ownership of the Jacobian before it computes it.
Returns:

Reimplemented from NOX::Abstract::Group.

Reimplemented in LOCA::Epetra::Group.

Abstract::Group::ReturnType Group::computeNewton ( Teuchos::ParameterList params  )  [virtual]

Compute the Newton direction, using parameters for the linear solve.

The Newton direction is the solution, s, of

\[ J s = -F. \]

The parameters are from the "Linear %Solver" sublist of the "Direction" sublist that is passed to solver during construction.

The "Tolerance" parameter may be added/modified in the sublist of "Linear Solver" parameters that is passed into this function. The solution should be such that

\[ \frac{\| J s - (-F) \|_2}{\max \{ 1, \|F\|_2\} } < \mbox{Tolerance} \]

Returns:

Reimplemented from NOX::Abstract::Group.

void Group::computeX ( const NOX::Abstract::Group grp,
const NOX::Abstract::Vector d,
double  step 
) [virtual]

Compute x = grp.x + step * d.

Let $x$ denote this group's solution vector. Let $\hat x$ denote the result of grp.getX(). Then set

\[ x = \hat x + \mbox{step} \; d. \]

Note:
This should invalidate the function value, Jacobian, gradient, and Newton direction.

Throw an error if the copy fails.

Returns:
Reference to this object

Implements NOX::Abstract::Group.

double Group::getNormF (  )  const [virtual]

Return 2-norm of F(x).

In other words,

\[ \sqrt{\sum_{i=1}^n F_i^2} \]

Implements NOX::Abstract::Group.

bool Group::isGradient (  )  const [virtual]

Return true if the gradient is valid.

Note:
Default implementation in NOX::Abstract::Group returns false.

Reimplemented from NOX::Abstract::Group.

bool Group::isJacobian (  )  const [virtual]

Return true if the Jacobian is valid.

Note:
Default implementation in NOX::Abstract::Group returns false.

Reimplemented from NOX::Abstract::Group.

bool Group::isNewton (  )  const [virtual]

Return true if the Newton direction is valid.

Note:
Default implementation in NOX::Abstract::Group returns false.

Reimplemented from NOX::Abstract::Group.

Abstract::Group & Group::operator= ( const NOX::Abstract::Group source  )  [virtual]

Copies the source group into this group.

Note:
Any shared data owned by the source should have its ownership transfered to this group. This may result in a secret modification to the source object.

Implements NOX::Abstract::Group.

Reimplemented in LOCA::Epetra::Group.

void Group::setX ( const NOX::Abstract::Vector y  )  [virtual]

Set the solution vector x to y.

Note:
This should invalidate the function value, Jacobian, gradient, and Newton direction.

Throw an error if the copy fails.

Returns:
Reference to this object

Implements NOX::Abstract::Group.


The documentation for this class was generated from the following files:
Generated on Tue Oct 20 12:46:35 2009 for NOX by doxygen 1.4.7