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 ROL::Ptr< std::vector< Real >> &vec, const ROL::Ptr< BurgersFEM< Real >> &fem)
 
Real dot (const ROL::Vector< Real > &x) const override
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...
 
ROL::Ptr< ROL::Vector< Real > > clone () const override
 Clone to make a new (uninitialized) vector. More...
 
const ROL::Vector< Real > & dual () const override
 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 ROL::Ptr< std::vector< Real > > &vec, const ROL::Ptr< 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...
 
ROL::Ptr< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
ROL::Ptr< const std::vector
< Real > > 
getVector () const
 
ROL::Ptr< std::vector< Real > > getVector ()
 
ROL::Ptr< 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...
 
Real apply (const ROL::Vector< Real > &x) const
 Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\). More...
 
 H1VectorPrimal (const ROL::Ptr< std::vector< Real > > &vec, const ROL::Ptr< 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...
 
ROL::Ptr< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
ROL::Ptr< const std::vector
< Real > > 
getVector () const
 
ROL::Ptr< std::vector< Real > > getVector ()
 
ROL::Ptr< 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...
 
Real apply (const ROL::Vector< Real > &x) const
 Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\). More...
 
 H1VectorPrimal (const ROL::Ptr< std::vector< Real > > &vec, const ROL::Ptr< 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...
 
ROL::Ptr< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
ROL::Ptr< const std::vector
< Real > > 
getVector () const
 
ROL::Ptr< std::vector< Real > > getVector ()
 
ROL::Ptr< 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...
 
Real apply (const ROL::Vector< Real > &x) const
 Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\). More...
 
 H1VectorPrimal (const ROL::Ptr< std::vector< Real > > &vec, const ROL::Ptr< BurgersFEM< Real > > &fem)
 
Real dot (const ROL::Vector< Real > &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...
 
ROL::Ptr< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. 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::StdVector< Real >
 StdVector (const Ptr< std::vector< Real >> &std_vec)
 
 StdVector (const int dim, const Realval=0.0)
 
 StdVector (std::initializer_list< Real > ilist)
 
Real & operator[] (int i)
 
const Real & operator[] (int i) const
 
void set (const Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
void plus (const Vector< Real > &x)
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). More...
 
void axpy (const Real alpha, const Vector< Real > &x)
 Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). More...
 
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). More...
 
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\). More...
 
Ptr< const std::vector< Real > > getVector () const
 
Ptr< std::vector< Real > > getVector ()
 
Ptr< Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
void applyUnary (const Elementwise::UnaryFunction< Real > &f)
 
void applyBinary (const Elementwise::BinaryFunction< Real > &f, const Vector< Real > &x)
 
Real reduce (const Elementwise::ReductionOp< Real > &r) const
 
void setScalar (const Real C)
 Set \(y \leftarrow C\) where \(C\in\mathbb{R}\). More...
 
void randomize (const Real l=0.0, const Real u=1.0)
 Set vector to be uniform random between [l,u]. More...
 
virtual void print (std::ostream &outStream) const
 
- Public Member Functions inherited from ROL::Vector< Real >
virtual ~Vector ()
 
virtual void zero ()
 Set to zero vector. More...
 
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

ROL::Ptr< BurgersFEM< Real > > fem_
 
ROL::Ptr< H1VectorDual< Real > > dual_vec_
 
bool isDualInitialized_
 
ROL::Ptr< std::vector< Real > > vec_
 

Detailed Description

template<class Real>
class H1VectorPrimal< Real >

Definition at line 29 of file test_04.hpp.

Constructor & Destructor Documentation

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

Definition at line 592 of file test_04.hpp.

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

Definition at line 680 of file example_04.hpp.

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

Definition at line 684 of file example_06.hpp.

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

Definition at line 688 of file example_07.hpp.

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

Definition at line 585 of file example_08.hpp.

Member Function Documentation

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

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 597 of file test_04.hpp.

References H1VectorPrimal< Real >::fem_, ROL::StdVector< Real, Element >::getVector(), and H1VectorPrimal< Real >::getVector().

Referenced by H1VectorPrimal< Real >::norm().

template<class Real>
ROL::Ptr<ROL::Vector<Real> > H1VectorPrimal< Real >::clone ( ) const
inlineoverridevirtual

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 604 of file test_04.hpp.

References H1VectorPrimal< Real >::dimension(), H1VectorPrimal< Real >::fem_, and ROL::StdVector< Real, Element >::getVector().

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

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 610 of file test_04.hpp.

References H1VectorPrimal< Real >::dimension(), H1VectorPrimal< Real >::dual_vec_, H1VectorPrimal< Real >::fem_, ROL::StdVector< Real, Element >::getVector(), and H1VectorPrimal< Real >::isDualInitialized_.

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 684 of file example_04.hpp.

References H1VectorPrimal< Real >::getVector(), and H1VectorPrimal< Real >::vec_.

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 690 of file example_04.hpp.

References H1VectorPrimal< Real >::dimension(), H1VectorPrimal< Real >::getVector(), and H1VectorPrimal< Real >::vec_.

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 699 of file example_04.hpp.

References H1VectorPrimal< Real >::dimension(), and H1VectorPrimal< Real >::vec_.

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 706 of file example_04.hpp.

References H1VectorPrimal< Real >::fem_, H1VectorPrimal< Real >::getVector(), and H1VectorPrimal< Real >::vec_.

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 712 of file example_04.hpp.

References H1VectorPrimal< Real >::dot().

template<class Real>
ROL::Ptr<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 718 of file example_04.hpp.

References H1VectorPrimal< Real >::fem_, and H1VectorPrimal< Real >::vec_.

template<class Real>
ROL::Ptr<const std::vector<Real> > H1VectorPrimal< Real >::getVector ( void  ) const
inline
template<class Real>
ROL::Ptr<std::vector<Real> > H1VectorPrimal< Real >::getVector ( void  )
inline

Definition at line 726 of file example_04.hpp.

References H1VectorPrimal< Real >::vec_.

template<class Real>
ROL::Ptr<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 730 of file example_04.hpp.

References H1VectorPrimal< Real >::fem_, and H1VectorPrimal< Real >::vec_.

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 737 of file example_04.hpp.

References H1VectorPrimal< Real >::vec_.

Referenced by H1VectorPrimal< Real >::clone(), H1VectorPrimal< Real >::dual(), H1VectorPrimal< Real >::plus(), and H1VectorPrimal< Real >::scale().

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 741 of file example_04.hpp.

References H1VectorPrimal< Real >::dual_vec_, H1VectorPrimal< Real >::fem_, and H1VectorPrimal< Real >::vec_.

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

Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\).

Parameters
[in]xis a vector
Returns
The number equal to \(\langle \mathtt{*this}, x \rangle\).

Reimplemented from ROL::Vector< Real >.

Definition at line 749 of file example_04.hpp.

References H1VectorDual< Real >::getVector(), and H1VectorPrimal< Real >::vec_.

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 688 of file example_06.hpp.

References H1VectorPrimal< Real >::getVector(), and H1VectorPrimal< Real >::vec_.

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 694 of file example_06.hpp.

References H1VectorPrimal< Real >::dimension(), H1VectorPrimal< Real >::getVector(), and H1VectorPrimal< Real >::vec_.

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 703 of file example_06.hpp.

References H1VectorPrimal< Real >::dimension(), and H1VectorPrimal< Real >::vec_.

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 710 of file example_06.hpp.

References H1VectorPrimal< Real >::fem_, H1VectorPrimal< Real >::getVector(), and H1VectorPrimal< Real >::vec_.

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 716 of file example_06.hpp.

References H1VectorPrimal< Real >::dot().

template<class Real>
ROL::Ptr<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 722 of file example_06.hpp.

References H1VectorPrimal< Real >::fem_, and H1VectorPrimal< Real >::vec_.

template<class Real>
ROL::Ptr<const std::vector<Real> > H1VectorPrimal< Real >::getVector ( void  ) const
inline

Definition at line 726 of file example_06.hpp.

References H1VectorPrimal< Real >::vec_.

template<class Real>
ROL::Ptr<std::vector<Real> > H1VectorPrimal< Real >::getVector ( void  )
inline

Definition at line 730 of file example_06.hpp.

References H1VectorPrimal< Real >::vec_.

template<class Real>
ROL::Ptr<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 734 of file example_06.hpp.

References H1VectorPrimal< Real >::fem_, and H1VectorPrimal< Real >::vec_.

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 741 of file example_06.hpp.

References H1VectorPrimal< Real >::vec_.

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 745 of file example_06.hpp.

References H1VectorPrimal< Real >::dual_vec_, H1VectorPrimal< Real >::fem_, and H1VectorPrimal< Real >::vec_.

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

Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\).

Parameters
[in]xis a vector
Returns
The number equal to \(\langle \mathtt{*this}, x \rangle\).

Reimplemented from ROL::Vector< Real >.

Definition at line 753 of file example_06.hpp.

References H1VectorDual< Real >::getVector(), and H1VectorPrimal< Real >::vec_.

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 692 of file example_07.hpp.

References H1VectorPrimal< Real >::getVector(), and H1VectorPrimal< Real >::vec_.

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 698 of file example_07.hpp.

References H1VectorPrimal< Real >::dimension(), H1VectorPrimal< Real >::getVector(), and H1VectorPrimal< Real >::vec_.

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 707 of file example_07.hpp.

References H1VectorPrimal< Real >::dimension(), and H1VectorPrimal< Real >::vec_.

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 714 of file example_07.hpp.

References H1VectorPrimal< Real >::fem_, H1VectorPrimal< Real >::getVector(), and H1VectorPrimal< Real >::vec_.

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 720 of file example_07.hpp.

References H1VectorPrimal< Real >::dot().

template<class Real>
ROL::Ptr<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 726 of file example_07.hpp.

References H1VectorPrimal< Real >::fem_, and H1VectorPrimal< Real >::vec_.

template<class Real>
ROL::Ptr<const std::vector<Real> > H1VectorPrimal< Real >::getVector ( void  ) const
inline

Definition at line 730 of file example_07.hpp.

References H1VectorPrimal< Real >::vec_.

template<class Real>
ROL::Ptr<std::vector<Real> > H1VectorPrimal< Real >::getVector ( void  )
inline

Definition at line 734 of file example_07.hpp.

References H1VectorPrimal< Real >::vec_.

template<class Real>
ROL::Ptr<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 738 of file example_07.hpp.

References H1VectorPrimal< Real >::fem_, and H1VectorPrimal< Real >::vec_.

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 745 of file example_07.hpp.

References H1VectorPrimal< Real >::vec_.

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 749 of file example_07.hpp.

References H1VectorPrimal< Real >::dual_vec_, H1VectorPrimal< Real >::fem_, and H1VectorPrimal< Real >::vec_.

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

Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\).

Parameters
[in]xis a vector
Returns
The number equal to \(\langle \mathtt{*this}, x \rangle\).

Reimplemented from ROL::Vector< Real >.

Definition at line 757 of file example_07.hpp.

References H1VectorDual< Real >::getVector(), and H1VectorPrimal< Real >::vec_.

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 590 of file example_08.hpp.

References H1VectorPrimal< Real >::fem_, ROL::StdVector< Real, Element >::getVector(), and H1VectorPrimal< Real >::getVector().

template<class Real>
ROL::Ptr<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 597 of file example_08.hpp.

References ROL::StdVector< Real, Element >::dimension(), and H1VectorPrimal< Real >::fem_.

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 602 of file example_08.hpp.

References ROL::StdVector< Real, Element >::dimension(), H1VectorPrimal< Real >::dual_vec_, H1VectorPrimal< Real >::fem_, and H1VectorPrimal< Real >::isDualInitialized_.

Member Data Documentation

template<class Real>
ROL::Ptr< BurgersFEM< Real > > H1VectorPrimal< Real >::fem_
private
template<class Real>
ROL::Ptr< H1VectorDual< Real > > H1VectorPrimal< Real >::dual_vec_
mutableprivate

Definition at line 588 of file test_04.hpp.

Referenced by H1VectorPrimal< Real >::dual().

template<class Real>
bool H1VectorPrimal< Real >::isDualInitialized_
mutableprivate

Definition at line 589 of file test_04.hpp.

Referenced by H1VectorPrimal< Real >::dual().

template<class Real>
ROL::Ptr< std::vector< Real > > H1VectorPrimal< Real >::vec_
private

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