Opm::NullConvergenceWriter< TypeTag > Class Template Reference

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

#include <nullconvergencewriter.hh>

Public Member Functions
	NullConvergenceWriter (NewtonMethod &)
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 &, const GlobalEqVector &)
	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 Opm::NullConvergenceWriter< TypeTag >

A convergence writer for the Newton method which does nothing.

Constructor & Destructor Documentation

NullConvergenceWriter()

template<class TypeTag >

Opm::NullConvergenceWriter< TypeTag >::NullConvergenceWriter ( NewtonMethod &  )

inline

Member Function Documentation

beginIteration()

template<class TypeTag >

void Opm::NullConvergenceWriter< TypeTag >::beginIteration ( )

inline

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

beginTimeStep()

template<class TypeTag >

void Opm::NullConvergenceWriter< TypeTag >::beginTimeStep ( )

inline

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

endIteration()

template<class TypeTag >

void Opm::NullConvergenceWriter< TypeTag >::endIteration ( )

inline

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

endTimeStep()

template<class TypeTag >

void Opm::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.

writeFields()

template<class TypeTag >

void Opm::NullConvergenceWriter< TypeTag >::writeFields ( const SolutionVector &  , const GlobalEqVector &    )

inline

Write the Newton update to disk.

Called after the linear solution is found for an iteration.

Parameters

uLastIter	The solution vector of the previous iteration.
deltaU	The negative difference between the solution vectors of the previous and the current iteration.

---

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

• nullconvergencewriter.hh