EpetraExt Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
GenSQP::YUEpetraVector Class Reference

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

#include <GenSQP_YUEpetraVector.hpp>

Inheritance diagram for GenSQP::YUEpetraVector:
Inheritance graph
[legend]

Public Member Functions

 YUEpetraVector (const Teuchos::RCP< Epetra_MultiVector > &y_epetra_vec, const Teuchos::RCP< Epetra_MultiVector > &u_epetra_vec)
 
- Public Member Functions inherited from GenSQP::Vector
virtual ~Vector ()
 
virtual double innerProd (const Vector &x) const =0
 Returns inner(*this,x).
 
virtual void linComb (const double &alpha, const Vector &x, const double &beta=1.0)=0
 y = alpha*x + beta*y where y == *this.
 
virtual void Scale (const double &alpha)=0
 y = alpha*y where y == *this.
 
virtual void Set (const double &alpha)=0
 y = alpha where y == *this.
 
virtual void Set (const double &alpha, const Vector &x)=0
 y = alpha*x where y == *this.
 
virtual Teuchos::RCP< VectorcreateVector () const =0
 Clone to make a new (uninitialized) vector.
 

Private Attributes

Teuchos::RCP< Epetra_MultiVectory_epetra_vec_
 
Teuchos::RCP< Epetra_MultiVectoru_epetra_vec_
 

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::RCP< VectorcreateVector () const
 Clone to make a new (uninitialized) vector.
 
Teuchos::RCP< const Epetra_MultiVectorgetYVector () const
 Returns a reference counted pointer to the private y_epetra_vec data container ("state variables").
 
Teuchos::RCP< const Epetra_MultiVectorgetUVector () 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 63 of file GenSQP_YUEpetraVector.hpp.

Constructor & Destructor Documentation

◆ YUEpetraVector()

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

Definition at line 48 of file GenSQP_YUEpetraVector.cpp.

Member Function Documentation

◆ innerProd()

double GenSQP::YUEpetraVector::innerProd ( const Vector x) const
virtual

Returns inner(*this,x).

Implements GenSQP::Vector.

Definition at line 55 of file GenSQP_YUEpetraVector.cpp.

◆ linComb()

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 68 of file GenSQP_YUEpetraVector.cpp.

◆ Scale()

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

y = alpha*y where y == *this.

Implements GenSQP::Vector.

Definition at line 76 of file GenSQP_YUEpetraVector.cpp.

◆ Set() [1/2]

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

y = alpha where y == *this.

Implements GenSQP::Vector.

Definition at line 83 of file GenSQP_YUEpetraVector.cpp.

◆ Set() [2/2]

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

y = alpha*x where y == *this.

Implements GenSQP::Vector.

Definition at line 90 of file GenSQP_YUEpetraVector.cpp.

◆ createVector()

Teuchos::RCP< Vector > GenSQP::YUEpetraVector::createVector ( ) const
virtual

Clone to make a new (uninitialized) vector.

Implements GenSQP::Vector.

Definition at line 98 of file GenSQP_YUEpetraVector.cpp.

◆ getYVector()

Teuchos::RCP< 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 109 of file GenSQP_YUEpetraVector.cpp.

◆ getUVector()

Teuchos::RCP< 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 114 of file GenSQP_YUEpetraVector.cpp.

Member Data Documentation

◆ y_epetra_vec_

Teuchos::RCP<Epetra_MultiVector> GenSQP::YUEpetraVector::y_epetra_vec_
private

Definition at line 67 of file GenSQP_YUEpetraVector.hpp.

◆ u_epetra_vec_

Teuchos::RCP<Epetra_MultiVector> GenSQP::YUEpetraVector::u_epetra_vec_
private

Definition at line 68 of file GenSQP_YUEpetraVector.hpp.


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