version 3.8
Dumux::NewtonConvergenceWriter< GridGeometry, SolutionVector, ResidualVector > Class Template Reference

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

#include <dumux/nonlinear/newtonconvergencewriter.hh>

Inheritance diagram for Dumux::NewtonConvergenceWriter< GridGeometry, SolutionVector, ResidualVector >:

Description

template<class GridGeometry, class SolutionVector, class ResidualVector>
class Dumux::NewtonConvergenceWriter< GridGeometry, SolutionVector, ResidualVector >
Note
To use this create a shared_ptr to an instance of this class in the main file and pass it to newton.solve(x, convergencewriter). You can use the reset method to write out multiple Newton solves with a unique id, if you don't call use all Newton iterations just come after each other in the pvd file.

Public Member Functions

 NewtonConvergenceWriter (const GridGeometry &gridGeometry, 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

◆ NewtonConvergenceWriter()

template<class GridGeometry , class SolutionVector , class ResidualVector >
Dumux::NewtonConvergenceWriter< GridGeometry, SolutionVector, ResidualVector >::NewtonConvergenceWriter ( const GridGeometry &  gridGeometry,
const std::string &  name = "newton_convergence" 
)
inline
Parameters
gridGeometryThe finite-volume grid geometry
nameBase name of the vtk output

Member Function Documentation

◆ reset()

template<class GridGeometry , class SolutionVector , class ResidualVector >
void Dumux::NewtonConvergenceWriter< GridGeometry, SolutionVector, ResidualVector >::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 GridGeometry , class SolutionVector , class ResidualVector >
void Dumux::NewtonConvergenceWriter< GridGeometry, SolutionVector, ResidualVector >::resize ( )
inline

◆ write()

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

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