#include <NOX_Direction_Broyden.H>
Public Member Functions | |
BroydenMemoryUnit () | |
Constructor. | |
~BroydenMemoryUnit () | |
Destuctor. | |
void | reset (const NOX::Abstract::Vector &d) |
Reset this memory unit with a new update vector. | |
void | setStep (double step) |
Update the step length. | |
Teuchos::RCP< const NOX::Abstract::Vector > | sPtr () const |
Get pointer to ![]() | |
double | step () const |
Get the step, ![]() | |
double | sNormSqr () const |
Get ![]() | |
Private Attributes | |
Teuchos::RCP < NOX::Abstract::Vector > | sptr |
A pointer to the ![]() | |
double | lambda |
The associated step length, i.e., ![]() | |
double | snormsqr |
The norm of ![]() ![]() |
Stores an -vector and associated information for the limited-memory Broyden update.
Throughout the docuementation of this class, we make the following associations.
Definition at line 141 of file NOX_Direction_Broyden.H.
NOX::Direction::Broyden::BroydenMemoryUnit::BroydenMemoryUnit | ( | ) |
NOX::Direction::Broyden::BroydenMemoryUnit::~BroydenMemoryUnit | ( | ) |
void NOX::Direction::Broyden::BroydenMemoryUnit::reset | ( | const NOX::Abstract::Vector & | d | ) |
Reset this memory unit with a new update vector.
Let the vector represent the input argument. Then we set
. Also recalculates
and sets
.
Definition at line 66 of file NOX_Direction_Broyden.C.
References NOX::Abstract::Vector::clone(), NOX::DeepCopy, lambda, snormsqr, and sptr.
void NOX::Direction::Broyden::BroydenMemoryUnit::setStep | ( | double | step | ) |
Update the step length.
Set to the input argument. If
, then reset
and
.
Definition at line 81 of file NOX_Direction_Broyden.C.
Teuchos::RCP< const NOX::Abstract::Vector > NOX::Direction::Broyden::BroydenMemoryUnit::sPtr | ( | ) | const |
double NOX::Direction::Broyden::BroydenMemoryUnit::step | ( | ) | const |
double NOX::Direction::Broyden::BroydenMemoryUnit::sNormSqr | ( | ) | const |
Teuchos::RCP<NOX::Abstract::Vector> NOX::Direction::Broyden::BroydenMemoryUnit::sptr [private] |
double NOX::Direction::Broyden::BroydenMemoryUnit::lambda [private] |
The associated step length, i.e., .
The step is zero if the direction has not yet been scaled via setStep().
Definition at line 202 of file NOX_Direction_Broyden.H.
Referenced by BroydenMemoryUnit(), reset(), setStep(), and step().
double NOX::Direction::Broyden::BroydenMemoryUnit::snormsqr [private] |
The norm of squared, i.e.,
.
Definition at line 205 of file NOX_Direction_Broyden.H.
Referenced by BroydenMemoryUnit(), reset(), setStep(), and sNormSqr().