GenSQP::YUEpetraVector Class Reference

The GenSQP::Vector / (y,u) Epetra_MultiVector adapter class. More...

#include <GenSQP_YUEpetraVector.hpp>

Inheritance diagram for GenSQP::YUEpetraVector:

[legend]List of all members.

Overridden from Vector
double	innerProd (const Vector &x) const
	Returns inner(*this,x).
void	linComb (const double &alpha, const Vector &x, const double &beta)
	y = alpha*x + beta*y where y == *this.
void	Scale (const double &alpha)
	y = alpha*y where y == *this.
void	Set (const double &alpha)
	y = alpha where y == *this.
void	Set (const double &alpha, const Vector &x)
	y = alpha*x where y == *this.
Teuchos::RefCountPtr< Vector >	createVector () const
	Clone to make a new (uninitialized) vector.
Public Member Functions
	YUEpetraVector (const Teuchos::RefCountPtr< Epetra_MultiVector > &y_epetra_vec, const Teuchos::RefCountPtr< Epetra_MultiVector > &u_epetra_vec)
Teuchos::RefCountPtr< const Epetra_MultiVector >	getYVector () const
	Returns a reference counted pointer to the private y_epetra_vec data container ("state variables").
Teuchos::RefCountPtr< const Epetra_MultiVector >	getUVector () const
	Returns a reference counted pointer to the private u_epetra_vec data container ("control variables").

---

Detailed Description

The GenSQP::Vector / (y,u) Epetra_MultiVector adapter class.

Holds a pointer to two Epetra_MultiVectors y_epetra_vec and u_epetra_vec and implements the member functions of the GenSQP::Vector class. Common use: optimal control. The vector y_epetra_vec represents the state variables, the vector u_epetra_vec represents the control variables.

Definition at line 20 of file GenSQP_YUEpetraVector.hpp.

---

Constructor & Destructor Documentation

GenSQP::YUEpetraVector::YUEpetraVector (  const Teuchos::RefCountPtr< Epetra_MultiVector > &  y_epetra_vec, const Teuchos::RefCountPtr< Epetra_MultiVector > &  u_epetra_vec )

Definition at line 5 of file GenSQP_YUEpetraVector.cpp.

---

Member Function Documentation

double GenSQP::YUEpetraVector::innerProd (  const Vector &  x  )  const [virtual]

Returns inner(*this,x). Implements GenSQP::Vector. Definition at line 12 of file GenSQP_YUEpetraVector.cpp.

void GenSQP::YUEpetraVector::linComb (  const double &  alpha, const Vector &  x, const double &  beta )  [virtual]

y = alpha*x + beta*y where y == *this. Implements GenSQP::Vector. Definition at line 25 of file GenSQP_YUEpetraVector.cpp.

void GenSQP::YUEpetraVector::Scale (  const double &  alpha  )  [virtual]

y = alpha*y where y == *this. Implements GenSQP::Vector. Definition at line 33 of file GenSQP_YUEpetraVector.cpp.

void GenSQP::YUEpetraVector::Set (  const double &  alpha  )  [virtual]

y = alpha where y == *this. Implements GenSQP::Vector. Definition at line 40 of file GenSQP_YUEpetraVector.cpp.

void GenSQP::YUEpetraVector::Set (  const double &  alpha, const Vector &  x )  [virtual]

y = alpha*x where y == *this. Implements GenSQP::Vector. Definition at line 47 of file GenSQP_YUEpetraVector.cpp.

Teuchos::RefCountPtr< Vector > GenSQP::YUEpetraVector::createVector (   )  const [virtual]

Clone to make a new (uninitialized) vector. Implements GenSQP::Vector. Definition at line 55 of file GenSQP_YUEpetraVector.cpp.

Teuchos::RefCountPtr< const Epetra_MultiVector > GenSQP::YUEpetraVector::getYVector (   )  const

Returns a reference counted pointer to the private y_epetra_vec data container ("state variables"). Definition at line 66 of file GenSQP_YUEpetraVector.cpp.

Teuchos::RefCountPtr< const Epetra_MultiVector > GenSQP::YUEpetraVector::getUVector (   )  const

Returns a reference counted pointer to the private u_epetra_vec data container ("control variables"). Definition at line 71 of file GenSQP_YUEpetraVector.cpp.

---

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

• GenSQP_YUEpetraVector.hpp
• GenSQP_YUEpetraVector.cpp

---