Ewoms::NullConvergenceWriter< TypeTag > Class Template Reference

A convergence writer for the Newton method which does nothing. More...

#include <nullconvergencewriter.hh>

Public Member Functions

 NullConvergenceWriter (NewtonMethod &method)
 
void beginTimeStep ()
 Called by the Newton method before the actual algorithm is started for any given timestep. More...
 
void beginIteration ()
 Called by the Newton method before an iteration of the Newton algorithm is started. More...
 
void writeFields (const SolutionVector &uLastIter, const GlobalEqVector &deltaU)
 Write the Newton update to disk. More...
 
void endIteration ()
 Called by the Newton method after an iteration of the Newton algorithm has been completed. More...
 
void endTimeStep ()
 Called by the Newton method after Newton algorithm has been completed for any given timestep. More...
 

Detailed Description

template<class TypeTag>
class Ewoms::NullConvergenceWriter< TypeTag >

A convergence writer for the Newton method which does nothing.

Constructor & Destructor Documentation

template<class TypeTag >
Ewoms::NullConvergenceWriter< TypeTag >::NullConvergenceWriter ( NewtonMethod method)
inline

Member Function Documentation

template<class TypeTag >
void Ewoms::NullConvergenceWriter< TypeTag >::beginIteration ( )
inline

Called by the Newton method before an iteration of the Newton algorithm is started.

template<class TypeTag >
void Ewoms::NullConvergenceWriter< TypeTag >::beginTimeStep ( )
inline

Called by the Newton method before the actual algorithm is started for any given timestep.

template<class TypeTag >
void Ewoms::NullConvergenceWriter< TypeTag >::endIteration ( )
inline

Called by the Newton method after an iteration of the Newton algorithm has been completed.

template<class TypeTag >
void Ewoms::NullConvergenceWriter< TypeTag >::endTimeStep ( )
inline

Called by the Newton method after Newton algorithm has been completed for any given timestep.

This method is called regardless of whether the Newton method converged or not.

template<class TypeTag >
void Ewoms::NullConvergenceWriter< TypeTag >::writeFields ( const SolutionVector &  uLastIter,
const GlobalEqVector &  deltaU 
)
inline

Write the Newton update to disk.

Called after the linear solution is found for an iteration.

Parameters
uLastIterThe solution vector of the previous iteration.
deltaUThe negative difference between the solution vectors of the previous and the current iteration.

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