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

#include <test_04.hpp>

+ Inheritance diagram for H1VectorDual< Real >:

Public Member Functions

 H1VectorDual (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...
 
 H1VectorDual (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...
 
 H1VectorDual (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...
 
 H1VectorDual (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...
 
 H1VectorDual (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< H1VectorPrimal< Real > > dual_vec_
 

Detailed Description

template<class Real>
class H1VectorDual< Real >

Definition at line 67 of file test_04.hpp.

Constructor & Destructor Documentation

◆ H1VectorDual() [1/5]

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

Definition at line 790 of file test_04.hpp.

Referenced by H1VectorDual< Real >::basis(), and H1VectorDual< Real >::clone().

◆ H1VectorDual() [2/5]

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

Definition at line 782 of file example_04.hpp.

◆ H1VectorDual() [3/5]

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

Definition at line 786 of file example_06.hpp.

◆ H1VectorDual() [4/5]

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

Definition at line 790 of file example_07.hpp.

◆ H1VectorDual() [5/5]

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

Definition at line 786 of file example_08.hpp.

Member Function Documentation

◆ set() [1/5]

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

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

Parameters
[in]xis a vector.
   On return \form#18.
   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 794 of file test_04.hpp.

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

◆ plus() [1/5]

template<class Real >
void H1VectorDual< 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 \form#9.

   ---

Implements ROL::Vector< Real >.

Definition at line 800 of file test_04.hpp.

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

◆ scale() [1/5]

template<class Real >
void H1VectorDual< 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 \form#11.

   ---

Implements ROL::Vector< Real >.

Definition at line 809 of file test_04.hpp.

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

◆ dot() [1/5]

template<class Real >
Real H1VectorDual< 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 816 of file test_04.hpp.

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

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

◆ norm() [1/5]

template<class Real >
Real H1VectorDual< 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 829 of file test_04.hpp.

References H1VectorDual< Real >::dot().

◆ clone() [1/5]

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorDual< 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 835 of file test_04.hpp.

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

◆ getVector() [1/10]

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

◆ getVector() [2/10]

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

Definition at line 843 of file test_04.hpp.

References H1VectorDual< Real >::vec_.

◆ basis() [1/5]

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorDual< 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 847 of file test_04.hpp.

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

◆ dimension() [1/5]

template<class Real >
int H1VectorDual< 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 854 of file test_04.hpp.

References H1VectorDual< Real >::vec_.

Referenced by H1VectorDual< Real >::dot(), H1VectorDual< Real >::plus(), and H1VectorDual< Real >::scale().

◆ dual() [1/5]

template<class Real >
const ROL::Vector<Real>& H1VectorDual< 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 858 of file test_04.hpp.

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

◆ set() [2/5]

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

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

Parameters
[in]xis a vector.
   On return \form#18.
   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 786 of file example_04.hpp.

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

◆ plus() [2/5]

template<class Real >
void H1VectorDual< 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 \form#9.

   ---

Implements ROL::Vector< Real >.

Definition at line 792 of file example_04.hpp.

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

◆ scale() [2/5]

template<class Real >
void H1VectorDual< 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 \form#11.

   ---

Implements ROL::Vector< Real >.

Definition at line 801 of file example_04.hpp.

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

◆ dot() [2/5]

template<class Real >
Real H1VectorDual< 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 808 of file example_04.hpp.

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

◆ norm() [2/5]

template<class Real >
Real H1VectorDual< 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 821 of file example_04.hpp.

References H1VectorDual< Real >::dot().

◆ clone() [2/5]

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorDual< 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 827 of file example_04.hpp.

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

◆ getVector() [3/10]

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

Definition at line 831 of file example_04.hpp.

References H1VectorDual< Real >::vec_.

◆ getVector() [4/10]

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

Definition at line 835 of file example_04.hpp.

References H1VectorDual< Real >::vec_.

◆ basis() [2/5]

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorDual< 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 839 of file example_04.hpp.

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

◆ dimension() [2/5]

template<class Real >
int H1VectorDual< 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 846 of file example_04.hpp.

References H1VectorDual< Real >::vec_.

◆ dual() [2/5]

template<class Real >
const ROL::Vector<Real>& H1VectorDual< 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 850 of file example_04.hpp.

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

◆ set() [3/5]

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

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

Parameters
[in]xis a vector.
   On return \form#18.
   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 790 of file example_06.hpp.

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

◆ plus() [3/5]

template<class Real >
void H1VectorDual< 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 \form#9.

   ---

Implements ROL::Vector< Real >.

Definition at line 796 of file example_06.hpp.

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

◆ scale() [3/5]

template<class Real >
void H1VectorDual< 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 \form#11.

   ---

Implements ROL::Vector< Real >.

Definition at line 805 of file example_06.hpp.

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

◆ dot() [3/5]

template<class Real >
Real H1VectorDual< 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 812 of file example_06.hpp.

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

◆ norm() [3/5]

template<class Real >
Real H1VectorDual< 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 825 of file example_06.hpp.

References H1VectorDual< Real >::dot().

◆ clone() [3/5]

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorDual< 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 831 of file example_06.hpp.

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

◆ getVector() [5/10]

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

Definition at line 835 of file example_06.hpp.

References H1VectorDual< Real >::vec_.

◆ getVector() [6/10]

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

Definition at line 839 of file example_06.hpp.

References H1VectorDual< Real >::vec_.

◆ basis() [3/5]

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorDual< 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 843 of file example_06.hpp.

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

◆ dimension() [3/5]

template<class Real >
int H1VectorDual< 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 850 of file example_06.hpp.

References H1VectorDual< Real >::vec_.

◆ dual() [3/5]

template<class Real >
const ROL::Vector<Real>& H1VectorDual< 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 854 of file example_06.hpp.

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

◆ set() [4/5]

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

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

Parameters
[in]xis a vector.
   On return \form#18.
   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 794 of file example_07.hpp.

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

◆ plus() [4/5]

template<class Real >
void H1VectorDual< 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 \form#9.

   ---

Implements ROL::Vector< Real >.

Definition at line 800 of file example_07.hpp.

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

◆ scale() [4/5]

template<class Real >
void H1VectorDual< 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 \form#11.

   ---

Implements ROL::Vector< Real >.

Definition at line 809 of file example_07.hpp.

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

◆ dot() [4/5]

template<class Real >
Real H1VectorDual< 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 816 of file example_07.hpp.

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

◆ norm() [4/5]

template<class Real >
Real H1VectorDual< 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 829 of file example_07.hpp.

References H1VectorDual< Real >::dot().

◆ clone() [4/5]

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorDual< 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 835 of file example_07.hpp.

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

◆ getVector() [7/10]

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

Definition at line 839 of file example_07.hpp.

References H1VectorDual< Real >::vec_.

◆ getVector() [8/10]

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

Definition at line 843 of file example_07.hpp.

References H1VectorDual< Real >::vec_.

◆ basis() [4/5]

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorDual< 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 847 of file example_07.hpp.

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

◆ dimension() [4/5]

template<class Real >
int H1VectorDual< 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 854 of file example_07.hpp.

References H1VectorDual< Real >::vec_.

◆ dual() [4/5]

template<class Real >
const ROL::Vector<Real>& H1VectorDual< 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 858 of file example_07.hpp.

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

◆ set() [5/5]

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

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

Parameters
[in]xis a vector.
   On return \form#18.
   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 790 of file example_08.hpp.

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

◆ plus() [5/5]

template<class Real >
void H1VectorDual< 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 \form#9.

   ---

Implements ROL::Vector< Real >.

Definition at line 796 of file example_08.hpp.

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

◆ scale() [5/5]

template<class Real >
void H1VectorDual< 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 \form#11.

   ---

Implements ROL::Vector< Real >.

Definition at line 805 of file example_08.hpp.

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

◆ dot() [5/5]

template<class Real >
Real H1VectorDual< 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 812 of file example_08.hpp.

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

◆ norm() [5/5]

template<class Real >
Real H1VectorDual< 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 825 of file example_08.hpp.

References H1VectorDual< Real >::dot().

◆ clone() [5/5]

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorDual< 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 831 of file example_08.hpp.

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

◆ getVector() [9/10]

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

Definition at line 835 of file example_08.hpp.

References H1VectorDual< Real >::vec_.

◆ getVector() [10/10]

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

Definition at line 839 of file example_08.hpp.

References H1VectorDual< Real >::vec_.

◆ basis() [5/5]

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > H1VectorDual< 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 843 of file example_08.hpp.

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

◆ dimension() [5/5]

template<class Real >
int H1VectorDual< 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 850 of file example_08.hpp.

References H1VectorDual< Real >::vec_.

◆ dual() [5/5]

template<class Real >
const ROL::Vector<Real>& H1VectorDual< 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 854 of file example_08.hpp.

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

Member Data Documentation

◆ vec_

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

◆ fem_

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

◆ dual_vec_

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

Definition at line 787 of file test_04.hpp.

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


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