NOX::Direction::Broyden::BroydenMemoryUnit Class Reference

Utility class for NOX::Direction::Broyden::BroydenMemory. More...

#include <NOX_Direction_Broyden.H>

Collaboration diagram for NOX::Direction::Broyden::BroydenMemoryUnit:

[legend]List of all members.

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::RefCountPtr< const NOX::Abstract::Vector >	sPtr () const
	Get pointer to .
double	step () const
	Get the step, .
double	sNormSqr () const
	Get .

---

Detailed Description

Utility class for NOX::Direction::Broyden::BroydenMemory.

Stores an -vector and associated information for the limited-memory Broyden update.

Throughout the docuementation of this class, we make the following associations.

• #sptr stores the vector
• #lambda stores the value of
• #snormsqr stores the values of

---

Constructor & Destructor Documentation

NOX::Direction::Broyden::BroydenMemoryUnit::BroydenMemoryUnit (   )

Constructor. Sets #sptr to NULL, and #lambda and #snormsqr to zero.

NOX::Direction::Broyden::BroydenMemoryUnit::~BroydenMemoryUnit (   )

Destuctor. Deletes #sptr.

---

Member Function Documentation

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 . Note: If #sptr is NULL, space is allocated by cloning the input vector (see NOX::Abstract::Vector::clone).

void NOX::Direction::Broyden::BroydenMemoryUnit::setStep (  double  step  )

Update the step length. Set to the input argument. If , then reset and .

---

The documentation for this class was generated from the following files:

• NOX_Direction_Broyden.H
• NOX_Direction_Broyden.C

---