#include <NOX_Abstract_Group.H>
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::Group & | operator= (const NOX::Abstract::Group &source)=0 |
Copies the source group into this group. | |
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 ¶ms) |
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 ¶ms, 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 ¶ms, 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 ¶ms, 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 ¶ms, 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 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 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. |
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.
Definition at line 81 of file NOX_Abstract_Group.H.
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.
Definition at line 93 of file NOX_Abstract_Group.H.
NOX::Abstract::Group::Group | ( | ) | [inline] |
Constructor.
Definition at line 117 of file NOX_Abstract_Group.H.
virtual NOX::Abstract::Group::~Group | ( | ) | [inline, virtual] |
Destructor.
Reimplemented in NOX::Multiphysics::Group, NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Abstract::Group, LOCA::Homotopy::Group, LOCA::LAPACK::Group, LOCA::Thyra::Group, and LOCA::Epetra::Group.
Definition at line 120 of file NOX_Abstract_Group.H.
virtual NOX::Abstract::Group& NOX::Abstract::Group::operator= | ( | const NOX::Abstract::Group & | source | ) | [pure virtual] |
Copies the source group into this group.
Implemented in NOX::Multiphysics::Group, NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Abstract::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::FiniteDifferenceGroup, LOCA::MultiContinuation::NaturalGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, LOCA::TurningPoint::MooreSpence::ExtendedGroup, LOCA::LAPACK::Group, LOCA::Thyra::Group, and LOCA::Epetra::Group.
virtual void NOX::Abstract::Group::setX | ( | const NOX::Abstract::Vector & | y | ) | [pure virtual] |
Set the solution vector x to y.
Throw an error if the copy fails.
Implemented in NOX::Multiphysics::Group, NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Referenced by LOCA::DerivUtils::computeDCeDxa(), LOCA::DerivUtils::computeDJnDxa(), LOCA::DerivUtils::computeDwtCeDx(), LOCA::DerivUtils::computeDwtJnDx(), and LOCA::DerivUtils::perturbXVec().
virtual void NOX::Abstract::Group::computeX | ( | const NOX::Abstract::Group & | grp, | |
const NOX::Abstract::Vector & | d, | |||
double | step | |||
) | [pure virtual] |
Compute x = grp.x + step * d.
Let denote this group's solution vector. Let
denote the result of grp.getX(). Then set
Throw an error if the copy fails.
Implemented in NOX::Multiphysics::Group, NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Referenced by NOX::LineSearch::NonlinearCG::compute(), NOX::LineSearch::FullStep::compute(), NOX::LineSearch::Backtrack::compute(), NOX::LineSearch::MoreThuente::cvsrch(), NOX::Solver::TensorBased::implementGlobalStrategy(), NOX::Solver::InexactTrustRegionBased::iterateInexact(), NOX::Solver::InexactTrustRegionBased::iterateStandard(), NOX::Solver::TensorBased::performLinesearch(), NOX::Solver::TrustRegionBased::step(), and NOX::LineSearch::Polynomial::updateGrp().
virtual NOX::Abstract::Group::ReturnType NOX::Abstract::Group::computeF | ( | ) | [pure virtual] |
Compute and store F(x).
Implemented in NOX::Multiphysics::Group, NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, LOCA::TurningPoint::MooreSpence::ExtendedGroup, LOCA::LAPACK::Group, LOCA::Thyra::Group, and LOCA::Epetra::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::LineSearch::MoreThuente::cvsrch(), NOX::Solver::TensorBased::implementGlobalStrategy(), NOX::Solver::InexactTrustRegionBased::iterateInexact(), NOX::Solver::InexactTrustRegionBased::iterateStandard(), NOX::Solver::TensorBased::performLinesearch(), NOX::StatusTest::NormF::relativeSetup(), 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::computeJacobian | ( | ) | [virtual] |
Compute and store Jacobian.
Recall that
The Jacobian is denoted by and defined by
Reimplemented in NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, LOCA::TurningPoint::MooreSpence::ExtendedGroup, LOCA::LAPACK::Group, LOCA::Thyra::Group, and LOCA::Epetra::Group.
Definition at line 48 of file NOX_Abstract_Group.C.
References NotDefined.
Referenced by NOX::Direction::SteepestDescent::compute(), NOX::Direction::NonlinearCG::compute(), NOX::Direction::Newton::compute(), LOCA::DerivUtils::computeDJnDp(), LOCA::DerivUtils::computeDJnDxa(), LOCA::DerivUtils::computeDwtJDp(), LOCA::DerivUtils::computeDwtJnDp(), LOCA::DerivUtils::computeDwtJnDx(), NOX::Solver::TensorBased::computeTensorDirection(), NOX::LineSearch::MoreThuente::cvsrch(), and NOX::Solver::InexactTrustRegionBased::iterateInexact().
NOX::Abstract::Group::ReturnType NOX::Abstract::Group::computeGradient | ( | ) | [virtual] |
Compute and store gradient.
We can pose the nonlinear equation problem as an optimization problem as follows:
In that case, the gradient (of ) is defined as
Reimplemented in NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Definition at line 54 of file NOX_Abstract_Group.C.
References NotDefined.
Referenced by NOX::LineSearch::MoreThuente::cvsrch().
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
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
params
Reimplemented in NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Definition at line 60 of file NOX_Abstract_Group.C.
References NotDefined.
Referenced by NOX::Direction::Newton::compute(), and NOX::Solver::TensorBased::computeTensorDirection().
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
where is the Jacobian,
is the input vector, and
is the result vector.
Reimplemented in NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Definition at line 66 of file NOX_Abstract_Group.C.
References NotDefined.
Referenced by applyJacobianMultiVector(), LOCA::DerivUtils::computeDJnDp(), LOCA::DerivUtils::computeDJnDxa(), LOCA::DerivUtils::computeDwtJnDp(), NOX::Direction::Utils::InexactNewton::computeForcingTerm(), NOX::MeritFunction::SumOfSquares::computeQuadraticMinimizer(), NOX::MeritFunction::SumOfSquares::computeQuadraticModel(), 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::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
where is the Jacobian,
is the input vector, and
is the result vector.
Reimplemented in NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Definition at line 73 of file NOX_Abstract_Group.C.
References NotDefined.
Referenced by applyJacobianTransposeMultiVector(), LOCA::DerivUtils::computeDwtJDp(), LOCA::DerivUtils::computeDwtJnDx(), and NOX::MeritFunction::SumOfSquares::computeGradient().
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
where is the Jacobian,
is the input vector, and
is the result vector.
The "Tolerance" parameter specifies that the solution should be such that
params
Reimplemented in NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Definition at line 80 of file NOX_Abstract_Group.C.
References NotDefined.
Referenced by applyJacobianInverseMultiVector(), NOX::Solver::TensorBased::computeTensorDirection(), and NOX::Solver::InexactTrustRegionBased::iterateInexact().
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 be a right preconditioner for the Jacobian
; in other words,
is a matrix such that
Compute
where is the input vector and
is the result vector.
If useTranspose is true, then the transpose of the preconditioner is applied:
The transpose preconditioner is currently only required for Tensor methods.
The "Tolerance" parameter specifies that the solution should be such that
params
Reimplemented in NOX::Epetra::Group.
Definition at line 88 of file NOX_Abstract_Group.C.
References NotDefined.
Referenced by applyRightPreconditioningMultiVector(), and NOX::Direction::NonlinearCG::compute().
NOX::Abstract::Group::ReturnType NOX::Abstract::Group::applyJacobianMultiVector | ( | const NOX::Abstract::MultiVector & | input, | |
NOX::Abstract::MultiVector & | result | |||
) | const [virtual] |
applyJacobian for multiple right-hand sides
The default implementation here calls applyJacobian() for each right hand side serially but should be overloaded if a block method is available.
Reimplemented in NOX::Thyra::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Definition at line 98 of file NOX_Abstract_Group.C.
References applyJacobian(), BadDependency, Failed, NotConverged, NotDefined, NOX::Abstract::MultiVector::numVectors(), and Ok.
Referenced by NOX::Belos::JacobianOperator::Apply().
NOX::Abstract::Group::ReturnType NOX::Abstract::Group::applyJacobianTransposeMultiVector | ( | const NOX::Abstract::MultiVector & | input, | |
NOX::Abstract::MultiVector & | result | |||
) | const [virtual] |
applyJacobianTranspose for multiple right-hand sides
The default implementation here calls applyJacobianTranspose() for each right hand side serially but should be overloaded if a block method is available.
Reimplemented in NOX::Thyra::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Definition at line 120 of file NOX_Abstract_Group.C.
References applyJacobianTranspose(), BadDependency, Failed, NotConverged, NotDefined, NOX::Abstract::MultiVector::numVectors(), and Ok.
Referenced by NOX::Belos::JacobianOperator::Apply(), and LOCA::DerivUtils::computeDwtJnDx().
NOX::Abstract::Group::ReturnType NOX::Abstract::Group::applyJacobianInverseMultiVector | ( | Teuchos::ParameterList & | params, | |
const NOX::Abstract::MultiVector & | input, | |||
NOX::Abstract::MultiVector & | result | |||
) | const [virtual] |
applyJacobianInverse for multiple right-hand sides
The default implementation here calls applyJacobianInverse() for each right hand side serially but should be overloaded if a block solver is available.
Reimplemented in NOX::LAPACK::Group, NOX::Thyra::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Definition at line 142 of file NOX_Abstract_Group.C.
References applyJacobianInverse(), BadDependency, Failed, NotConverged, NotDefined, NOX::Abstract::MultiVector::numVectors(), and Ok.
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.
Definition at line 165 of file NOX_Abstract_Group.C.
References applyRightPreconditioning(), BadDependency, Failed, NotConverged, NotDefined, NOX::Abstract::MultiVector::numVectors(), and Ok.
Referenced by NOX::Belos::PreconditionOperator::Apply().
virtual bool NOX::Abstract::Group::isF | ( | ) | const [pure virtual] |
Return true if F is valid.
Implemented in NOX::Multiphysics::Group, NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Referenced by NOX::StatusTest::NormUpdate::checkStatus(), NOX::LineSearch::NonlinearCG::computeDirectionalDerivative(), NOX::MeritFunction::SumOfSquares::computef(), NOX::MeritFunction::SumOfSquares::computeGradient(), NOX::StatusTest::NormF::computeNorm(), NOX::MeritFunction::SumOfSquares::computeQuadraticMinimizer(), NOX::LineSearch::Utils::Slope::computeSlope(), and NOX::LineSearch::Utils::Slope::computeSlopeWithOutJac().
bool NOX::Abstract::Group::isJacobian | ( | ) | const [virtual] |
Return true if the Jacobian is valid.
Reimplemented in NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Definition at line 189 of file NOX_Abstract_Group.C.
Referenced by NOX::Direction::NonlinearCG::compute(), LOCA::DerivUtils::computeDJnDxa(), NOX::Direction::Utils::InexactNewton::computeForcingTerm(), NOX::MeritFunction::SumOfSquares::computeGradient(), NOX::MeritFunction::SumOfSquares::computeQuadraticMinimizer(), NOX::MeritFunction::SumOfSquares::computeSlope(), NOX::Solver::InexactTrustRegionBased::iterateInexact(), and NOX::Direction::Newton::resetForcingTerm().
bool NOX::Abstract::Group::isGradient | ( | ) | const [virtual] |
Return true if the gradient is valid.
Reimplemented in NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Definition at line 194 of file NOX_Abstract_Group.C.
Referenced by NOX::LineSearch::Utils::Slope::computeSlope().
bool NOX::Abstract::Group::isNewton | ( | ) | const [virtual] |
Return true if the Newton direction is valid.
Reimplemented in NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Definition at line 199 of file NOX_Abstract_Group.C.
virtual const NOX::Abstract::Vector& NOX::Abstract::Group::getX | ( | ) | const [pure virtual] |
Return solution vector.
Implemented in NOX::Multiphysics::Group, NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Referenced by NOX::StatusTest::NormWRMS::checkStatus(), NOX::StatusTest::NormUpdate::checkStatus(), NOX::StatusTest::FiniteValue::checkStatus(), NOX::Direction::NonlinearCG::compute(), LOCA::DerivUtils::computeDCeDxa(), LOCA::Epetra::ModelEvaluatorInterface::computeDfDp(), NOX::LineSearch::NonlinearCG::computeDirectionalDerivative(), LOCA::DerivUtils::computeDJnDxa(), LOCA::DerivUtils::computeDwtCeDx(), LOCA::DerivUtils::computeDwtJnDx(), LOCA::Eigensolver::DGGEVStrategy::computeEigenvalues(), LOCA::Eigensolver::AnasaziStrategy::computeEigenvalues(), NOX::Direction::Utils::InexactNewton::computeForcingTerm(), NOX::StatusTest::NormF::computeNorm(), NOX::LineSearch::Utils::Slope::computeSlopeWithOutJac(), NOX::MeritFunction::SumOfSquares::computeSlopeWithoutJacobian(), NOX::Solver::TensorBased::computeTensorDirection(), NOX::Direction::Newton::resetForcingTerm(), NOX::Epetra::BroydenOperator::runPostIterate(), and Thyra::NOXNonlinearSolver::solve().
virtual const NOX::Abstract::Vector& NOX::Abstract::Group::getF | ( | ) | const [pure virtual] |
Return F(x).
Implemented in NOX::Multiphysics::Group, NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Referenced by NOX::StatusTest::FiniteValue::checkStatus(), NOX::LineSearch::NonlinearCG::compute(), NOX::Direction::NonlinearCG::compute(), NOX::Direction::Broyden::compute(), LOCA::DerivUtils::computeDfDp(), NOX::LineSearch::NonlinearCG::computeDirectionalDerivative(), NOX::Direction::Utils::InexactNewton::computeForcingTerm(), NOX::MeritFunction::SumOfSquares::computeGradient(), NOX::StatusTest::NormF::computeNorm(), NOX::MeritFunction::SumOfSquares::computeQuadraticMinimizer(), NOX::MeritFunction::SumOfSquares::computeQuadraticModel(), NOX::MeritFunction::SumOfSquares::computeSlope(), NOX::LineSearch::Utils::Slope::computeSlope(), NOX::LineSearch::Utils::Slope::computeSlopeWithOutJac(), NOX::MeritFunction::SumOfSquares::computeSlopeWithoutJacobian(), NOX::Solver::TensorBased::computeTensorDirection(), NOX::Solver::TensorBased::getDirectionalDerivative(), NOX::Solver::TensorBased::getNormModelResidual(), NOX::Solver::InexactTrustRegionBased::iterateInexact(), NOX::Direction::Newton::resetForcingTerm(), and NOX::Epetra::BroydenOperator::runPostIterate().
virtual double NOX::Abstract::Group::getNormF | ( | ) | const [pure virtual] |
Return 2-norm of F(x).
In other words,
Implemented in NOX::Multiphysics::Group, NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Referenced by NOX::StatusTest::Stagnation::checkStatus(), NOX::StatusTest::FiniteValue::checkStatus(), NOX::StatusTest::Divergence::checkStatus(), NOX::Direction::SteepestDescent::compute(), NOX::MeritFunction::SumOfSquares::computef(), NOX::Direction::Utils::InexactNewton::computeForcingTerm(), NOX::StatusTest::NormF::computeNorm(), NOX::Solver::TensorBased::computeTensorDirection(), NOX::LineSearch::Polynomial::computeValue(), NOX::LineSearch::MoreThuente::cvsrch(), NOX::Direction::Broyden::doRestart(), NOX::Solver::TensorBased::implementGlobalStrategy(), NOX::Solver::TensorBased::performLinesearch(), NOX::Solver::TensorBased::printDirectionInfo(), NOX::Direction::Newton::resetForcingTerm(), and NOX::Solver::TrustRegionBased::step().
virtual const NOX::Abstract::Vector& NOX::Abstract::Group::getGradient | ( | ) | const [pure virtual] |
Return gradient.
Implemented in NOX::Multiphysics::Group, NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Referenced by NOX::LineSearch::Utils::Slope::computeSlope().
virtual const NOX::Abstract::Vector& NOX::Abstract::Group::getNewton | ( | ) | const [pure virtual] |
Return Newton direction.
Implemented in NOX::Multiphysics::Group, NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::Group, LOCA::Homotopy::DeflatedGroup, LOCA::Homotopy::Group, LOCA::Hopf::MinimallyAugmented::ExtendedGroup, LOCA::Hopf::MooreSpence::ExtendedGroup, LOCA::MultiContinuation::ConstrainedGroup, LOCA::MultiContinuation::ExtendedGroup, LOCA::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, and LOCA::TurningPoint::MooreSpence::ExtendedGroup.
Referenced by NOX::Direction::Newton::compute(), and NOX::Solver::TensorBased::computeTensorDirection().
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().
Reimplemented in NOX::Epetra::Group.
Definition at line 205 of file NOX_Abstract_Group.C.
References NotDefined.
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.
Implemented in NOX::Multiphysics::Group, NOX::LAPACK::Group, NOX::Epetra::Group, NOX::Thyra::Group, NOX::Petsc::Group, NOX::Belos::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::Pitchfork::MinimallyAugmented::ExtendedGroup, LOCA::Pitchfork::MooreSpence::ExtendedGroup, LOCA::TurningPoint::MinimallyAugmented::ExtendedGroup, LOCA::TurningPoint::MooreSpence::ExtendedGroup, LOCA::LAPACK::Group, LOCA::Thyra::Group, and LOCA::Epetra::Group.
Referenced by NOX::Direction::Broyden::compute(), NOX::LineSearch::NonlinearCG::computeDirectionalDerivative(), NOX::LineSearch::Utils::Slope::computeSlopeWithOutJac(), NOX::MeritFunction::SumOfSquares::computeSlopeWithoutJacobian(), NOX::Epetra::MatrixFree::setGroupForComputeF(), and NOX::Epetra::FiniteDifference::setGroupForComputeF().