Aristos  Development
 All Classes Functions Pages
Public Member Functions | List of all members
Aristos::YUEpetraVector Class Reference

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

#include <Aristos_YUEpetraVector.hpp>

Inheritance diagram for Aristos::YUEpetraVector:
Inheritance graph
[legend]
Collaboration diagram for Aristos::YUEpetraVector:
Collaboration graph
[legend]

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
 
Teuchos::RefCountPtr< const
Epetra_MultiVector > 
getUVector () const
 
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< VectorcreateVector () const
 

Detailed Description

The Aristos::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 Aristos::Vector class. Common use: optimal control. The vector y_epetra_vec represents the state variables, the vector u_epetra_vec represents the control variables.

Member Function Documentation

Teuchos::RefCountPtr< Vector > Aristos::YUEpetraVector::createVector ( ) const
virtual

Clone to make a new (uninitialized) vector.

Implements Aristos::Vector.

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

Returns a reference counted pointer to the private u_epetra_vec data container ("control variables").

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

Returns a reference counted pointer to the private y_epetra_vec data container ("state variables").


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