#include <test_04.hpp>

Inheritance diagram for L2VectorPrimal< Real >:

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

Real	dot (const ROL::Vector< Real > &x) const override
	Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...

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

const ROL::Vector< Real > &	dual () const override
	Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout. More...

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

void	set (const ROL::Vector< Real > &x)
	Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...

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

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

Real	dot (const ROL::Vector< Real > &x) const
	Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...

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

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

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

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

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

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

const ROL::Vector< Real > &	dual () const
	Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout. More...

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

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

void	set (const ROL::Vector< Real > &x)
	Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...

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

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

Real	dot (const ROL::Vector< Real > &x) const
	Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...

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

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

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

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

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

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

const ROL::Vector< Real > &	dual () const
	Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout. More...

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

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

void	set (const ROL::Vector< Real > &x)
	Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...

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

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

Real	dot (const ROL::Vector< Real > &x) const
	Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...

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

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

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

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

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

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

const ROL::Vector< Real > &	dual () const
	Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout. More...

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

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

Real	dot (const ROL::Vector< Real > &x) const
	Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...

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

const ROL::Vector< Real > &	dual () const
	Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout. More...

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

	StdVector (const int dim, const Realval=0.0)

	StdVector (std::initializer_list< Real > ilist)

Real &	operator[] (int i)

const Real &	operator[] (int i) const

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

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

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

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

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

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

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

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

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

void	applyUnary (const Elementwise::UnaryFunction< Real > &f)

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

Real	reduce (const Elementwise::ReductionOp< Real > &r) const

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

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

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

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

virtual void	zero ()
	Set to zero vector. More...

virtual std::vector< Real >	checkVector (const Vector< Real > &x, const Vector< Real > &y, const bool printToStream=true, std::ostream &outStream=std::cout) const
	Verify vector-space methods. More...

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

ROL::Ptr< L2VectorDual< Real > >	dual_vec_

bool	isDualInitialized_

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

Detailed Description

template<class Real>
class L2VectorPrimal< Real >

Definition at line 23 of file test_04.hpp.

Constructor & Destructor Documentation

template<class Real>

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

inline

Definition at line 507 of file test_04.hpp.

template<class Real>

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

inline

Definition at line 501 of file example_04.hpp.

template<class Real>

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

inline

Definition at line 505 of file example_06.hpp.

template<class Real>

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

inline

Definition at line 509 of file example_07.hpp.

template<class Real>

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

inline

Definition at line 504 of file example_08.hpp.

Member Function Documentation

template<class Real>

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

inlineoverridevirtual

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

Parameters

[in] x is 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 512 of file test_04.hpp.

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

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

template<class Real>

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

inlineoverridevirtual

Clone to make a new (uninitialized) vector.

Returns: A reference-counted pointer to the cloned vector.

Provides the means of allocating temporary memory in ROL.

Implements ROL::Vector< Real >.

Definition at line 519 of file test_04.hpp.

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

template<class Real>

const ROL::Vector<Real>& L2VectorPrimal< Real >::dual ( void ) const

inlineoverridevirtual

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

Returns: A const reference to dual representation.

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

Reimplemented from ROL::Vector< Real >.

Definition at line 525 of file test_04.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

[in] x is a vector.

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

Reimplemented from ROL::Vector< Real >.

Definition at line 505 of file example_04.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

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

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

Implements ROL::Vector< Real >.

Definition at line 511 of file example_04.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

[in] alpha is the scaling of \(\mathtt{*this}\).

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

Implements ROL::Vector< Real >.

Definition at line 520 of file example_04.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

[in] x is 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 527 of file example_04.hpp.

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

template<class Real>

Real L2VectorPrimal< 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 533 of file example_04.hpp.

References L2VectorPrimal< Real >::dot().

template<class Real>

ROL::Ptr<ROL::Vector<Real> > L2VectorPrimal< 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 539 of file example_04.hpp.

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

template<class Real>

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

inline

Definition at line 543 of file example_04.hpp.

References L2VectorPrimal< Real >::vec_.

Referenced by L2VectorDual< Real >::apply(), L2VectorPrimal< Real >::dot(), Objective_BurgersControl< Real >::gradient_1(), L2VectorPrimal< Real >::plus(), L2VectorPrimal< Real >::set(), and Objective_BurgersControl< Real >::value().

template<class Real>

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

inline

Definition at line 547 of file example_04.hpp.

References L2VectorPrimal< Real >::vec_.

template<class Real>

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

inlinevirtual

Return i-th basis vector.

Parameters

[in] i is 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 551 of file example_04.hpp.

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

template<class Real>

int L2VectorPrimal< 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 558 of file example_04.hpp.

References L2VectorPrimal< Real >::vec_.

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

template<class Real>

const ROL::Vector<Real>& L2VectorPrimal< 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 562 of file example_04.hpp.

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

template<class Real>

Real L2VectorPrimal< 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 570 of file example_04.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

[in] x is a vector.

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

Reimplemented from ROL::Vector< Real >.

Definition at line 509 of file example_06.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

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

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

Implements ROL::Vector< Real >.

Definition at line 515 of file example_06.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

[in] alpha is the scaling of \(\mathtt{*this}\).

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

Implements ROL::Vector< Real >.

Definition at line 524 of file example_06.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

[in] x is 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 531 of file example_06.hpp.

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

template<class Real>

Real L2VectorPrimal< 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 537 of file example_06.hpp.

References L2VectorPrimal< Real >::dot().

template<class Real>

ROL::Ptr<ROL::Vector<Real> > L2VectorPrimal< 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 543 of file example_06.hpp.

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

template<class Real>

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

inline

Definition at line 547 of file example_06.hpp.

References L2VectorPrimal< Real >::vec_.

template<class Real>

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

inline

Definition at line 551 of file example_06.hpp.

References L2VectorPrimal< Real >::vec_.

template<class Real>

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

inlinevirtual

Return i-th basis vector.

Parameters

[in] i is 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 555 of file example_06.hpp.

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

template<class Real>

int L2VectorPrimal< 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 562 of file example_06.hpp.

References L2VectorPrimal< Real >::vec_.

template<class Real>

const ROL::Vector<Real>& L2VectorPrimal< 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 566 of file example_06.hpp.

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

template<class Real>

Real L2VectorPrimal< 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 574 of file example_06.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

[in] x is a vector.

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

Reimplemented from ROL::Vector< Real >.

Definition at line 513 of file example_07.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

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

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

Implements ROL::Vector< Real >.

Definition at line 519 of file example_07.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

[in] alpha is the scaling of \(\mathtt{*this}\).

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

Implements ROL::Vector< Real >.

Definition at line 528 of file example_07.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

[in] x is 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 535 of file example_07.hpp.

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

template<class Real>

Real L2VectorPrimal< 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 541 of file example_07.hpp.

References L2VectorPrimal< Real >::dot().

template<class Real>

ROL::Ptr<ROL::Vector<Real> > L2VectorPrimal< 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 547 of file example_07.hpp.

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

template<class Real>

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

inline

Definition at line 551 of file example_07.hpp.

References L2VectorPrimal< Real >::vec_.

template<class Real>

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

inline

Definition at line 555 of file example_07.hpp.

References L2VectorPrimal< Real >::vec_.

template<class Real>

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

inlinevirtual

Return i-th basis vector.

Parameters

[in] i is 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 559 of file example_07.hpp.

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

template<class Real>

int L2VectorPrimal< 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 566 of file example_07.hpp.

References L2VectorPrimal< Real >::vec_.

template<class Real>

const ROL::Vector<Real>& L2VectorPrimal< 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 570 of file example_07.hpp.

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

template<class Real>

Real L2VectorPrimal< 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 578 of file example_07.hpp.

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

template<class Real>

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

inlinevirtual

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

Parameters

[in] x is 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 509 of file example_08.hpp.

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

template<class Real>

ROL::Ptr<ROL::Vector<Real> > L2VectorPrimal< 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 516 of file example_08.hpp.

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

template<class Real>

const ROL::Vector<Real>& L2VectorPrimal< 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 521 of file example_08.hpp.

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

Member Data Documentation

template<class Real>

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

private

Definition at line 502 of file test_04.hpp.

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

template<class Real>

ROL::Ptr< L2VectorDual< Real > > L2VectorPrimal< Real >::dual_vec_

mutableprivate

Definition at line 503 of file test_04.hpp.

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

template<class Real>

bool L2VectorPrimal< Real >::isDualInitialized_

mutableprivate

Definition at line 504 of file test_04.hpp.

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

template<class Real>

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

private

Definition at line 495 of file example_04.hpp.

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

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

Public Member Functions

Private Attributes

Detailed Description

template<class Real> class L2VectorPrimal< Real >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Real>
class L2VectorPrimal< Real >