Poisson distributed control. More...

#include <ROL_PoissonControl.hpp>

Inheritance diagram for ROL::ZOO::Objective_PoissonControl< Real >:

Public Member Functions
	Objective_PoissonControl (Real alpha=1.e-4)
void	apply_mass (Vector< Real > &Mz, const Vector< Real > &z)
void	solve_poisson (Vector< Real > &u, const Vector< Real > &z)
Real	evaluate_target (Real x)
Real	value (const Vector< Real > &z, Real &tol)
void	gradient (Vector< Real > &g, const Vector< Real > &z, Real &tol)
Public Member Functions inherited from ROL::ROL::Objective< Real >
virtual	~Objective ()
	Objective ()
virtual void	update (const Vector< Real > &x, UpdateType type, int iter=-1)
	Update objective function.
virtual void	update (const Vector< Real > &x, bool flag=true, int iter=-1)
	Update objective function.
virtual Real	value (const Vector< Real > &x, Real &tol)=0
	Compute value.
virtual void	gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
	Compute gradient.
virtual Real	dirDeriv (const Vector< Real > &x, const Vector< Real > &d, Real &tol)
	Compute directional derivative.
virtual void	hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply Hessian approximation to vector.
virtual void	invHessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply inverse Hessian approximation to vector.
virtual void	precond (Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply preconditioner to vector.
virtual void	prox (Vector< Real > &Pv, const Vector< Real > &v, Real t, Real &tol)
	Compute the proximity operator.
virtual void	proxJacVec (Vector< Real > &Jv, const Vector< Real > &v, const Vector< Real > &x, Real t, Real &tol)
	Apply the Jacobian of the proximity operator.
virtual std::vector< std::vector< Real > >	checkGradient (const Vector< Real > &x, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference gradient check.
virtual std::vector< std::vector< Real > >	checkGradient (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference gradient check.
virtual std::vector< std::vector< Real > >	checkGradient (const Vector< Real > &x, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference gradient check with specified step sizes.
virtual std::vector< std::vector< Real > >	checkGradient (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference gradient check with specified step sizes.
virtual std::vector< std::vector< Real > >	checkHessVec (const Vector< Real > &x, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference Hessian-applied-to-vector check.
virtual std::vector< std::vector< Real > >	checkHessVec (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference Hessian-applied-to-vector check.
virtual std::vector< std::vector< Real > >	checkHessVec (const Vector< Real > &x, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference Hessian-applied-to-vector check with specified step sizes.
virtual std::vector< std::vector< Real > >	checkHessVec (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference Hessian-applied-to-vector check with specified step sizes.
virtual std::vector< Real >	checkHessSym (const Vector< Real > &x, const Vector< Real > &v, const Vector< Real > &w, const bool printToStream=true, std::ostream &outStream=std::cout)
	Hessian symmetry check.
virtual std::vector< Real >	checkHessSym (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &w, const bool printToStream=true, std::ostream &outStream=std::cout)
	Hessian symmetry check.
virtual std::vector< std::vector< Real > >	checkProxJacVec (const Vector< Real > &x, const Vector< Real > &v, Real t=Real(1), bool printToStream=true, std::ostream &outStream=std::cout, int numSteps=ROL_NUM_CHECKDERIV_STEPS)
	Finite-difference proximity operator Jacobian-applied-to-vector check.
virtual void	setParameter (const std::vector< Real > &param)

Private Types
typedef std::vector< Real >	vector
typedef Vector< Real >	V
typedef StdVector< Real >	SV
typedef vector::size_type	uint

Private Member Functions
ROL::Ptr< const vector >	getVector (const V &x)
ROL::Ptr< vector >	getVector (V &x)

Private Attributes
Real	alpha_

Additional Inherited Members
Protected Member Functions inherited from ROL::ROL::Objective< Real >
const std::vector< Real >	getParameter (void) const

Detailed Description

template<class Real>
class ROL::ZOO::Objective_PoissonControl< Real >

Poisson distributed control.

Definition at line 31 of file ROL_PoissonControl.hpp.

Member Typedef Documentation

◆ vector

template<class Real>

typedef std::vector<Real> ROL::ZOO::Objective_PoissonControl< Real >::vector

private

Definition at line 33 of file ROL_PoissonControl.hpp.

◆ V

template<class Real>

typedef Vector<Real> ROL::ZOO::Objective_PoissonControl< Real >::V

private

Definition at line 34 of file ROL_PoissonControl.hpp.

◆ SV

template<class Real>

typedef StdVector<Real> ROL::ZOO::Objective_PoissonControl< Real >::SV

private

Definition at line 35 of file ROL_PoissonControl.hpp.

◆ uint

template<class Real>

typedef vector::size_type ROL::ZOO::Objective_PoissonControl< Real >::uint

private

Definition at line 37 of file ROL_PoissonControl.hpp.

Constructor & Destructor Documentation

◆ Objective_PoissonControl()

template<class Real>

ROL::ZOO::Objective_PoissonControl< Real >::Objective_PoissonControl ( Real alpha = 1.e-4 )

inline

Definition at line 54 of file ROL_PoissonControl.hpp.

References alpha_.

Member Function Documentation

◆ getVector() [1/2]

template<class Real>

ROL::Ptr< const vector > ROL::ZOO::Objective_PoissonControl< Real >::getVector ( const V & x )

inlineprivate

Definition at line 42 of file ROL_PoissonControl.hpp.

References getVector().

Referenced by apply_mass(), getVector(), getVector(), gradient(), solve_poisson(), and value().

◆ getVector() [2/2]

template<class Real>

ROL::Ptr< vector > ROL::ZOO::Objective_PoissonControl< Real >::getVector ( V & x )

inlineprivate

Definition at line 47 of file ROL_PoissonControl.hpp.

References getVector().

◆ apply_mass()

template<class Real>

void ROL::ZOO::Objective_PoissonControl< Real >::apply_mass	(	Vector< Real > &	Mz,
		const Vector< Real > &	z )

inline

Definition at line 56 of file ROL_PoissonControl.hpp.

References getVector().

Referenced by solve_poisson().

◆ solve_poisson()

template<class Real>

void ROL::ZOO::Objective_PoissonControl< Real >::solve_poisson	(	Vector< Real > &	u,
		const Vector< Real > &	z )

inline

Definition at line 77 of file ROL_PoissonControl.hpp.

References apply_mass(), and getVector().

Referenced by gradient(), and value().

◆ evaluate_target()

template<class Real>

Real ROL::ZOO::Objective_PoissonControl< Real >::evaluate_target ( Real x )

inline

Definition at line 106 of file ROL_PoissonControl.hpp.

References alpha_.

Referenced by gradient(), and value().

◆ value()

template<class Real>

Real ROL::ZOO::Objective_PoissonControl< Real >::value	(	const Vector< Real > &	z,
		Real &	tol )

inline

Definition at line 111 of file ROL_PoissonControl.hpp.

References alpha_, evaluate_target(), getVector(), and solve_poisson().

◆ gradient()

template<class Real>

void ROL::ZOO::Objective_PoissonControl< Real >::gradient	(	Vector< Real > &	g,
		const Vector< Real > &	z,
		Real &	tol )

inline

Definition at line 154 of file ROL_PoissonControl.hpp.

References alpha_, evaluate_target(), getVector(), and solve_poisson().

Member Data Documentation

◆ alpha_

template<class Real>

Real ROL::ZOO::Objective_PoissonControl< Real >::alpha_

private

Definition at line 40 of file ROL_PoissonControl.hpp.

Referenced by evaluate_target(), gradient(), Objective_PoissonControl(), and value().

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

ROL_PoissonControl.hpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ vector

◆ V

◆ SV

◆ uint

Constructor & Destructor Documentation

◆ Objective_PoissonControl()

Member Function Documentation

◆ getVector() [1/2]

◆ getVector() [2/2]

◆ apply_mass()

◆ solve_poisson()

◆ evaluate_target()

◆ value()

◆ gradient()

Member Data Documentation

◆ alpha_