ROL
Public Member Functions | Private Attributes | List of all members
H1VectorPrimal< Real > Class Template Reference

#include <test_04.hpp>

+ Inheritance diagram for H1VectorPrimal< Real >:

Public Member Functions

 H1VectorPrimal (const Teuchos::RCP< std::vector< Real > > &vec, const Teuchos::RCP< BurgersFEM< Real > > &fem)
 
void set (const ROL::Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
void plus (const ROL::Vector< Real > &x)
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). More...
 
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). More...
 
Real dot (const ROL::Vector< Real > &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...
 
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\). More...
 
Teuchos::RCP< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
Teuchos::RCP< const std::vector< Real > > getVector () const
 
Teuchos::RCP< std::vector< Real > > getVector ()
 
Teuchos::RCP< ROL::Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
const ROL::Vector< Real > & dual () const
 Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout. More...
 
 H1VectorPrimal (const Teuchos::RCP< std::vector< Real > > &vec, const Teuchos::RCP< BurgersFEM< Real > > &fem)
 
void set (const ROL::Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
void plus (const ROL::Vector< Real > &x)
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). More...
 
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). More...
 
Real dot (const ROL::Vector< Real > &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...
 
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\). More...
 
Teuchos::RCP< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
Teuchos::RCP< const std::vector< Real > > getVector () const
 
Teuchos::RCP< std::vector< Real > > getVector ()
 
Teuchos::RCP< ROL::Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
const ROL::Vector< Real > & dual () const
 Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout. More...
 
 H1VectorPrimal (const Teuchos::RCP< std::vector< Real > > &vec, const Teuchos::RCP< BurgersFEM< Real > > &fem)
 
void set (const ROL::Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
void plus (const ROL::Vector< Real > &x)
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). More...
 
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). More...
 
Real dot (const ROL::Vector< Real > &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...
 
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\). More...
 
Teuchos::RCP< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
Teuchos::RCP< const std::vector< Real > > getVector () const
 
Teuchos::RCP< std::vector< Real > > getVector ()
 
Teuchos::RCP< ROL::Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
const ROL::Vector< Real > & dual () const
 Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout. More...
 
 H1VectorPrimal (const Teuchos::RCP< std::vector< Real > > &vec, const Teuchos::RCP< BurgersFEM< Real > > &fem)
 
void set (const ROL::Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
void plus (const ROL::Vector< Real > &x)
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). More...
 
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). More...
 
Real dot (const ROL::Vector< Real > &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...
 
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\). More...
 
Teuchos::RCP< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
Teuchos::RCP< const std::vector< Real > > getVector () const
 
Teuchos::RCP< std::vector< Real > > getVector ()
 
Teuchos::RCP< ROL::Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
const ROL::Vector< Real > & dual () const
 Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout. More...
 
 H1VectorPrimal (const Teuchos::RCP< std::vector< Real > > &vec, const Teuchos::RCP< BurgersFEM< Real > > &fem)
 
void set (const ROL::Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
void plus (const ROL::Vector< Real > &x)
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). More...
 
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). More...
 
Real dot (const ROL::Vector< Real > &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...
 
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\). More...
 
Teuchos::RCP< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
Teuchos::RCP< const std::vector< Real > > getVector () const
 
Teuchos::RCP< std::vector< Real > > getVector ()
 
Teuchos::RCP< ROL::Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
const ROL::Vector< Real > & dual () const
 Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout. More...
 
- Public Member Functions inherited from ROL::Vector< Real >
virtual ~Vector ()
 
virtual void axpy (const Real alpha, const Vector &x)
 Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). More...
 
virtual void zero ()
 Set to zero vector. More...
 
virtual void applyUnary (const Elementwise::UnaryFunction< Real > &f)
 
virtual void applyBinary (const Elementwise::BinaryFunction< Real > &f, const Vector &x)
 
virtual Real reduce (const Elementwise::ReductionOp< Real > &r) const
 
virtual std::vector< Real > checkVector (const Vector< Real > &x, const Vector< Real > &y, const bool printToStream=true, std::ostream &outStream=std::cout) const
 Verify vector-space methods. More...
 

Private Attributes

Teuchos::RCP< std::vector< Real > > vec_
 
Teuchos::RCP< BurgersFEM< Real > > fem_
 
Teuchos::RCP< H1VectorDual< Real > > dual_vec_
 

Detailed Description

template<class Real>
class H1VectorPrimal< Real >

Definition at line 64 of file test_04.hpp.

Constructor & Destructor Documentation

template<class Real >
H1VectorPrimal< Real >::H1VectorPrimal ( const Teuchos::RCP< std::vector< Real > > &  vec,
const Teuchos::RCP< BurgersFEM< Real > > &  fem 
)
inline

Definition at line 710 of file test_04.hpp.

template<class Real >
H1VectorPrimal< Real >::H1VectorPrimal ( const Teuchos::RCP< std::vector< Real > > &  vec,
const Teuchos::RCP< BurgersFEM< Real > > &  fem 
)
inline

Definition at line 702 of file example_04.hpp.

template<class Real >
H1VectorPrimal< Real >::H1VectorPrimal ( const Teuchos::RCP< std::vector< Real > > &  vec,
const Teuchos::RCP< BurgersFEM< Real > > &  fem 
)
inline

Definition at line 706 of file example_06.hpp.

template<class Real >
H1VectorPrimal< Real >::H1VectorPrimal ( const Teuchos::RCP< std::vector< Real > > &  vec,
const Teuchos::RCP< BurgersFEM< Real > > &  fem 
)
inline

Definition at line 710 of file example_07.hpp.

template<class Real >
H1VectorPrimal< Real >::H1VectorPrimal ( const Teuchos::RCP< std::vector< Real > > &  vec,
const Teuchos::RCP< BurgersFEM< Real > > &  fem 
)
inline

Definition at line 706 of file example_08.hpp.

Member Function Documentation

template<class Real >
void H1VectorPrimal< Real >::set ( const ROL::Vector< Real > &  x)
inlinevirtual

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters
[in]xis a vector.

On return \(\mathtt{*this} = x\). Uses zero and plus methods for the computation. Please overload if a more efficient implementation is needed.


Reimplemented from ROL::Vector< Real >.

Definition at line 714 of file test_04.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
void H1VectorPrimal< Real >::plus ( const ROL::Vector< Real > &  x)
inlinevirtual

Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector to be added to \(\mathtt{*this}\).

On return \(\mathtt{*this} = \mathtt{*this} + x\).


Implements ROL::Vector< Real >.

Definition at line 720 of file test_04.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
void H1VectorPrimal< Real >::scale ( const Real  alpha)
inlinevirtual

Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).

Parameters
[in]alphais the scaling of \(\mathtt{*this}\).

On return \(\mathtt{*this} = \alpha (\mathtt{*this}) \).


Implements ROL::Vector< Real >.

Definition at line 729 of file test_04.hpp.

template<class Real >
Real H1VectorPrimal< Real >::dot ( const ROL::Vector< Real > &  x) const
inlinevirtual

Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector that forms the dot product with \(\mathtt{*this}\).
Returns
The number equal to \(\langle \mathtt{*this}, x \rangle\).

Implements ROL::Vector< Real >.

Definition at line 736 of file test_04.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
Real H1VectorPrimal< Real >::norm ( ) const
inlinevirtual

Returns \( \| y \| \) where \(y = \mathtt{*this}\).

Returns
A nonnegative number equal to the norm of \(\mathtt{*this}\).

Implements ROL::Vector< Real >.

Definition at line 742 of file test_04.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorPrimal< Real >::clone ( ) const
inlinevirtual

Clone to make a new (uninitialized) vector.

Returns
A reference-counted pointer to the cloned vector.

Provides the means of allocating temporary memory in ROL.


Implements ROL::Vector< Real >.

Definition at line 748 of file test_04.hpp.

template<class Real >
Teuchos::RCP<const std::vector<Real> > H1VectorPrimal< Real >::getVector ( ) const
inline
template<class Real >
Teuchos::RCP<std::vector<Real> > H1VectorPrimal< Real >::getVector ( )
inline

Definition at line 756 of file test_04.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorPrimal< Real >::basis ( const int  i) const
inlinevirtual

Return i-th basis vector.

Parameters
[in]iis the index of the basis function.
Returns
A reference-counted pointer to the basis vector with index i.

Overloading the basis is only required if the default gradient implementation is used, which computes a finite-difference approximation.


Reimplemented from ROL::Vector< Real >.

Definition at line 760 of file test_04.hpp.

template<class Real >
int H1VectorPrimal< Real >::dimension ( void  ) const
inlinevirtual

Return dimension of the vector space.

Returns
The dimension of the vector space, i.e., the total number of basis vectors.

Overload if the basis is overloaded.


Reimplemented from ROL::Vector< Real >.

Definition at line 767 of file test_04.hpp.

template<class Real >
const ROL::Vector<Real>& H1VectorPrimal< Real >::dual ( void  ) const
inlinevirtual

Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout.

Returns
A const reference to dual representation.

By default, returns the current object. Please overload if you need a dual representation.


Reimplemented from ROL::Vector< Real >.

Definition at line 771 of file test_04.hpp.

template<class Real >
void H1VectorPrimal< Real >::set ( const ROL::Vector< Real > &  x)
inlinevirtual

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters
[in]xis a vector.

On return \(\mathtt{*this} = x\). Uses zero and plus methods for the computation. Please overload if a more efficient implementation is needed.


Reimplemented from ROL::Vector< Real >.

Definition at line 706 of file example_04.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
void H1VectorPrimal< Real >::plus ( const ROL::Vector< Real > &  x)
inlinevirtual

Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector to be added to \(\mathtt{*this}\).

On return \(\mathtt{*this} = \mathtt{*this} + x\).


Implements ROL::Vector< Real >.

Definition at line 712 of file example_04.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
void H1VectorPrimal< Real >::scale ( const Real  alpha)
inlinevirtual

Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).

Parameters
[in]alphais the scaling of \(\mathtt{*this}\).

On return \(\mathtt{*this} = \alpha (\mathtt{*this}) \).


Implements ROL::Vector< Real >.

Definition at line 721 of file example_04.hpp.

template<class Real >
Real H1VectorPrimal< Real >::dot ( const ROL::Vector< Real > &  x) const
inlinevirtual

Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector that forms the dot product with \(\mathtt{*this}\).
Returns
The number equal to \(\langle \mathtt{*this}, x \rangle\).

Implements ROL::Vector< Real >.

Definition at line 728 of file example_04.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
Real H1VectorPrimal< Real >::norm ( ) const
inlinevirtual

Returns \( \| y \| \) where \(y = \mathtt{*this}\).

Returns
A nonnegative number equal to the norm of \(\mathtt{*this}\).

Implements ROL::Vector< Real >.

Definition at line 734 of file example_04.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorPrimal< Real >::clone ( ) const
inlinevirtual

Clone to make a new (uninitialized) vector.

Returns
A reference-counted pointer to the cloned vector.

Provides the means of allocating temporary memory in ROL.


Implements ROL::Vector< Real >.

Definition at line 740 of file example_04.hpp.

template<class Real >
Teuchos::RCP<const std::vector<Real> > H1VectorPrimal< Real >::getVector ( ) const
inline

Definition at line 744 of file example_04.hpp.

template<class Real >
Teuchos::RCP<std::vector<Real> > H1VectorPrimal< Real >::getVector ( )
inline

Definition at line 748 of file example_04.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorPrimal< Real >::basis ( const int  i) const
inlinevirtual

Return i-th basis vector.

Parameters
[in]iis the index of the basis function.
Returns
A reference-counted pointer to the basis vector with index i.

Overloading the basis is only required if the default gradient implementation is used, which computes a finite-difference approximation.


Reimplemented from ROL::Vector< Real >.

Definition at line 752 of file example_04.hpp.

template<class Real >
int H1VectorPrimal< Real >::dimension ( void  ) const
inlinevirtual

Return dimension of the vector space.

Returns
The dimension of the vector space, i.e., the total number of basis vectors.

Overload if the basis is overloaded.


Reimplemented from ROL::Vector< Real >.

Definition at line 759 of file example_04.hpp.

template<class Real >
const ROL::Vector<Real>& H1VectorPrimal< Real >::dual ( void  ) const
inlinevirtual

Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout.

Returns
A const reference to dual representation.

By default, returns the current object. Please overload if you need a dual representation.


Reimplemented from ROL::Vector< Real >.

Definition at line 763 of file example_04.hpp.

template<class Real >
void H1VectorPrimal< Real >::set ( const ROL::Vector< Real > &  x)
inlinevirtual

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters
[in]xis a vector.

On return \(\mathtt{*this} = x\). Uses zero and plus methods for the computation. Please overload if a more efficient implementation is needed.


Reimplemented from ROL::Vector< Real >.

Definition at line 710 of file example_06.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
void H1VectorPrimal< Real >::plus ( const ROL::Vector< Real > &  x)
inlinevirtual

Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector to be added to \(\mathtt{*this}\).

On return \(\mathtt{*this} = \mathtt{*this} + x\).


Implements ROL::Vector< Real >.

Definition at line 716 of file example_06.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
void H1VectorPrimal< Real >::scale ( const Real  alpha)
inlinevirtual

Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).

Parameters
[in]alphais the scaling of \(\mathtt{*this}\).

On return \(\mathtt{*this} = \alpha (\mathtt{*this}) \).


Implements ROL::Vector< Real >.

Definition at line 725 of file example_06.hpp.

template<class Real >
Real H1VectorPrimal< Real >::dot ( const ROL::Vector< Real > &  x) const
inlinevirtual

Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector that forms the dot product with \(\mathtt{*this}\).
Returns
The number equal to \(\langle \mathtt{*this}, x \rangle\).

Implements ROL::Vector< Real >.

Definition at line 732 of file example_06.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
Real H1VectorPrimal< Real >::norm ( ) const
inlinevirtual

Returns \( \| y \| \) where \(y = \mathtt{*this}\).

Returns
A nonnegative number equal to the norm of \(\mathtt{*this}\).

Implements ROL::Vector< Real >.

Definition at line 738 of file example_06.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorPrimal< Real >::clone ( ) const
inlinevirtual

Clone to make a new (uninitialized) vector.

Returns
A reference-counted pointer to the cloned vector.

Provides the means of allocating temporary memory in ROL.


Implements ROL::Vector< Real >.

Definition at line 744 of file example_06.hpp.

template<class Real >
Teuchos::RCP<const std::vector<Real> > H1VectorPrimal< Real >::getVector ( ) const
inline

Definition at line 748 of file example_06.hpp.

template<class Real >
Teuchos::RCP<std::vector<Real> > H1VectorPrimal< Real >::getVector ( )
inline

Definition at line 752 of file example_06.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorPrimal< Real >::basis ( const int  i) const
inlinevirtual

Return i-th basis vector.

Parameters
[in]iis the index of the basis function.
Returns
A reference-counted pointer to the basis vector with index i.

Overloading the basis is only required if the default gradient implementation is used, which computes a finite-difference approximation.


Reimplemented from ROL::Vector< Real >.

Definition at line 756 of file example_06.hpp.

template<class Real >
int H1VectorPrimal< Real >::dimension ( void  ) const
inlinevirtual

Return dimension of the vector space.

Returns
The dimension of the vector space, i.e., the total number of basis vectors.

Overload if the basis is overloaded.


Reimplemented from ROL::Vector< Real >.

Definition at line 763 of file example_06.hpp.

template<class Real >
const ROL::Vector<Real>& H1VectorPrimal< Real >::dual ( void  ) const
inlinevirtual

Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout.

Returns
A const reference to dual representation.

By default, returns the current object. Please overload if you need a dual representation.


Reimplemented from ROL::Vector< Real >.

Definition at line 767 of file example_06.hpp.

template<class Real >
void H1VectorPrimal< Real >::set ( const ROL::Vector< Real > &  x)
inlinevirtual

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters
[in]xis a vector.

On return \(\mathtt{*this} = x\). Uses zero and plus methods for the computation. Please overload if a more efficient implementation is needed.


Reimplemented from ROL::Vector< Real >.

Definition at line 714 of file example_07.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
void H1VectorPrimal< Real >::plus ( const ROL::Vector< Real > &  x)
inlinevirtual

Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector to be added to \(\mathtt{*this}\).

On return \(\mathtt{*this} = \mathtt{*this} + x\).


Implements ROL::Vector< Real >.

Definition at line 720 of file example_07.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
void H1VectorPrimal< Real >::scale ( const Real  alpha)
inlinevirtual

Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).

Parameters
[in]alphais the scaling of \(\mathtt{*this}\).

On return \(\mathtt{*this} = \alpha (\mathtt{*this}) \).


Implements ROL::Vector< Real >.

Definition at line 729 of file example_07.hpp.

template<class Real >
Real H1VectorPrimal< Real >::dot ( const ROL::Vector< Real > &  x) const
inlinevirtual

Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector that forms the dot product with \(\mathtt{*this}\).
Returns
The number equal to \(\langle \mathtt{*this}, x \rangle\).

Implements ROL::Vector< Real >.

Definition at line 736 of file example_07.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
Real H1VectorPrimal< Real >::norm ( ) const
inlinevirtual

Returns \( \| y \| \) where \(y = \mathtt{*this}\).

Returns
A nonnegative number equal to the norm of \(\mathtt{*this}\).

Implements ROL::Vector< Real >.

Definition at line 742 of file example_07.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorPrimal< Real >::clone ( ) const
inlinevirtual

Clone to make a new (uninitialized) vector.

Returns
A reference-counted pointer to the cloned vector.

Provides the means of allocating temporary memory in ROL.


Implements ROL::Vector< Real >.

Definition at line 748 of file example_07.hpp.

template<class Real >
Teuchos::RCP<const std::vector<Real> > H1VectorPrimal< Real >::getVector ( ) const
inline

Definition at line 752 of file example_07.hpp.

template<class Real >
Teuchos::RCP<std::vector<Real> > H1VectorPrimal< Real >::getVector ( )
inline

Definition at line 756 of file example_07.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorPrimal< Real >::basis ( const int  i) const
inlinevirtual

Return i-th basis vector.

Parameters
[in]iis the index of the basis function.
Returns
A reference-counted pointer to the basis vector with index i.

Overloading the basis is only required if the default gradient implementation is used, which computes a finite-difference approximation.


Reimplemented from ROL::Vector< Real >.

Definition at line 760 of file example_07.hpp.

template<class Real >
int H1VectorPrimal< Real >::dimension ( void  ) const
inlinevirtual

Return dimension of the vector space.

Returns
The dimension of the vector space, i.e., the total number of basis vectors.

Overload if the basis is overloaded.


Reimplemented from ROL::Vector< Real >.

Definition at line 767 of file example_07.hpp.

template<class Real >
const ROL::Vector<Real>& H1VectorPrimal< Real >::dual ( void  ) const
inlinevirtual

Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout.

Returns
A const reference to dual representation.

By default, returns the current object. Please overload if you need a dual representation.


Reimplemented from ROL::Vector< Real >.

Definition at line 771 of file example_07.hpp.

template<class Real >
void H1VectorPrimal< Real >::set ( const ROL::Vector< Real > &  x)
inlinevirtual

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters
[in]xis a vector.

On return \(\mathtt{*this} = x\). Uses zero and plus methods for the computation. Please overload if a more efficient implementation is needed.


Reimplemented from ROL::Vector< Real >.

Definition at line 710 of file example_08.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
void H1VectorPrimal< Real >::plus ( const ROL::Vector< Real > &  x)
inlinevirtual

Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector to be added to \(\mathtt{*this}\).

On return \(\mathtt{*this} = \mathtt{*this} + x\).


Implements ROL::Vector< Real >.

Definition at line 716 of file example_08.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
void H1VectorPrimal< Real >::scale ( const Real  alpha)
inlinevirtual

Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).

Parameters
[in]alphais the scaling of \(\mathtt{*this}\).

On return \(\mathtt{*this} = \alpha (\mathtt{*this}) \).


Implements ROL::Vector< Real >.

Definition at line 725 of file example_08.hpp.

template<class Real >
Real H1VectorPrimal< Real >::dot ( const ROL::Vector< Real > &  x) const
inlinevirtual

Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector that forms the dot product with \(\mathtt{*this}\).
Returns
The number equal to \(\langle \mathtt{*this}, x \rangle\).

Implements ROL::Vector< Real >.

Definition at line 732 of file example_08.hpp.

References H1VectorPrimal< Real >::getVector().

template<class Real >
Real H1VectorPrimal< Real >::norm ( ) const
inlinevirtual

Returns \( \| y \| \) where \(y = \mathtt{*this}\).

Returns
A nonnegative number equal to the norm of \(\mathtt{*this}\).

Implements ROL::Vector< Real >.

Definition at line 738 of file example_08.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorPrimal< Real >::clone ( ) const
inlinevirtual

Clone to make a new (uninitialized) vector.

Returns
A reference-counted pointer to the cloned vector.

Provides the means of allocating temporary memory in ROL.


Implements ROL::Vector< Real >.

Definition at line 744 of file example_08.hpp.

template<class Real >
Teuchos::RCP<const std::vector<Real> > H1VectorPrimal< Real >::getVector ( ) const
inline

Definition at line 748 of file example_08.hpp.

template<class Real >
Teuchos::RCP<std::vector<Real> > H1VectorPrimal< Real >::getVector ( )
inline

Definition at line 752 of file example_08.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorPrimal< Real >::basis ( const int  i) const
inlinevirtual

Return i-th basis vector.

Parameters
[in]iis the index of the basis function.
Returns
A reference-counted pointer to the basis vector with index i.

Overloading the basis is only required if the default gradient implementation is used, which computes a finite-difference approximation.


Reimplemented from ROL::Vector< Real >.

Definition at line 756 of file example_08.hpp.

template<class Real >
int H1VectorPrimal< Real >::dimension ( void  ) const
inlinevirtual

Return dimension of the vector space.

Returns
The dimension of the vector space, i.e., the total number of basis vectors.

Overload if the basis is overloaded.


Reimplemented from ROL::Vector< Real >.

Definition at line 763 of file example_08.hpp.

template<class Real >
const ROL::Vector<Real>& H1VectorPrimal< Real >::dual ( void  ) const
inlinevirtual

Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout.

Returns
A const reference to dual representation.

By default, returns the current object. Please overload if you need a dual representation.


Reimplemented from ROL::Vector< Real >.

Definition at line 767 of file example_08.hpp.

Member Data Documentation

template<class Real >
Teuchos::RCP< std::vector< Real > > H1VectorPrimal< Real >::vec_
private

Definition at line 704 of file test_04.hpp.

template<class Real >
Teuchos::RCP< BurgersFEM< Real > > H1VectorPrimal< Real >::fem_
private

Definition at line 705 of file test_04.hpp.

template<class Real >
Teuchos::RCP< H1VectorDual< Real > > H1VectorPrimal< Real >::dual_vec_
mutableprivate

Definition at line 707 of file test_04.hpp.


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