NOX Development
Public Types | Public Member Functions
NOX::Abstract::Group Class Reference

NOX pure abstract interface to a "group"; i.e., a solution vector and the corresponding F-vector, Jacobian matrix, gradient vector, and Newton vector. More...

#include <NOX_Abstract_Group.H>

Inheritance diagram for NOX::Abstract::Group:
Inheritance graph
[legend]

List of all members.

Public Types

enum  ReturnType {
  Ok, NotDefined, BadDependency, NotConverged,
  Failed
}
 The computation of, say, the Newton direction in computeNewton() may fail in many different ways, so we have included a variety of return codes to describe the failures. Of course, we also have a code for success. More...

Public Member Functions

 Group ()
 Constructor.
virtual ~Group ()
 Destructor.
virtual NOX::Abstract::Groupoperator= (const NOX::Abstract::Group &source)=0
 Copies the source group into this group.
virtual
NOX::Abstract::Group::ReturnType 
getNormLastLinearSolveResidual (double &residual) const
 Return the norm of the last linear solve residual as the result of either a call to computeNewton() or applyJacobianInverse().
virtual void setX (const NOX::Abstract::Vector &y)=0
 Set the solution vector x to y.
virtual void computeX (const NOX::Abstract::Group &grp, const NOX::Abstract::Vector &d, double step)=0
 Compute x = grp.x + step * d.
virtual
NOX::Abstract::Group::ReturnType 
computeF ()=0
 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.

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::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::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::Abstract::Vector &input, NOX::Abstract::Vector &result) const
 Apply right preconditiong to the given input vector.
Block Jacobian operations.

Operations using the Jacobian matrix.

virtual
NOX::Abstract::Group::ReturnType 
applyJacobianMultiVector (const NOX::Abstract::MultiVector &input, NOX::Abstract::MultiVector &result) const
 applyJacobian for multiple right-hand sides
virtual
NOX::Abstract::Group::ReturnType 
applyJacobianTransposeMultiVector (const NOX::Abstract::MultiVector &input, NOX::Abstract::MultiVector &result) const
 applyJacobianTranspose for multiple right-hand sides
virtual
NOX::Abstract::Group::ReturnType 
applyJacobianInverseMultiVector (Teuchos::ParameterList &params, const NOX::Abstract::MultiVector &input, NOX::Abstract::MultiVector &result) const
 applyJacobianInverse for multiple right-hand sides
virtual
NOX::Abstract::Group::ReturnType 
applyRightPreconditioningMultiVector (bool useTranspose, Teuchos::ParameterList &params, const NOX::Abstract::MultiVector &input, NOX::Abstract::MultiVector &result) const
 applyRightPreconditioning for multiple right-hand sides
"Is" functions.

Checks to see if various objects have been computed. Returns true if the corresponding "compute" function has been called since the last change to the solution vector.

virtual bool isF () const =0
 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.
"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::Vector
getX () const =0
 Return solution vector.
virtual const
NOX::Abstract::Vector
getF () const =0
 Return F(x)
virtual double getNormF () const =0
 Return 2-norm of F(x).
virtual const
NOX::Abstract::Vector
getGradient () const =0
 Return gradient.
virtual const
NOX::Abstract::Vector
getNewton () const =0
 Return Newton direction.
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.
virtual Teuchos::RCP
< NOX::Abstract::Group
clone (NOX::CopyType type=NOX::DeepCopy) const =0
 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.

Detailed Description

NOX pure abstract interface to a "group"; i.e., a solution vector and the corresponding F-vector, Jacobian matrix, gradient vector, and Newton vector.

This class is a member of the namespace NOX::Abstract.

The user should implement their own concrete implementation of this class or use one of the implementations provided by us. Typically the implementation is also tied to a particular NOX::Abstract::Vector implementation.

Note:
The group may be implemented so that multiple groups can share underlying memory space. This is particularly important when it comes to the Jacobian, which is often to big to be replicated for every group. Thus, we have included instructions on how shared data should be treated for the operator=() and clone() functions.

Member Enumeration Documentation

The computation of, say, the Newton direction in computeNewton() may fail in many different ways, so we have included a variety of return codes to describe the failures. Of course, we also have a code for success.

Note:
These return types may be expanded in future releases.
Enumerator:
Ok 

Computation completed successfully.

NotDefined 

This function is not implemented.

BadDependency 

Data dependencies not satisfied.

NotConverged 

Unable to satisfy convergence criteria.

Failed 

Any other type of failure.


Constructor & Destructor Documentation

NOX::Abstract::Group::Group ( ) [inline]

Constructor.

Note:
Constructors for any derived object should always define a default x-value so that getX() is always defined.

Member Function Documentation

NOX::Abstract::Group::ReturnType NOX::Abstract::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 in LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::PhaseTransition::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, LOCA::TurningPoint::MooreSpence::ExtendedGroup, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, and NOX::LAPACK::Group.

References NotDefined.

Referenced by LOCA::DerivUtils::computeDJnDp(), LOCA::DerivUtils::computeDJnDxa(), LOCA::DerivUtils::computeDwtJnDp(), NOX::Direction::Utils::InexactNewton::computeForcingTerm(), NOX::MeritFunction::SumOfSquares::computeQuadraticMinimizer(), NOX::Thyra::WeightedMeritFunction::computeQuadraticModel(), NOX::MeritFunction::SumOfSquares::computeQuadraticModel(), NOX::Thyra::WeightedMeritFunction::computeSlope(), NOX::LineSearch::Utils::Slope::computeSlope(), NOX::Solver::TensorBased::computeTensorDirection(), NOX::Solver::TensorBased::getDirectionalDerivative(), NOX::Solver::TensorBased::getNormModelResidual(), NOX::Solver::InexactTrustRegionBased::iterateInexact(), and NOX::Direction::Newton::resetForcingTerm().

NOX::Abstract::Group::ReturnType NOX::Abstract::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 in LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::PhaseTransition::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, LOCA::TurningPoint::MooreSpence::ExtendedGroup, NOX::Epetra::Group, NOX::Thyra::Group, and NOX::LAPACK::Group.

References NotDefined.

Referenced by NOX::Solver::TensorBased::computeTensorDirection(), and NOX::Solver::InexactTrustRegionBased::iterateInexact().

NOX::Abstract::Group::ReturnType NOX::Abstract::Group::applyJacobianInverseMultiVector ( Teuchos::ParameterList params,
const NOX::Abstract::MultiVector input,
NOX::Abstract::MultiVector result 
) const [virtual]
NOX::Abstract::Group::ReturnType NOX::Abstract::Group::applyJacobianMultiVector ( const NOX::Abstract::MultiVector input,
NOX::Abstract::MultiVector result 
) const [virtual]
NOX::Abstract::Group::ReturnType NOX::Abstract::Group::applyJacobianTranspose ( const NOX::Abstract::Vector input,
NOX::Abstract::Vector result 
) const [virtual]
NOX::Abstract::Group::ReturnType NOX::Abstract::Group::applyJacobianTransposeMultiVector ( const NOX::Abstract::MultiVector input,
NOX::Abstract::MultiVector result 
) const [virtual]
NOX::Abstract::Group::ReturnType NOX::Abstract::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 in NOX::Epetra::Group.

References NotDefined.

Referenced by NOX::Direction::NonlinearCG::compute().

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

applyRightPreconditioning for multiple right-hand sides

The default implementation here calls applyRightPreconditioning() for each right hand side serially but should be overloaded if a block method is available.

References NOX::Abstract::MultiVector::numVectors(), and Ok.

virtual Teuchos::RCP<NOX::Abstract::Group> NOX::Abstract::Group::clone ( NOX::CopyType  type = NOX::DeepCopy) const [pure 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.

Implemented in NOX::Multiphysics::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ArcLengthGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::MultiContinuation::NaturalGroup, LOCA::PhaseTransition::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, LOCA::TurningPoint::MooreSpence::ExtendedGroup, LOCA::Epetra::Group, LOCA::LAPACK::Group, LOCA::Thyra::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, and NOX::LAPACK::Group.

Referenced by NOX::Direction::Broyden::compute(), NOX::Thyra::WeightedMeritFunction::computeSlope(), NOX::LineSearch::Utils::Slope::computeSlopeWithOutJac(), NOX::Epetra::MatrixFree::setGroupForComputeF(), and NOX::Epetra::FiniteDifference::setGroupForComputeF().

virtual NOX::Abstract::Group::ReturnType NOX::Abstract::Group::computeF ( ) [pure 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:

Implemented in NOX::Multiphysics::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::PhaseTransition::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, LOCA::TurningPoint::MooreSpence::ExtendedGroup, LOCA::Epetra::Group, LOCA::LAPACK::Group, LOCA::Thyra::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, and NOX::LAPACK::Group.

Referenced by NOX::LineSearch::NonlinearCG::compute(), NOX::LineSearch::Backtrack::compute(), NOX::Direction::SteepestDescent::compute(), NOX::Direction::NonlinearCG::compute(), NOX::Direction::Newton::compute(), NOX::Direction::Broyden::compute(), LOCA::DerivUtils::computeDfDp(), NOX::Solver::TensorBased::computeTensorDirection(), NOX::Solver::TensorBased::implementGlobalStrategy(), NOX::Solver::InexactTrustRegionBased::iterateInexact(), NOX::Solver::InexactTrustRegionBased::iterateStandard(), NOX::Solver::TensorBased::performLinesearch(), NOX::Solver::TrustRegionBased::step(), NOX::Solver::TensorBased::step(), NOX::Solver::LineSearchBased::step(), NOX::Multiphysics::Solver::FixedPointBased::step(), and NOX::LineSearch::Polynomial::updateGrp().

NOX::Abstract::Group::ReturnType NOX::Abstract::Group::computeGradient ( ) [virtual]
NOX::Abstract::Group::ReturnType NOX::Abstract::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 in LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::PhaseTransition::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, LOCA::TurningPoint::MooreSpence::ExtendedGroup, LOCA::Epetra::Group, LOCA::LAPACK::Group, LOCA::Thyra::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, and NOX::LAPACK::Group.

References NotDefined.

Referenced by NOX::Direction::SteepestDescent::compute(), NOX::Direction::NonlinearCG::compute(), NOX::Direction::Newton::compute(), NOX::Direction::Broyden::compute(), LOCA::DerivUtils::computeDJnDp(), LOCA::DerivUtils::computeDJnDxa(), LOCA::DerivUtils::computeDwtJDp(), LOCA::DerivUtils::computeDwtJnDp(), LOCA::DerivUtils::computeDwtJnDx(), NOX::Solver::TensorBased::computeTensorDirection(), and NOX::Solver::InexactTrustRegionBased::iterateInexact().

NOX::Abstract::Group::ReturnType NOX::Abstract::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 in LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::PhaseTransition::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, LOCA::TurningPoint::MooreSpence::ExtendedGroup, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, and NOX::LAPACK::Group.

References NotDefined.

Referenced by NOX::Direction::Newton::compute(), and NOX::Solver::TensorBased::computeTensorDirection().

virtual void NOX::Abstract::Group::computeX ( const NOX::Abstract::Group grp,
const NOX::Abstract::Vector d,
double  step 
) [pure virtual]
virtual double NOX::Abstract::Group::getNormF ( ) const [pure virtual]
NOX::Abstract::Group::ReturnType NOX::Abstract::Group::getNormLastLinearSolveResidual ( double &  residual) const [virtual]

Return the norm of the last linear solve residual as the result of either a call to computeNewton() or applyJacobianInverse().

Returns:

Reimplemented in NOX::Epetra::Group.

References NotDefined.

bool NOX::Abstract::Group::isGradient ( ) const [virtual]
bool NOX::Abstract::Group::isJacobian ( ) const [virtual]
bool NOX::Abstract::Group::isNewton ( ) const [virtual]
virtual NOX::Abstract::Group& NOX::Abstract::Group::operator= ( const NOX::Abstract::Group source) [pure virtual]
virtual void NOX::Abstract::Group::setX ( const NOX::Abstract::Vector y) [pure virtual]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends