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

#include <example_02.hpp>

Inheritance diagram for DiffusionObjective< Real >:

Public Member Functions

 DiffusionObjective (const ROL::Ptr< FEM< Real > > fem, const Real alpha=1.e-4)
Real value (const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
 Compute value.
void gradient_1 (ROL::Vector< Real > &g, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
 Compute gradient with respect to first component.
void gradient_2 (ROL::Vector< Real > &g, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
 Compute gradient with respect to second component.
void hessVec_11 (ROL::Vector< Real > &hv, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
 Apply Hessian approximation to vector.
void hessVec_12 (ROL::Vector< Real > &hv, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
void hessVec_21 (ROL::Vector< Real > &hv, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
void hessVec_22 (ROL::Vector< Real > &hv, const ROL::Vector< Real > &v, const ROL::Vector< Real > &u, const ROL::Vector< Real > &z, Real &tol)
Public Member Functions inherited from ROL::Objective_SimOpt< Real >
virtual void update (const Vector< Real > &u, const Vector< Real > &z, bool flag=true, int iter=-1)
 Update objective function.
u is an iterate, z is an iterate, flag = true if the iterate has changed, iter is the outer algorithm iterations count.
void update (const Vector< Real > &x, bool flag=true, int iter=-1)
virtual void update (const Vector< Real > &u, const Vector< Real > &z, UpdateType type, int iter=-1)
void update (const Vector< Real > &x, UpdateType type, int iter=-1)
Real value (const Vector< Real > &x, Real &tol)
void gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
void hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
std::vector< std::vector< Real > > checkGradient_1 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
std::vector< std::vector< Real > > checkGradient_1 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &g, const Vector< Real > &d, const bool printToStream, std::ostream &outStream, const int numSteps, const int order)
std::vector< std::vector< Real > > checkGradient_1 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &g, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream, std::ostream &outStream, const int order)
std::vector< std::vector< Real > > checkGradient_2 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
std::vector< std::vector< Real > > checkGradient_2 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &g, const Vector< Real > &d, const bool printToStream, std::ostream &outStream, const int numSteps, const int order)
std::vector< std::vector< Real > > checkGradient_2 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &g, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream, std::ostream &outStream, const int order)
std::vector< std::vector< Real > > checkHessVec_11 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
std::vector< std::vector< Real > > checkHessVec_11 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
std::vector< std::vector< Real > > checkHessVec_11 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream, std::ostream &outStream, const int numSteps, const int order)
std::vector< std::vector< Real > > checkHessVec_11 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream, std::ostream &outStream, const int order)
std::vector< std::vector< Real > > checkHessVec_12 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
std::vector< std::vector< Real > > checkHessVec_12 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
std::vector< std::vector< Real > > checkHessVec_12 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream, std::ostream &outStream, const int numSteps, const int order)
std::vector< std::vector< Real > > checkHessVec_12 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream, std::ostream &outStream, const int order)
std::vector< std::vector< Real > > checkHessVec_21 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
std::vector< std::vector< Real > > checkHessVec_21 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
std::vector< std::vector< Real > > checkHessVec_21 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream, std::ostream &outStream, const int numSteps, const int order)
std::vector< std::vector< Real > > checkHessVec_21 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream, std::ostream &outStream, const int order)
std::vector< std::vector< Real > > checkHessVec_22 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
std::vector< std::vector< Real > > checkHessVec_22 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
std::vector< std::vector< Real > > checkHessVec_22 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream, std::ostream &outStream, const int numSteps, const int order)
std::vector< std::vector< Real > > checkHessVec_22 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream, std::ostream &outStream, const int order)
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 Member Functions

Real dot (const std::vector< Real > &x, const std::vector< Real > &y)
void scale (std::vector< Real > &u, const Real alpha=0.0)

Private Attributes

const ROL::Ptr< FEM< Real > > FEM_
const 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 DiffusionObjective< Real >

Definition at line 556 of file poisson-control/example_02.hpp.

Constructor & Destructor Documentation

◆ DiffusionObjective()

template<class Real>
DiffusionObjective< Real >::DiffusionObjective ( const ROL::Ptr< FEM< Real > > fem,
const Real alpha = 1.e-4 )
inline

Definition at line 586 of file poisson-control/example_02.hpp.

References alpha_, and FEM_.

Member Function Documentation

◆ dot()

template<class Real>
Real DiffusionObjective< Real >::dot ( const std::vector< Real > & x,
const std::vector< Real > & y )
inlineprivate

Definition at line 565 of file poisson-control/example_02.hpp.

Referenced by value().

◆ scale()

template<class Real>
void DiffusionObjective< Real >::scale ( std::vector< Real > & u,
const Real alpha = 0.0 )
inlineprivate

Definition at line 575 of file poisson-control/example_02.hpp.

Referenced by gradient_2(), and hessVec_22().

◆ value()

template<class Real>
Real DiffusionObjective< Real >::value ( const ROL::Vector< Real > & u,
const ROL::Vector< Real > & z,
Real & tol )
inlinevirtual

Compute value.

Implements ROL::Objective_SimOpt< Real >.

Definition at line 589 of file poisson-control/example_02.hpp.

References alpha_, dot(), FEM_, and ROL::ROL::Objective< Real >::getParameter().

◆ gradient_1()

template<class Real>
void DiffusionObjective< Real >::gradient_1 ( ROL::Vector< Real > & g,
const ROL::Vector< Real > & u,
const ROL::Vector< Real > & z,
Real & tol )
inlinevirtual

Compute gradient with respect to first component.

Reimplemented from ROL::Objective_SimOpt< Real >.

Definition at line 608 of file poisson-control/example_02.hpp.

References FEM_, and ROL::ROL::Objective< Real >::getParameter().

◆ gradient_2()

template<class Real>
void DiffusionObjective< Real >::gradient_2 ( ROL::Vector< Real > & g,
const ROL::Vector< Real > & u,
const ROL::Vector< Real > & z,
Real & tol )
inlinevirtual

Compute gradient with respect to second component.

Reimplemented from ROL::Objective_SimOpt< Real >.

Definition at line 620 of file poisson-control/example_02.hpp.

References alpha_, FEM_, and scale().

◆ hessVec_11()

template<class Real>
void DiffusionObjective< Real >::hessVec_11 ( ROL::Vector< Real > & hv,
const ROL::Vector< Real > & v,
const ROL::Vector< Real > & u,
const ROL::Vector< Real > & z,
Real & tol )
inlinevirtual

Apply Hessian approximation to vector.

Reimplemented from ROL::Objective_SimOpt< Real >.

Definition at line 628 of file poisson-control/example_02.hpp.

References FEM_, and ROL::ROL::Objective< Real >::getParameter().

◆ hessVec_12()

template<class Real>
void DiffusionObjective< Real >::hessVec_12 ( ROL::Vector< Real > & hv,
const ROL::Vector< Real > & v,
const ROL::Vector< Real > & u,
const ROL::Vector< Real > & z,
Real & tol )
inlinevirtual

Reimplemented from ROL::Objective_SimOpt< Real >.

Definition at line 636 of file poisson-control/example_02.hpp.

References ROL::Vector< Real >::zero().

◆ hessVec_21()

template<class Real>
void DiffusionObjective< Real >::hessVec_21 ( ROL::Vector< Real > & hv,
const ROL::Vector< Real > & v,
const ROL::Vector< Real > & u,
const ROL::Vector< Real > & z,
Real & tol )
inlinevirtual

Reimplemented from ROL::Objective_SimOpt< Real >.

Definition at line 641 of file poisson-control/example_02.hpp.

References ROL::Vector< Real >::zero().

◆ hessVec_22()

template<class Real>
void DiffusionObjective< Real >::hessVec_22 ( ROL::Vector< Real > & hv,
const ROL::Vector< Real > & v,
const ROL::Vector< Real > & u,
const ROL::Vector< Real > & z,
Real & tol )
inlinevirtual

Reimplemented from ROL::Objective_SimOpt< Real >.

Definition at line 646 of file poisson-control/example_02.hpp.

References alpha_, FEM_, and scale().

Member Data Documentation

◆ FEM_

template<class Real>
const ROL::Ptr<FEM<Real> > DiffusionObjective< Real >::FEM_
private

Definition at line 558 of file poisson-control/example_02.hpp.

Referenced by DiffusionObjective(), gradient_1(), gradient_2(), hessVec_11(), hessVec_22(), and value().

◆ alpha_

template<class Real>
const Real DiffusionObjective< Real >::alpha_
private

Definition at line 559 of file poisson-control/example_02.hpp.

Referenced by DiffusionObjective(), gradient_2(), hessVec_22(), and value().

The documentation for this class was generated from the following file:
Generated by doxygen 1.15.0