Dumux::ConvergenceWriterInterface< SolutionVector, ResidualVector > Struct Template Reference

A convergence writer interface Provide an interface that show the minimal requirements a convergence write passed to a newton method has to fulfill. More...

#include <dumux/nonlinear/newtonconvergencewriter.hh>

Inheritance diagram for Dumux::ConvergenceWriterInterface< SolutionVector, ResidualVector >:

Description

template<class SolutionVector, class ResidualVector>
struct Dumux::ConvergenceWriterInterface< SolutionVector, ResidualVector >

Note

This is used together with a Newton solver, see documentation of the Newton solver for more information on how to use this class.

Public Member Functions
virtual	~ConvergenceWriterInterface ()=default
virtual void	write (const SolutionVector &uLastIter, const ResidualVector &deltaU, const ResidualVector &residual)

Constructor & Destructor Documentation

~ConvergenceWriterInterface()

template<class SolutionVector , class ResidualVector >

virtual Dumux::ConvergenceWriterInterface< SolutionVector, ResidualVector >::~ConvergenceWriterInterface ( )

virtualdefault

Member Function Documentation

write()

template<class SolutionVector , class ResidualVector >

virtual void Dumux::ConvergenceWriterInterface< SolutionVector, ResidualVector >::write ( const SolutionVector &  uLastIter, const ResidualVector &  deltaU, const ResidualVector &  residual  )

inlinevirtual

Reimplemented in Dumux::MultiDomainNewtonConvergenceWriter< MDTraits >, Dumux::NewtonConvergenceWriter< GridGeometry, SolutionVector, ResidualVector >, and Dumux::StaggeredNewtonConvergenceWriter< GridGeometry, SolutionVector, ResidualVector >.

---

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

• nonlinear/newtonconvergencewriter.hh