version 3.10-dev
Dumux::MultiDomainNewtonConvergenceWriter< MDTraits > Class Template Reference

Writes the intermediate solutions for every Newton iteration. More...

#include <dumux/multidomain/newtonconvergencewriter.hh>

Inheritance diagram for Dumux::MultiDomainNewtonConvergenceWriter< MDTraits >:

Description

template<class MDTraits>
class Dumux::MultiDomainNewtonConvergenceWriter< MDTraits >
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

 MultiDomainNewtonConvergenceWriter (GridGeometryPtrTuple gridGeometryPtrTuple, const std::string &name="newton_convergence")
 Constructor. More...
 
void resize ()
 Resizes the output fields. This has to be called whenever the grid changes. More...
 
void reset (std::size_t newId=0UL)
 
void write (const SolutionVector &uLastIter, const ResidualVector &deltaU, const ResidualVector &residual) override
 

Constructor & Destructor Documentation

◆ MultiDomainNewtonConvergenceWriter()

template<class MDTraits >
Dumux::MultiDomainNewtonConvergenceWriter< MDTraits >::MultiDomainNewtonConvergenceWriter ( GridGeometryPtrTuple  gridGeometryPtrTuple,
const std::string &  name = "newton_convergence" 
)
inline
Parameters
gridGeometryPtrTupleA tuple of shared pointers to const grid geometries
nameBase name of the vtk output

Member Function Documentation

◆ reset()

template<class MDTraits >
void Dumux::MultiDomainNewtonConvergenceWriter< MDTraits >::reset ( std::size_t  newId = 0UL)
inline

Reset the convergence writer for a possible next Newton step You may set a different id in case you don't want the output to be overwritten by the next step

◆ resize()

template<class MDTraits >
void Dumux::MultiDomainNewtonConvergenceWriter< MDTraits >::resize ( )
inline

◆ write()

template<class MDTraits >
void Dumux::MultiDomainNewtonConvergenceWriter< MDTraits >::write ( const SolutionVector &  uLastIter,
const ResidualVector &  deltaU,
const ResidualVector &  residual 
)
inlineoverridevirtual

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