Xyce  6.1
Xyce::Linear::ROL_XyceVector< Real > Class Template Reference

#include <ROL_XyceVector.hpp>

Inheritance diagram for Xyce::Linear::ROL_XyceVector< Real >:
Collaboration diagram for Xyce::Linear::ROL_XyceVector< Real >:

Public Member Functions

virtual ~ROL_XyceVector ()
 
 ROL_XyceVector (const int size, const MultiVector &xyce_multi_vec)
 
 ROL_XyceVector (const Teuchos::RCP< std::vector< Teuchos::RCP< Vector > > > &xyce_multi_vec)
 
 ROL_XyceVector (std::vector< Vector * > &xyce_multi_vec)
 
Teuchos::RCP< const std::vector< Teuchos::RCP< Vector > > > getVector () const
 
Teuchos::RCP< std::vector< Teuchos::RCP< Vector > > > getVector ()
 
void plus (const ::ROL::Vector< Real > &x)
 Compute $y \leftarrow x + y$ where $y = \mbox{*this}$. More...
 
void scale (const Real alpha)
 Compute $y \leftarrow \alpha y$ where $y = \mbox{*this}$. More...
 
Real dot (const ::ROL::Vector< Real > &x) const
 Returns $ \langle y,x \rangle $ where $y = \mbox{*this}$. More...
 
Real norm () const
 Returns $ \| y \| $ where $y = \mbox{*this}$. More...
 
Teuchos::RCP< ::ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
void randomize ()
 
void print (std::ostream &outStream=std::cout)
 
virtual void axpy (const Real alpha, const ::ROL::Vector< Real > &x)
 Compute $y \leftarrow \alpha x + y$ where $y = \mbox{*this}$. More...
 
virtual void zero ()
 Set to zero vector. More...
 
virtual void putScalar (Real alpha)
 

Private Attributes

Teuchos::RCP< std::vector< Teuchos::RCP< Vector > > > xyce_multi_vec_
 
int size_
 

Detailed Description

template<class Real>
class Xyce::Linear::ROL_XyceVector< Real >

Definition at line 37 of file ROL_XyceVector.hpp.

Constructor & Destructor Documentation

template<class Real>
virtual Xyce::Linear::ROL_XyceVector< Real >::~ROL_XyceVector ( )
inlinevirtual

Definition at line 45 of file ROL_XyceVector.hpp.

template<class Real>
Xyce::Linear::ROL_XyceVector< Real >::ROL_XyceVector ( const int  size,
const MultiVector &  xyce_multi_vec 
)
inline

Definition at line 48 of file ROL_XyceVector.hpp.

template<class Real>
Xyce::Linear::ROL_XyceVector< Real >::ROL_XyceVector ( const Teuchos::RCP< std::vector< Teuchos::RCP< Vector > > > &  xyce_multi_vec)
inline

Definition at line 58 of file ROL_XyceVector.hpp.

template<class Real>
Xyce::Linear::ROL_XyceVector< Real >::ROL_XyceVector ( std::vector< Vector * > &  xyce_multi_vec)
inline

Definition at line 63 of file ROL_XyceVector.hpp.

Member Function Documentation

template<class Real>
virtual void Xyce::Linear::ROL_XyceVector< Real >::axpy ( const Real  alpha,
const ::ROL::Vector< Real > &  x 
)
inlinevirtual

Compute $y \leftarrow \alpha x + y$ where $y = \mbox{*this}$.

Definition at line 164 of file ROL_XyceVector.hpp.

template<class Real>
Teuchos::RCP< ::ROL::Vector<Real> > Xyce::Linear::ROL_XyceVector< Real >::clone ( ) const
inline

Clone to make a new (uninitialized) vector.

Definition at line 128 of file ROL_XyceVector.hpp.

template<class Real>
Real Xyce::Linear::ROL_XyceVector< Real >::dot ( const ::ROL::Vector< Real > &  x) const
inline

Returns $ \langle y,x \rangle $ where $y = \mbox{*this}$.

Definition at line 104 of file ROL_XyceVector.hpp.

template<class Real>
Teuchos::RCP<const std::vector<Teuchos::RCP<Vector> > > Xyce::Linear::ROL_XyceVector< Real >::getVector ( ) const
inline

Definition at line 73 of file ROL_XyceVector.hpp.

template<class Real>
Teuchos::RCP<std::vector<Teuchos::RCP<Vector> > > Xyce::Linear::ROL_XyceVector< Real >::getVector ( )
inline

Definition at line 78 of file ROL_XyceVector.hpp.

template<class Real>
Real Xyce::Linear::ROL_XyceVector< Real >::norm ( ) const
inline

Returns $ \| y \| $ where $y = \mbox{*this}$.

Definition at line 116 of file ROL_XyceVector.hpp.

template<class Real>
void Xyce::Linear::ROL_XyceVector< Real >::plus ( const ::ROL::Vector< Real > &  x)
inline

Compute $y \leftarrow x + y$ where $y = \mbox{*this}$.

Definition at line 85 of file ROL_XyceVector.hpp.

template<class Real>
void Xyce::Linear::ROL_XyceVector< Real >::print ( std::ostream &  outStream = std::cout)
inline

Definition at line 156 of file ROL_XyceVector.hpp.

template<class Real>
virtual void Xyce::Linear::ROL_XyceVector< Real >::putScalar ( Real  alpha)
inlinevirtual

Definition at line 179 of file ROL_XyceVector.hpp.

template<class Real>
void Xyce::Linear::ROL_XyceVector< Real >::randomize ( )
inline

Definition at line 150 of file ROL_XyceVector.hpp.

template<class Real>
void Xyce::Linear::ROL_XyceVector< Real >::scale ( const Real  alpha)
inline

Compute $y \leftarrow \alpha y$ where $y = \mbox{*this}$.

Definition at line 96 of file ROL_XyceVector.hpp.

template<class Real>
virtual void Xyce::Linear::ROL_XyceVector< Real >::zero ( )
inlinevirtual

Set to zero vector.

Definition at line 173 of file ROL_XyceVector.hpp.

Member Data Documentation

template<class Real>
int Xyce::Linear::ROL_XyceVector< Real >::size_
private

Definition at line 42 of file ROL_XyceVector.hpp.

template<class Real>
Teuchos::RCP< std::vector<Teuchos::RCP<Vector> > > Xyce::Linear::ROL_XyceVector< Real >::xyce_multi_vec_
private

Definition at line 41 of file ROL_XyceVector.hpp.


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