mfem::GinkgoWrappers::ResidualLogger< ValueType > Struct Template Reference

#include <ginkgo.hpp>

Inheritance diagram for mfem::GinkgoWrappers::ResidualLogger< ValueType >:

Collaboration diagram for mfem::GinkgoWrappers::ResidualLogger< ValueType >:

Public Types
using	gko_dense = gko::matrix::Dense< ValueType >

Public Member Functions
void	write () const
void	on_iteration_complete (const gko::LinOp *, const gko::size_type &iteration, const gko::LinOp *residual, const gko::LinOp *solution, const gko::LinOp *residual_norm) const override
	ResidualLogger (std::shared_ptr< const gko::Executor > exec, const gko::LinOp *matrix, const gko_dense *b)

Detailed Description

template<typename ValueType = double>
struct mfem::GinkgoWrappers::ResidualLogger< ValueType >

Custom logger class which intercepts the residual norm scalar and solution vector in order to print a table of real vs recurrent (internal to the solvers) residual norms.

This has been taken from the custom-logger example of Ginkgo. See the custom-logger example to understand how to write and modify your own loggers with Ginkgo.

Definition at line 74 of file ginkgo.hpp.

Member Typedef Documentation

template<typename ValueType = double>

using mfem::GinkgoWrappers::ResidualLogger< ValueType >::gko_dense = gko::matrix::Dense<ValueType>

Definition at line 102 of file ginkgo.hpp.

Constructor & Destructor Documentation

template<typename ValueType = double>

mfem::GinkgoWrappers::ResidualLogger< ValueType >::ResidualLogger ( std::shared_ptr< const gko::Executor >  exec, const gko::LinOp *  matrix, const gko_dense *  b  )

inline

Definition at line 161 of file ginkgo.hpp.

Member Function Documentation

template<typename ValueType = double>

void mfem::GinkgoWrappers::ResidualLogger< ValueType >::on_iteration_complete ( const gko::LinOp *  , const gko::size_type &  iteration, const gko::LinOp *  residual, const gko::LinOp *  solution, const gko::LinOp *  residual_norm  ) const

inlineoverride

Definition at line 106 of file ginkgo.hpp.

template<typename ValueType = double>

void mfem::GinkgoWrappers::ResidualLogger< ValueType >::write ( ) const

inline

Definition at line 77 of file ginkgo.hpp.

---

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

• linalg/ginkgo.hpp