#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)

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...

	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...

	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...

	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...

	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 Real val=0.0)

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< std::vector< Real > >	vec_

ROL::Ptr< BurgersFEM< Real > >	fem_

ROL::Ptr< H1VectorDual< Real > >	dual_vec_

bool	isDualInitialized_

Detailed Description

template<class Real>
class H1VectorPrimal< Real >

Definition at line 63 of file test_04.hpp.

Constructor & Destructor Documentation

◆ H1VectorPrimal() [1/5]

template<class Real >

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

inline

Definition at line 709 of file test_04.hpp.

◆ H1VectorPrimal() [2/5]

template<class Real >

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

inline

Definition at line 702 of file example_04.hpp.

◆ H1VectorPrimal() [3/5]

template<class Real >

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

inline

Definition at line 706 of file example_06.hpp.

◆ H1VectorPrimal() [4/5]

template<class Real >

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

inline

Definition at line 710 of file example_07.hpp.

◆ H1VectorPrimal() [5/5]

template<class Real >

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

inline

Definition at line 619 of file example_08.hpp.

Member Function Documentation

◆ set() [1/4]

template<class Real >

void H1VectorPrimal< 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 713 of file test_04.hpp.

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

◆ plus() [1/4]

template<class Real >

void H1VectorPrimal< 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 719 of file test_04.hpp.

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

◆ scale() [1/4]

template<class Real >

void H1VectorPrimal< 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::Vector< Real >.

Definition at line 728 of file test_04.hpp.

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

◆ dot() [1/5]

template<class Real >

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

inlinevirtual

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

   @param[in]      x  is the vector that forms the dot product with \f$\mathtt{*this}\f$.
   @return         The number equal to \f$\langle \mathtt{*this}, x \rangle\f$.

   ---

Implements ROL::Vector< Real >.

Definition at line 735 of file test_04.hpp.

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

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

◆ norm() [1/4]

template<class Real >

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

Definition at line 741 of file test_04.hpp.

References H1VectorPrimal< Real >::dot().

◆ clone() [1/5]

template<class Real >

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

   ---

Implements ROL::Vector< Real >.

Definition at line 747 of file test_04.hpp.

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

◆ getVector() [1/8]

template<class Real >

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

inline

Definition at line 751 of file test_04.hpp.

References H1VectorPrimal< Real >::vec_.

Referenced by H1VectorPrimal< Real >::dot(), H1VectorPrimal< Real >::plus(), and H1VectorPrimal< Real >::set().

◆ getVector() [2/8]

template<class Real >

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

inline

Definition at line 755 of file test_04.hpp.

References H1VectorPrimal< Real >::vec_.

◆ basis() [1/4]

template<class Real >

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

Definition at line 759 of file test_04.hpp.

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

◆ dimension() [1/4]

template<class Real >

int H1VectorPrimal< 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::Vector< Real >.

Definition at line 766 of file test_04.hpp.

References H1VectorPrimal< Real >::vec_.

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

◆ dual() [1/5]

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

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

◆ set() [2/4]

template<class Real >

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

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

◆ plus() [2/4]

template<class Real >

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

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

◆ scale() [2/4]

template<class Real >

void H1VectorPrimal< 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::Vector< Real >.

Definition at line 721 of file example_04.hpp.

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

◆ dot() [2/5]

template<class Real >

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

inlinevirtual

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

   @param[in]      x  is the vector that forms the dot product with \f$\mathtt{*this}\f$.
   @return         The number equal to \f$\langle \mathtt{*this}, x \rangle\f$.

   ---

Implements ROL::Vector< Real >.

Definition at line 728 of file example_04.hpp.

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

◆ norm() [2/4]

template<class Real >

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

Definition at line 734 of file example_04.hpp.

References H1VectorPrimal< Real >::dot().

◆ clone() [2/5]

template<class Real >

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

   ---

Implements ROL::Vector< Real >.

Definition at line 740 of file example_04.hpp.

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

◆ getVector() [3/8]

template<class Real >

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

inline

Definition at line 744 of file example_04.hpp.

References H1VectorPrimal< Real >::vec_.

◆ getVector() [4/8]

template<class Real >

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

inline

Definition at line 748 of file example_04.hpp.

References H1VectorPrimal< Real >::vec_.

◆ basis() [2/4]

template<class Real >

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

Definition at line 752 of file example_04.hpp.

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

◆ dimension() [2/4]

template<class Real >

int H1VectorPrimal< 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::Vector< Real >.

Definition at line 759 of file example_04.hpp.

References H1VectorPrimal< Real >::vec_.

◆ dual() [2/5]

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.

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

◆ set() [3/4]

template<class Real >

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

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

◆ plus() [3/4]

template<class Real >

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

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

◆ scale() [3/4]

template<class Real >

void H1VectorPrimal< 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::Vector< Real >.

Definition at line 725 of file example_06.hpp.

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

◆ dot() [3/5]

template<class Real >

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

inlinevirtual

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

   @param[in]      x  is the vector that forms the dot product with \f$\mathtt{*this}\f$.
   @return         The number equal to \f$\langle \mathtt{*this}, x \rangle\f$.

   ---

Implements ROL::Vector< Real >.

Definition at line 732 of file example_06.hpp.

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

◆ norm() [3/4]

template<class Real >

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

Definition at line 738 of file example_06.hpp.

References H1VectorPrimal< Real >::dot().

◆ clone() [3/5]

template<class Real >

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

   ---

Implements ROL::Vector< Real >.

Definition at line 744 of file example_06.hpp.

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

◆ getVector() [5/8]

template<class Real >

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

inline

Definition at line 748 of file example_06.hpp.

References H1VectorPrimal< Real >::vec_.

◆ getVector() [6/8]

template<class Real >

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

inline

Definition at line 752 of file example_06.hpp.

References H1VectorPrimal< Real >::vec_.

◆ basis() [3/4]

template<class Real >

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

Definition at line 756 of file example_06.hpp.

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

◆ dimension() [3/4]

template<class Real >

int H1VectorPrimal< 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::Vector< Real >.

Definition at line 763 of file example_06.hpp.

References H1VectorPrimal< Real >::vec_.

◆ dual() [3/5]

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.

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

◆ set() [4/4]

template<class Real >

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

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

◆ plus() [4/4]

template<class Real >

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

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

◆ scale() [4/4]

template<class Real >

void H1VectorPrimal< 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::Vector< Real >.

Definition at line 729 of file example_07.hpp.

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

◆ dot() [4/5]

template<class Real >

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

inlinevirtual

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

   @param[in]      x  is the vector that forms the dot product with \f$\mathtt{*this}\f$.
   @return         The number equal to \f$\langle \mathtt{*this}, x \rangle\f$.

   ---

Implements ROL::Vector< Real >.

Definition at line 736 of file example_07.hpp.

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

◆ norm() [4/4]

template<class Real >

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

Definition at line 742 of file example_07.hpp.

References H1VectorPrimal< Real >::dot().

◆ clone() [4/5]

template<class Real >

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

   ---

Implements ROL::Vector< Real >.

Definition at line 748 of file example_07.hpp.

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

◆ getVector() [7/8]

template<class Real >

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

inline

Definition at line 752 of file example_07.hpp.

References H1VectorPrimal< Real >::vec_.

◆ getVector() [8/8]

template<class Real >

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

inline

Definition at line 756 of file example_07.hpp.

References H1VectorPrimal< Real >::vec_.

◆ basis() [4/4]

template<class Real >

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

Definition at line 760 of file example_07.hpp.

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

◆ dimension() [4/4]

template<class Real >

int H1VectorPrimal< 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::Vector< Real >.

Definition at line 767 of file example_07.hpp.

References H1VectorPrimal< Real >::vec_.

◆ dual() [4/5]

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.

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

◆ dot() [5/5]

template<class Real >

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

inlinevirtual

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

   @param[in]      x  is the vector that forms the dot product with \f$\mathtt{*this}\f$.
   @return         The number equal to \f$\langle \mathtt{*this}, x \rangle\f$.

   ---

Implements ROL::Vector< Real >.

Definition at line 624 of file example_08.hpp.

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

◆ clone() [5/5]

template<class Real >

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

   ---

Implements ROL::Vector< Real >.

Definition at line 631 of file example_08.hpp.

References H1VectorPrimal< Real >::fem_.

◆ dual() [5/5]

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 636 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

◆ vec_

template<class Real >

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

private

Definition at line 703 of file test_04.hpp.

Referenced by H1VectorPrimal< Real >::basis(), H1VectorPrimal< Real >::clone(), H1VectorPrimal< Real >::dimension(), H1VectorPrimal< Real >::dot(), H1VectorPrimal< Real >::dual(), H1VectorPrimal< Real >::getVector(), H1VectorPrimal< Real >::plus(), H1VectorPrimal< Real >::scale(), and H1VectorPrimal< Real >::set().

◆ fem_

template<class Real >

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

private

Definition at line 704 of file test_04.hpp.

Referenced by H1VectorPrimal< Real >::basis(), H1VectorPrimal< Real >::clone(), H1VectorPrimal< Real >::dot(), and H1VectorPrimal< Real >::dual().

◆ dual_vec_

template<class Real >

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

mutableprivate

Definition at line 706 of file test_04.hpp.

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

◆ isDualInitialized_

template<class Real >

bool H1VectorPrimal< Real >::isDualInitialized_

mutableprivate

Definition at line 616 of file example_08.hpp.

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

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

Public Member Functions

Private Attributes

Detailed Description

template<class Real> class H1VectorPrimal< Real >

Constructor & Destructor Documentation

◆ H1VectorPrimal() [1/5]

◆ H1VectorPrimal() [2/5]

◆ H1VectorPrimal() [3/5]

◆ H1VectorPrimal() [4/5]

◆ H1VectorPrimal() [5/5]

Member Function Documentation

◆ set() [1/4]

◆ plus() [1/4]

◆ scale() [1/4]

◆ dot() [1/5]

◆ norm() [1/4]

◆ clone() [1/5]

◆ getVector() [1/8]

◆ getVector() [2/8]

◆ basis() [1/4]

◆ dimension() [1/4]

◆ dual() [1/5]

◆ set() [2/4]

◆ plus() [2/4]

◆ scale() [2/4]

◆ dot() [2/5]

◆ norm() [2/4]

◆ clone() [2/5]

◆ getVector() [3/8]

◆ getVector() [4/8]

◆ basis() [2/4]

◆ dimension() [2/4]

◆ dual() [2/5]

◆ set() [3/4]

◆ plus() [3/4]

◆ scale() [3/4]

◆ dot() [3/5]

◆ norm() [3/4]

◆ clone() [3/5]

◆ getVector() [5/8]

◆ getVector() [6/8]

◆ basis() [3/4]

◆ dimension() [3/4]

◆ dual() [3/5]

◆ set() [4/4]

◆ plus() [4/4]

◆ scale() [4/4]

◆ dot() [4/5]

◆ norm() [4/4]

◆ clone() [4/5]

◆ getVector() [7/8]

◆ getVector() [8/8]

◆ basis() [4/4]

◆ dimension() [4/4]

◆ dual() [4/5]

◆ dot() [5/5]

◆ clone() [5/5]

◆ dual() [5/5]

Member Data Documentation

◆ vec_

◆ fem_

◆ dual_vec_

◆ isDualInitialized_

template<class Real>
class H1VectorPrimal< Real >