ROL
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ROL::ZOO::Objective_PoissonInversion< Real > Class Template Reference

Poisson material inversion. More...

#include <ROL_PoissonInversion.hpp>

+ Inheritance diagram for ROL::ZOO::Objective_PoissonInversion< Real >:

Public Member Functions

 Objective_PoissonInversion (uint nz=32, Real alpha=1.e-4)
 
Real reg_value (const Vector< Real > &z)
 
void reg_gradient (Vector< Real > &g, const Vector< Real > &z)
 
void reg_hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &z)
 
void apply_mass (Vector< Real > &Mf, const Vector< Real > &f)
 
void solve_poisson (Vector< Real > &u, const Vector< Real > &z, Vector< Real > &b)
 
Real evaluate_target (Real x)
 
void apply_linearized_control_operator (Vector< Real > &Bd, const Vector< Real > &z, const Vector< Real > &d, const Vector< Real > &u)
 
void apply_transposed_linearized_control_operator (Vector< Real > &Bd, const Vector< Real > &z, const Vector< Real > &d, const Vector< Real > &u)
 
void apply_transposed_linearized_control_operator_2 (Vector< Real > &Bd, const Vector< Real > &z, const Vector< Real > &v, const Vector< Real > &d, const Vector< Real > &u)
 
void solve_state_equation (Vector< Real > &u, const Vector< Real > &z)
 
void solve_adjoint_equation (Vector< Real > &p, const Vector< Real > &u, const Vector< Real > &z)
 
void solve_state_sensitivity_equation (Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z)
 
void solve_adjoint_sensitivity_equation (Vector< Real > &q, const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &p, const Vector< Real > &u, const Vector< Real > &z)
 
Real value (const Vector< Real > &z, Real &tol)
 Compute value. More...
 
void gradient (Vector< Real > &g, const Vector< Real > &z, Real &tol)
 Compute gradient. More...
 
void invHessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply inverse Hessian approximation to vector. More...
 
- Public Member Functions inherited from ROL::Objective< Real >
virtual ~Objective ()
 
virtual void update (const Vector< Real > &x, bool flag=true, int iter=-1)
 Update objective function. More...
 
virtual Real dirDeriv (const Vector< Real > &x, const Vector< Real > &d, Real &tol)
 Compute directional derivative. More...
 
virtual void hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply Hessian approximation to vector. More...
 
virtual void precond (Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply preconditioner to vector. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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 vectorgetVector (const V &x)
 
ROL::Ptr< vectorgetVector (V &x)
 

Private Attributes

uint nu_
 
uint nz_
 
Real hu_
 
Real hz_
 
Real alpha_
 
Real eps_
 
int reg_type_
 

Additional Inherited Members

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

Detailed Description

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

Poisson material inversion.

Definition at line 68 of file ROL_PoissonInversion.hpp.

Member Typedef Documentation

template<class Real>
typedef std::vector<Real> ROL::ZOO::Objective_PoissonInversion< Real >::vector
private

Definition at line 70 of file ROL_PoissonInversion.hpp.

template<class Real>
typedef Vector<Real> ROL::ZOO::Objective_PoissonInversion< Real >::V
private

Definition at line 71 of file ROL_PoissonInversion.hpp.

template<class Real>
typedef StdVector<Real> ROL::ZOO::Objective_PoissonInversion< Real >::SV
private

Definition at line 72 of file ROL_PoissonInversion.hpp.

template<class Real>
typedef vector::size_type ROL::ZOO::Objective_PoissonInversion< Real >::uint
private

Definition at line 74 of file ROL_PoissonInversion.hpp.

Constructor & Destructor Documentation

template<class Real>
ROL::ZOO::Objective_PoissonInversion< Real >::Objective_PoissonInversion ( uint  nz = 32,
Real  alpha = 1.e-4 
)
inline

Definition at line 101 of file ROL_PoissonInversion.hpp.

Member Function Documentation

template<class Real>
ROL::Ptr<const vector> ROL::ZOO::Objective_PoissonInversion< Real >::getVector ( const V x)
inlineprivate
template<class Real>
ROL::Ptr<vector> ROL::ZOO::Objective_PoissonInversion< Real >::getVector ( V x)
inlineprivate
template<class Real>
Real ROL::ZOO::Objective_PoissonInversion< Real >::reg_value ( const Vector< Real > &  z)
inline
template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::reg_gradient ( Vector< Real > &  g,
const Vector< Real > &  z 
)
inline
template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::reg_hessVec ( Vector< Real > &  hv,
const Vector< Real > &  v,
const Vector< Real > &  z 
)
inline
template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::apply_mass ( Vector< Real > &  Mf,
const Vector< Real > &  f 
)
inline
template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::solve_poisson ( Vector< Real > &  u,
const Vector< Real > &  z,
Vector< Real > &  b 
)
inline
template<class Real>
Real ROL::ZOO::Objective_PoissonInversion< Real >::evaluate_target ( Real  x)
inline
template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::apply_linearized_control_operator ( Vector< Real > &  Bd,
const Vector< Real > &  z,
const Vector< Real > &  d,
const Vector< Real > &  u 
)
inline
template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::apply_transposed_linearized_control_operator ( Vector< Real > &  Bd,
const Vector< Real > &  z,
const Vector< Real > &  d,
const Vector< Real > &  u 
)
inline
template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::apply_transposed_linearized_control_operator_2 ( Vector< Real > &  Bd,
const Vector< Real > &  z,
const Vector< Real > &  v,
const Vector< Real > &  d,
const Vector< Real > &  u 
)
inline
template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::solve_state_equation ( Vector< Real > &  u,
const Vector< Real > &  z 
)
inline
template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::solve_adjoint_equation ( Vector< Real > &  p,
const Vector< Real > &  u,
const Vector< Real > &  z 
)
inline
template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::solve_state_sensitivity_equation ( Vector< Real > &  w,
const Vector< Real > &  v,
const Vector< Real > &  u,
const Vector< Real > &  z 
)
inline
template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::solve_adjoint_sensitivity_equation ( Vector< Real > &  q,
const Vector< Real > &  w,
const Vector< Real > &  v,
const Vector< Real > &  p,
const Vector< Real > &  u,
const Vector< Real > &  z 
)
inline
template<class Real>
Real ROL::ZOO::Objective_PoissonInversion< Real >::value ( const Vector< Real > &  x,
Real &  tol 
)
inlinevirtual
template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::gradient ( Vector< Real > &  g,
const Vector< Real > &  x,
Real &  tol 
)
inlinevirtual

Compute gradient.

This function returns the objective function gradient.

Parameters
[out]gis the gradient.
[in]xis the current iterate.
[in]tolis a tolerance for inexact objective function computation.

The default implementation is a finite-difference approximation based on the function value. This requires the definition of a basis \(\{\phi_i\}\) for the optimization vectors x and the definition of a basis \(\{\psi_j\}\) for the dual optimization vectors (gradient vectors g). The bases must be related through the Riesz map, i.e., \( R \{\phi_i\} = \{\psi_j\}\), and this must be reflected in the implementation of the ROL::Vector::dual() method.

Reimplemented from ROL::Objective< Real >.

Definition at line 425 of file ROL_PoissonInversion.hpp.

References ROL::ZOO::Objective_PoissonInversion< Real >::apply_transposed_linearized_control_operator(), ROL::ZOO::Objective_PoissonInversion< Real >::nu_, ROL::ZOO::Objective_PoissonInversion< Real >::nz_, ROL::Vector< Real >::plus(), ROL::ZOO::Objective_PoissonInversion< Real >::reg_gradient(), ROL::ZOO::Objective_PoissonInversion< Real >::solve_adjoint_equation(), and ROL::ZOO::Objective_PoissonInversion< Real >::solve_state_equation().

template<class Real>
void ROL::ZOO::Objective_PoissonInversion< Real >::invHessVec ( Vector< Real > &  hv,
const Vector< Real > &  v,
const Vector< Real > &  x,
Real &  tol 
)
inlinevirtual

Apply inverse Hessian approximation to vector.

This function applies the inverse Hessian of the objective function to the vector \(v\).

Parameters
[out]hvis the action of the inverse Hessian on \(v\).
[in]vis the direction vector.
[in]xis the current iterate.
[in]tolis a tolerance for inexact objective function computation.

Reimplemented from ROL::Objective< Real >.

Definition at line 490 of file ROL_PoissonInversion.hpp.

References dim, and ROL::ZOO::Objective_PoissonInversion< Real >::getVector().

Member Data Documentation

template<class Real>
uint ROL::ZOO::Objective_PoissonInversion< Real >::nu_
private
template<class Real>
uint ROL::ZOO::Objective_PoissonInversion< Real >::nz_
private
template<class Real>
Real ROL::ZOO::Objective_PoissonInversion< Real >::hu_
private
template<class Real>
Real ROL::ZOO::Objective_PoissonInversion< Real >::hz_
private
template<class Real>
Real ROL::ZOO::Objective_PoissonInversion< Real >::alpha_
private
template<class Real>
Real ROL::ZOO::Objective_PoissonInversion< Real >::eps_
private
template<class Real>
int ROL::ZOO::Objective_PoissonInversion< Real >::reg_type_
private

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