Public Member Functions | Private Attributes
Sundance::NonlinearProblem Class Reference

NonlinearProblem encapsulates a discrete nonlinear problem. More...

Inheritance diagram for Sundance::NonlinearProblem:
Sundance::ObjectWithClassVerbosity< NonlinearProblem > Sundance::DefaultObjectWithVerbosity Sundance::ObjectWithVerbosityBase

List of all members.

Public Member Functions

 NonlinearProblem ()
 Empty ctor.
 NonlinearProblem (const Mesh &mesh, const Expr &eqn, const Expr &bc, const Expr &test, const Expr &unk, const Expr &u0, const TSFExtended::VectorType< double > &vecType)
 Construct with a mesh, equation set, bcs, test and unknown funcs, and a vector type.
 NonlinearProblem (const Mesh &mesh, const Expr &eqn, const Expr &bc, const Expr &test, const Expr &unk, const Expr &u0, const Expr &params, const Expr &paramVals, const TSFExtended::VectorType< double > &vecType)
 Construct with a mesh, equation set, bcs, test and unknown funcs, parameters, and a vector type.
 NonlinearProblem (const RCP< Assembler > &assembler, const Expr &u0)
Expr computeSensitivities (const LinearSolver< double > &solver) const
 Compute direct sensitivities to parameters.
NOX::StatusTest::StatusType solve (const NOXSolver &solver) const
 Solve the nonlinear problem.
Expr getU0 () const
 Return the current evaluation point as a Sundance expression.
void setInitialGuess (const Expr &u0New)
 Set an initial guess.
LinearOperator< double > computeJacobianAndFunction (Vector< double > &functionValue) const
 Compute the residual and Jacobian at the current evaluation point.
void computeJacobianAndFunction (LinearOperator< double > &J, Vector< double > &resid) const
 Write the Jacobian and residual into the objects provided.
TSFExtended::Vector< double > computeFunctionValue () const
 Compute the residual at the current eval point.
void computeFunctionValue (Vector< double > &resid) const
 Write the residual into the object provided.
TSFExtended::Vector< double > getInitialGuess () const
 Get an initial guess.
LinearOperator< double > allocateJacobian () const
 Create the Jacobian object, but don't fill it in.

Private Attributes

RCP< NLOp > op_

Detailed Description

NonlinearProblem encapsulates a discrete nonlinear problem.

Definition at line 46 of file SundanceNonlinearProblem.hpp.

Constructor & Destructor Documentation

NonlinearProblem::NonlinearProblem ( )

Empty ctor.

Definition at line 58 of file SundanceNonlinearProblem.cpp.

References nlpCtorTimer().

NonlinearProblem::NonlinearProblem ( const Mesh &  mesh,
const Expr &  eqn,
const Expr &  bc,
const Expr &  test,
const Expr &  unk,
const Expr &  u0,
const TSFExtended::VectorType< double > &  vecType 
)

Construct with a mesh, equation set, bcs, test and unknown funcs, and a vector type.

Definition at line 65 of file SundanceNonlinearProblem.cpp.

NonlinearProblem::NonlinearProblem ( const Mesh &  mesh,
const Expr &  eqn,
const Expr &  bc,
const Expr &  test,
const Expr &  unk,
const Expr &  u0,
const Expr &  params,
const Expr &  paramVals,
const TSFExtended::VectorType< double > &  vecType 
)

Construct with a mesh, equation set, bcs, test and unknown funcs, parameters, and a vector type.

Definition at line 75 of file SundanceNonlinearProblem.cpp.

NonlinearProblem::NonlinearProblem ( const RCP< Assembler > &  assembler,
const Expr &  u0 
)

Definition at line 89 of file SundanceNonlinearProblem.cpp.

Member Function Documentation

LinearOperator<double> Sundance::NonlinearProblem::allocateJacobian ( ) const [inline]

Create the Jacobian object, but don't fill it in.

Definition at line 107 of file SundanceNonlinearProblem.hpp.

References op_.

TSFExtended::Vector<double> Sundance::NonlinearProblem::computeFunctionValue ( ) const [inline]

Compute the residual at the current eval point.

Definition at line 95 of file SundanceNonlinearProblem.hpp.

References op_.

void Sundance::NonlinearProblem::computeFunctionValue ( Vector< double > &  resid) const [inline]

Write the residual into the object provided.

Definition at line 99 of file SundanceNonlinearProblem.hpp.

References op_.

LinearOperator<double> Sundance::NonlinearProblem::computeJacobianAndFunction ( Vector< double > &  functionValue) const [inline]

Compute the residual and Jacobian at the current evaluation point.

Definition at line 86 of file SundanceNonlinearProblem.hpp.

References op_.

void Sundance::NonlinearProblem::computeJacobianAndFunction ( LinearOperator< double > &  J,
Vector< double > &  resid 
) const [inline]

Write the Jacobian and residual into the objects provided.

Definition at line 90 of file SundanceNonlinearProblem.hpp.

References op_.

Expr Sundance::NonlinearProblem::computeSensitivities ( const LinearSolver< double > &  solver) const [inline]

Compute direct sensitivities to parameters.

Definition at line 72 of file SundanceNonlinearProblem.hpp.

References op_.

TSFExtended::Vector<double> Sundance::NonlinearProblem::getInitialGuess ( ) const [inline]

Get an initial guess.

Definition at line 103 of file SundanceNonlinearProblem.hpp.

References op_.

Expr Sundance::NonlinearProblem::getU0 ( ) const [inline]

Return the current evaluation point as a Sundance expression.

Definition at line 79 of file SundanceNonlinearProblem.hpp.

References op_.

void Sundance::NonlinearProblem::setInitialGuess ( const Expr &  u0New) [inline]

Set an initial guess.

Definition at line 82 of file SundanceNonlinearProblem.hpp.

References op_.

NOX::StatusTest::StatusType NonlinearProblem::solve ( const NOXSolver &  solver) const

Solve the nonlinear problem.

Definition at line 97 of file SundanceNonlinearProblem.cpp.

References op_, TSFExtended::NonlinearOperator< Scalar >::setEvalPt(), and TSFExtended::NOXSolver::solve().

Member Data Documentation

RCP<NLOp> Sundance::NonlinearProblem::op_ [private]

Definition at line 111 of file SundanceNonlinearProblem.hpp.

Referenced by allocateJacobian(), computeFunctionValue(), computeJacobianAndFunction(), computeSensitivities(), getInitialGuess(), getU0(), setInitialGuess(), and solve().

Site Contact