PISM, A Parallel Ice Sheet Model  stable v2.1-1-g6902d5502 committed by Ed Bueler on 2023-12-20 08:38:27 -0800
Public Types | Public Member Functions | List of all members
pism::inverse::IPTaoTikhonovProblemListener< ForwardProblem > Class Template Referenceabstract

Iteration callback class for IPTaoTikhonovProblem. More...

#include <IPTaoTikhonovProblem.hh>

Public Types

typedef std::shared_ptr< IPTaoTikhonovProblemListenerPtr
 
typedef std::shared_ptr< typename ForwardProblem::DesignVec > DesignVecPtr
 
typedef std::shared_ptr< typename ForwardProblem::StateVec > StateVecPtr
 
typedef std::shared_ptr< typename ForwardProblem::StateVec1 > StateVec1Ptr
 

Public Member Functions

 IPTaoTikhonovProblemListener ()
 
virtual ~IPTaoTikhonovProblemListener ()
 
virtual void iteration (IPTaoTikhonovProblem< ForwardProblem > &problem, double eta, int iter, double objectiveValue, double designValue, const DesignVecPtr d, const DesignVecPtr diff_d, const DesignVecPtr grad_d, const StateVecPtr u, const StateVecPtr diff_u, const DesignVecPtr grad_u, const DesignVecPtr gradient)=0
 The method called after each minimization iteration. More...
 

Detailed Description

template<class ForwardProblem>
class pism::inverse::IPTaoTikhonovProblemListener< ForwardProblem >

Iteration callback class for IPTaoTikhonovProblem.

A class for objects receiving iteration callbacks from a IPTaoTikhonovProblem. These callbacks can be used to monitor the solution, plot iterations, print diagnostic messages, etc. IPTaoTikhonovProblemListeners are ususally used via a reference counted pointer IPTaoTikhonovProblemListener::Ptr to allow for good memory management when Listeners are created as subclasses of python classes. It would have been better to nest this inside of IPTaoTikhonovProblem, but SWIG has a hard time with nested classes, so it's outer instead.

Definition at line 55 of file IPTaoTikhonovProblem.hh.


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