#include <test_04.hpp>

Inheritance diagram for H1VectorDual< Real >:

Public Member Functions
	H1VectorDual (const ROL::Ptr< std::vector< Real > > &vec, const ROL::Ptr< BurgersFEM< Real > > &fem)

Real	dot (const ROL::Vector< Real > &x) const override

ROL::Ptr< ROL::Vector< Real > >	clone () const override
	Clone to make a new (uninitialized) vector.

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.

	H1VectorDual (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}\).

void	plus (const ROL::Vector< Real > &x)
	Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

void	scale (const Real alpha)
	Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).

Real	dot (const ROL::Vector< Real > &x) const

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

ROL::Ptr< ROL::Vector< Real > >	clone () const
	Clone to make a new (uninitialized) vector.

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.

int	dimension () const
	Return dimension of the vector space.

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.

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())}\).

	H1VectorDual (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}\).

void	plus (const ROL::Vector< Real > &x)
	Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

void	scale (const Real alpha)
	Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).

Real	dot (const ROL::Vector< Real > &x) const

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

ROL::Ptr< ROL::Vector< Real > >	clone () const
	Clone to make a new (uninitialized) vector.

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.

int	dimension () const
	Return dimension of the vector space.

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.

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())}\).

	H1VectorDual (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}\).

void	plus (const ROL::Vector< Real > &x)
	Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

void	scale (const Real alpha)
	Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).

Real	dot (const ROL::Vector< Real > &x) const

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

ROL::Ptr< ROL::Vector< Real > >	clone () const
	Clone to make a new (uninitialized) vector.

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.

int	dimension () const
	Return dimension of the vector space.

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.

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())}\).

	H1VectorDual (const ROL::Ptr< std::vector< Real > > &vec, const ROL::Ptr< BurgersFEM< Real > > &fem)

Real	dot (const ROL::Vector< Real > &x) const

ROL::Ptr< ROL::Vector< Real > >	clone () const
	Clone to make a new (uninitialized) vector.

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.

Public Member Functions inherited from ROL::StdVector< Real, Element >
	StdVector (const Ptr< std::vector< Element > > &std_vec)

	StdVector (const int dim, const Element val=0.0)

	StdVector (std::initializer_list< Element > ilist)

Real &	operator[] (int i)

const Real &	operator[] (int i) const

void	set (const Vector< Real > &x)

void	plus (const Vector< Real > &x)

void	axpy (const Real alpha, const Vector< Real > &x)

void	scale (const Real alpha)
	Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).

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

Ptr< const std::vector< Element > >	getVector () const

Ptr< std::vector< Element > >	getVector ()

Ptr< Vector< Real > >	basis (const int i) const
	Return i-th basis vector.

int	dimension () const
	Return dimension of the vector space.

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}\).

void	randomize (const Real l=0.0, const Real u=1.0)
	Set vector to be uniform random between [l,u].

virtual void	print (std::ostream &outStream) const

Public Member Functions inherited from ROL::ROL::Vector< Real >
virtual	~Vector ()

virtual void	plus (const Vector &x)=0
	Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

virtual Real	dot (const Vector &x) const =0
	Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).

virtual void	axpy (const Real alpha, const Vector &x)
	Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\).

virtual void	zero ()
	Set to zero vector.

virtual void	set (const Vector &x)
	Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

virtual Real	apply (const Vector< Real > &x) const
	Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\).

virtual void	applyBinary (const Elementwise::BinaryFunction< Real > &f, const Vector &x)

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.

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}\).

virtual void	zero ()
	Set to zero vector.

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 void	print (std::ostream &outStream) const

virtual void	setScalar (const Real C)
	Set \(y \leftarrow C\) where \(C\in\mathbb{R}\).

virtual void	randomize (const Real l=0.0, const Real u=1.0)
	Set vector to be uniform random between [l,u].

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.

Private Attributes
ROL::Ptr< BurgersFEM< Real > >	fem_

ROL::Ptr< H1VectorPrimal< Real > >	dual_vec_

bool	isDualInitialized_

ROL::Ptr< std::vector< Real > >	vec_

ROL::Ptr< H1VectorPrimal< Real > >	prim_vec_

bool	isPrimalInitialized_

Detailed Description

template<class Real>
class H1VectorDual< Real >

Definition at line 649 of file example_08.hpp.

Constructor & Destructor Documentation

◆ H1VectorDual() [1/5]

template<class Real>

H1VectorDual< Real >::H1VectorDual	(	const ROL::Ptr< std::vector< Real > > &	vec,
		const ROL::Ptr< BurgersFEM< Real > > &	fem )

inline

Definition at line 665 of file test_04.hpp.

◆ H1VectorDual() [2/5]

template<class Real>

H1VectorDual< Real >::H1VectorDual	(	const ROL::Ptr< std::vector< Real > > &	vec,
		const ROL::Ptr< BurgersFEM< Real > > &	fem )

inline

Definition at line 800 of file example_04.hpp.

◆ H1VectorDual() [3/5]

template<class Real>

H1VectorDual< Real >::H1VectorDual	(	const ROL::Ptr< std::vector< Real > > &	vec,
		const ROL::Ptr< BurgersFEM< Real > > &	fem )

inline

Definition at line 804 of file example_06.hpp.

◆ H1VectorDual() [4/5]

template<class Real>

H1VectorDual< Real >::H1VectorDual	(	const ROL::Ptr< std::vector< Real > > &	vec,
		const ROL::Ptr< BurgersFEM< Real > > &	fem )

inline

Definition at line 808 of file example_07.hpp.

◆ H1VectorDual() [5/5]

template<class Real>

H1VectorDual< Real >::H1VectorDual	(	const ROL::Ptr< std::vector< Real > > &	vec,
		const ROL::Ptr< BurgersFEM< Real > > &	fem )

inline

Definition at line 656 of file example_08.hpp.

Member Function Documentation

◆ dot() [1/5]

template<class Real>

Real H1VectorDual< Real >::dot ( const ROL::Vector< Real > & x ) const

inlineoverridevirtual

Reimplemented from ROL::StdVector< Real, Element >.

Definition at line 670 of file test_04.hpp.

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

◆ clone() [1/5]

template<class Real>

ROL::Ptr< ROL::Vector< Real > > H1VectorDual< Real >::clone ( ) const

inlineoverridevirtual

Clone to make a new (uninitialized) vector.

  @return         A reference-counted pointer to the cloned vector.

  Provides the means of allocating temporary memory in ROL.

  ---

Reimplemented from ROL::StdVector< Real, Element >.

Definition at line 684 of file test_04.hpp.

◆ dual() [1/5]

template<class Real>

const ROL::Vector< Real > & H1VectorDual< 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::ROL::Vector< Real >.

Definition at line 690 of file test_04.hpp.

◆ set() [1/3]

template<class Real>

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

inlinevirtual

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

  @param[in]      x     is a vector.

  On return \f$\mathtt{*this} = x\f$.
  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 804 of file example_04.hpp.

◆ plus() [1/3]

template<class Real>

void H1VectorDual< Real >::plus ( const ROL::Vector< Real > & x )

inlinevirtual

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

  @param[in]      x  is the vector to be added to \f$\mathtt{*this}\f$.

  On return \f$\mathtt{*this} = \mathtt{*this} + x\f$.

  ---

Implements ROL::Vector< Real >.

Definition at line 810 of file example_04.hpp.

◆ scale() [1/3]

template<class Real>

void H1VectorDual< Real >::scale ( const Real alpha )

inlinevirtual

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

  @param[in]      alpha is the scaling of \f$\mathtt{*this}\f$.

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

  ---

Implements ROL::ROL::Vector< Real >.

Definition at line 819 of file example_04.hpp.

◆ dot() [2/5]

template<class Real>

Real H1VectorDual< Real >::dot ( const ROL::Vector< Real > & x ) const

inlinevirtual

Reimplemented from ROL::StdVector< Real, Element >.

Definition at line 826 of file example_04.hpp.

◆ norm() [1/3]

template<class Real>

Real H1VectorDual< Real >::norm ( ) const

inlinevirtual

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

  @return         A nonnegative number equal to the norm of \f$\mathtt{*this}\f$.

  ---

Implements ROL::ROL::Vector< Real >.

Definition at line 839 of file example_04.hpp.

◆ clone() [2/5]

template<class Real>

ROL::Ptr< ROL::Vector< Real > > H1VectorDual< Real >::clone ( ) const

inlinevirtual

Clone to make a new (uninitialized) vector.

  @return         A reference-counted pointer to the cloned vector.

  Provides the means of allocating temporary memory in ROL.

  ---

Reimplemented from ROL::StdVector< Real, Element >.

Definition at line 845 of file example_04.hpp.

◆ getVector() [1/6]

template<class Real>

ROL::Ptr< const std::vector< Real > > H1VectorDual< Real >::getVector ( ) const

inline

Definition at line 849 of file example_04.hpp.

Referenced by H1VectorPrimal< RealT >::apply(), H1VectorDual< RealT >::dot(), H1VectorDual< RealT >::dot(), H1VectorDual< RealT >::plus(), and H1VectorDual< RealT >::set().

◆ getVector() [2/6]

template<class Real>

ROL::Ptr< std::vector< Real > > H1VectorDual< Real >::getVector ( )

inline

Definition at line 853 of file example_04.hpp.

◆ basis() [1/3]

template<class Real>

ROL::Ptr< ROL::Vector< Real > > H1VectorDual< Real >::basis ( const int i ) const

inlinevirtual

Return i-th basis vector.

  @param[in] i is the index of the basis function.
  @return A reference-counted pointer to the basis vector with index @b i.

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

  ---

Reimplemented from ROL::ROL::Vector< Real >.

Definition at line 857 of file example_04.hpp.

◆ dimension() [1/3]

template<class Real>

int H1VectorDual< Real >::dimension ( void ) const

inlinevirtual

Return dimension of the vector space.

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

  Overload if the basis is overloaded.

  ---

Reimplemented from ROL::ROL::Vector< Real >.

Definition at line 864 of file example_04.hpp.

◆ 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::ROL::Vector< Real >.

Definition at line 868 of file example_04.hpp.

◆ apply() [1/3]

template<class Real>

Real H1VectorDual< 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] x is a vector

Returns: The number equal to \(\langle \mathtt{*this}, x \rangle\).

Reimplemented from ROL::Vector< Real >.

Definition at line 876 of file example_04.hpp.

◆ set() [2/3]

template<class Real>

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

inlinevirtual

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

  @param[in]      x     is a vector.

  On return \f$\mathtt{*this} = x\f$.
  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 808 of file example_06.hpp.

◆ plus() [2/3]

template<class Real>

void H1VectorDual< Real >::plus ( const ROL::Vector< Real > & x )

inlinevirtual

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

  @param[in]      x  is the vector to be added to \f$\mathtt{*this}\f$.

  On return \f$\mathtt{*this} = \mathtt{*this} + x\f$.

  ---

Implements ROL::Vector< Real >.

Definition at line 814 of file example_06.hpp.

◆ scale() [2/3]

template<class Real>

void H1VectorDual< Real >::scale ( const Real alpha )

inlinevirtual

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

  @param[in]      alpha is the scaling of \f$\mathtt{*this}\f$.

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

  ---

Implements ROL::ROL::Vector< Real >.

Definition at line 823 of file example_06.hpp.

◆ dot() [3/5]

template<class Real>

Real H1VectorDual< Real >::dot ( const ROL::Vector< Real > & x ) const

inlinevirtual

Reimplemented from ROL::StdVector< Real, Element >.

Definition at line 830 of file example_06.hpp.

◆ norm() [2/3]

template<class Real>

Real H1VectorDual< Real >::norm ( ) const

inlinevirtual

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

  @return         A nonnegative number equal to the norm of \f$\mathtt{*this}\f$.

  ---

Implements ROL::ROL::Vector< Real >.

Definition at line 843 of file example_06.hpp.

◆ clone() [3/5]

template<class Real>

ROL::Ptr< ROL::Vector< Real > > H1VectorDual< Real >::clone ( ) const

inlinevirtual

Clone to make a new (uninitialized) vector.

  @return         A reference-counted pointer to the cloned vector.

  Provides the means of allocating temporary memory in ROL.

  ---

Reimplemented from ROL::StdVector< Real, Element >.

Definition at line 849 of file example_06.hpp.

◆ getVector() [3/6]

template<class Real>

ROL::Ptr< const std::vector< Real > > H1VectorDual< Real >::getVector ( ) const

inline

Definition at line 853 of file example_06.hpp.

◆ getVector() [4/6]

template<class Real>

ROL::Ptr< std::vector< Real > > H1VectorDual< Real >::getVector ( )

inline

Definition at line 857 of file example_06.hpp.

◆ basis() [2/3]

template<class Real>

ROL::Ptr< ROL::Vector< Real > > H1VectorDual< Real >::basis ( const int i ) const

inlinevirtual

Return i-th basis vector.

  @param[in] i is the index of the basis function.
  @return A reference-counted pointer to the basis vector with index @b i.

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

  ---

Reimplemented from ROL::ROL::Vector< Real >.

Definition at line 861 of file example_06.hpp.

◆ dimension() [2/3]

template<class Real>

int H1VectorDual< Real >::dimension ( void ) const

inlinevirtual

Return dimension of the vector space.

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

  Overload if the basis is overloaded.

  ---

Reimplemented from ROL::ROL::Vector< Real >.

Definition at line 868 of file example_06.hpp.

◆ 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::ROL::Vector< Real >.

Definition at line 872 of file example_06.hpp.

◆ apply() [2/3]

template<class Real>

Real H1VectorDual< 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] x is a vector

Returns: The number equal to \(\langle \mathtt{*this}, x \rangle\).

Reimplemented from ROL::Vector< Real >.

Definition at line 880 of file example_06.hpp.

◆ set() [3/3]

template<class Real>

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

inlinevirtual

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

  @param[in]      x     is a vector.

  On return \f$\mathtt{*this} = x\f$.
  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 812 of file example_07.hpp.

◆ plus() [3/3]

template<class Real>

void H1VectorDual< Real >::plus ( const ROL::Vector< Real > & x )

inlinevirtual

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

  @param[in]      x  is the vector to be added to \f$\mathtt{*this}\f$.

  On return \f$\mathtt{*this} = \mathtt{*this} + x\f$.

  ---

Implements ROL::Vector< Real >.

Definition at line 818 of file example_07.hpp.

◆ scale() [3/3]

template<class Real>

void H1VectorDual< Real >::scale ( const Real alpha )

inlinevirtual

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

  @param[in]      alpha is the scaling of \f$\mathtt{*this}\f$.

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

  ---

Implements ROL::ROL::Vector< Real >.

Definition at line 827 of file example_07.hpp.

◆ dot() [4/5]

template<class Real>

Real H1VectorDual< Real >::dot ( const ROL::Vector< Real > & x ) const

inlinevirtual

Reimplemented from ROL::StdVector< Real, Element >.

Definition at line 834 of file example_07.hpp.

◆ norm() [3/3]

template<class Real>

Real H1VectorDual< Real >::norm ( ) const

inlinevirtual

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

  @return         A nonnegative number equal to the norm of \f$\mathtt{*this}\f$.

  ---

Implements ROL::ROL::Vector< Real >.

Definition at line 847 of file example_07.hpp.

◆ clone() [4/5]

template<class Real>

ROL::Ptr< ROL::Vector< Real > > H1VectorDual< Real >::clone ( ) const

inlinevirtual

Clone to make a new (uninitialized) vector.

  @return         A reference-counted pointer to the cloned vector.

  Provides the means of allocating temporary memory in ROL.

  ---

Reimplemented from ROL::StdVector< Real, Element >.

Definition at line 853 of file example_07.hpp.

◆ getVector() [5/6]

template<class Real>

ROL::Ptr< const std::vector< Real > > H1VectorDual< Real >::getVector ( ) const

inline

Definition at line 857 of file example_07.hpp.

◆ getVector() [6/6]

template<class Real>

ROL::Ptr< std::vector< Real > > H1VectorDual< Real >::getVector ( )

inline

Definition at line 861 of file example_07.hpp.

◆ basis() [3/3]

template<class Real>

ROL::Ptr< ROL::Vector< Real > > H1VectorDual< Real >::basis ( const int i ) const

inlinevirtual

Return i-th basis vector.

  @param[in] i is the index of the basis function.
  @return A reference-counted pointer to the basis vector with index @b i.

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

  ---

Reimplemented from ROL::ROL::Vector< Real >.

Definition at line 865 of file example_07.hpp.

◆ dimension() [3/3]

template<class Real>

int H1VectorDual< Real >::dimension ( void ) const

inlinevirtual

Return dimension of the vector space.

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

  Overload if the basis is overloaded.

  ---

Reimplemented from ROL::ROL::Vector< Real >.

Definition at line 872 of file example_07.hpp.

◆ 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::ROL::Vector< Real >.

Definition at line 876 of file example_07.hpp.

◆ apply() [3/3]

template<class Real>

Real H1VectorDual< 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] x is a vector

Returns: The number equal to \(\langle \mathtt{*this}, x \rangle\).

Reimplemented from ROL::Vector< Real >.

Definition at line 884 of file example_07.hpp.

◆ dot() [5/5]

template<class Real>

Real H1VectorDual< Real >::dot ( const ROL::Vector< Real > & x ) const

inlinevirtual

Reimplemented from ROL::StdVector< Real, Element >.

Definition at line 661 of file example_08.hpp.

◆ clone() [5/5]

template<class Real>

ROL::Ptr< ROL::Vector< Real > > H1VectorDual< Real >::clone ( ) const

inlinevirtual

Clone to make a new (uninitialized) vector.

  @return         A reference-counted pointer to the cloned vector.

  Provides the means of allocating temporary memory in ROL.

  ---

Reimplemented from ROL::StdVector< Real, Element >.

Definition at line 675 of file example_08.hpp.

◆ 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::ROL::Vector< Real >.

Definition at line 680 of file example_08.hpp.

Member Data Documentation

◆ fem_

template<class Real>

ROL::Ptr< BurgersFEM< Real > > H1VectorDual< Real >::fem_

private

Definition at line 660 of file test_04.hpp.

◆ dual_vec_

template<class Real>

ROL::Ptr< H1VectorPrimal< Real > > H1VectorDual< Real >::dual_vec_

mutableprivate

Definition at line 661 of file test_04.hpp.

◆ isDualInitialized_

template<class Real>

bool H1VectorDual< Real >::isDualInitialized_

mutableprivate

Definition at line 662 of file test_04.hpp.

◆ vec_

template<class Real>

ROL::Ptr< std::vector< Real > > H1VectorDual< Real >::vec_

private

Definition at line 794 of file example_04.hpp.

◆ prim_vec_

template<class Real>

ROL::Ptr<H1VectorPrimal<Real> > H1VectorDual< Real >::prim_vec_

mutableprivate

Definition at line 652 of file example_08.hpp.

◆ isPrimalInitialized_

template<class Real>

bool H1VectorDual< Real >::isPrimalInitialized_

mutableprivate

Definition at line 653 of file example_08.hpp.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ H1VectorDual() [1/5]

◆ H1VectorDual() [2/5]

◆ H1VectorDual() [3/5]

◆ H1VectorDual() [4/5]

◆ H1VectorDual() [5/5]

Member Function Documentation

◆ dot() [1/5]

◆ clone() [1/5]

◆ dual() [1/5]

◆ set() [1/3]

◆ plus() [1/3]

◆ scale() [1/3]

◆ dot() [2/5]

◆ norm() [1/3]

◆ clone() [2/5]

◆ getVector() [1/6]

◆ getVector() [2/6]

◆ basis() [1/3]

◆ dimension() [1/3]

◆ dual() [2/5]

◆ apply() [1/3]

◆ set() [2/3]

◆ plus() [2/3]

◆ scale() [2/3]

◆ dot() [3/5]

◆ norm() [2/3]

◆ clone() [3/5]

◆ getVector() [3/6]

◆ getVector() [4/6]

◆ basis() [2/3]

◆ dimension() [2/3]

◆ dual() [3/5]

◆ apply() [2/3]

◆ set() [3/3]

◆ plus() [3/3]

◆ scale() [3/3]

◆ dot() [4/5]

◆ norm() [3/3]

◆ clone() [4/5]

◆ getVector() [5/6]

◆ getVector() [6/6]

◆ basis() [3/3]

◆ dimension() [3/3]

◆ dual() [4/5]

◆ apply() [3/3]

◆ dot() [5/5]

◆ clone() [5/5]

◆ dual() [5/5]

Member Data Documentation

◆ fem_

◆ dual_vec_

◆ isDualInitialized_

◆ vec_

◆ prim_vec_

◆ isPrimalInitialized_