diff --git a/dumux/multidomain/newtonconvergencewriter.hh b/dumux/multidomain/newtonconvergencewriter.hh index 8d1b483291887a511f38dda77869523f16d4860f..00d13ce8a9c5774525ab486fde9c05c3457e80af 100644 --- a/dumux/multidomain/newtonconvergencewriter.hh +++ b/dumux/multidomain/newtonconvergencewriter.hh @@ -25,10 +25,8 @@ namespace Dumux { * \ingroup MultiDomain * \ingroup Nonlinear * \brief Writes the intermediate solutions for every Newton iteration - * \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. + * \note This is used together with a Newton solver, see documentation of the Newton solver for + * more information on how to use this class. */ template <class MDTraits> class MultiDomainNewtonConvergenceWriter : public ConvergenceWriterInterface<typename MDTraits::SolutionVector,typename MDTraits::ResidualVector> diff --git a/dumux/nonlinear/newtonconvergencewriter.hh b/dumux/nonlinear/newtonconvergencewriter.hh index 53788c5292b71750c0116aae60a673f30029b58f..662f2394eef9cf339ff4cbd54ddd0f63ef0b2a94 100644 --- a/dumux/nonlinear/newtonconvergencewriter.hh +++ b/dumux/nonlinear/newtonconvergencewriter.hh @@ -20,8 +20,13 @@ namespace Dumux { -//! provide an interface as a form of type erasure -//! this is the minimal requirements a convergence write passed to a newton method has to fulfill +/*! + * \ingroup Nonlinear + * \brief A convergence writer interface + * Provide an interface that show the minimal requirements a convergence write passed to a newton method has to fulfill + * \note This is used together with a Newton solver, see documentation of the Newton solver for + * more information on how to use this class. + */ template <class SolutionVector, class ResidualVector> struct ConvergenceWriterInterface { @@ -33,10 +38,8 @@ struct ConvergenceWriterInterface /*! * \ingroup Nonlinear * \brief Writes the intermediate solutions for every Newton iteration - * \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. + * \note This is used together with a Newton solver, see documentation of the Newton solver for + * more information on how to use this class. */ template <class GridGeometry, class SolutionVector, class ResidualVector> class NewtonConvergenceWriter : public ConvergenceWriterInterface<SolutionVector, ResidualVector> diff --git a/dumux/nonlinear/staggerednewtonconvergencewriter.hh b/dumux/nonlinear/staggerednewtonconvergencewriter.hh index b46aee65393bb9e8c468d1fdfa1113134c24e91a..d9b31f324b590f22a5333d518f7c92a8294f3687 100644 --- a/dumux/nonlinear/staggerednewtonconvergencewriter.hh +++ b/dumux/nonlinear/staggerednewtonconvergencewriter.hh @@ -26,10 +26,8 @@ namespace Dumux { /*! * \ingroup Nonlinear * \brief Writes the intermediate solutions for every Newton iteration (for staggered grid scheme) - * \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. + * \note This is used together with a Newton solver, see documentation of the Newton solver for + * more information on how to use this class. */ template <class GridGeometry, class SolutionVector, class ResidualVector> class StaggeredNewtonConvergenceWriter : public ConvergenceWriterInterface<SolutionVector, ResidualVector>