LoggingSolverObserver.H

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Saud Zahir
 *
 * This file is part of deltaFlow.
 *
 * deltaFlow is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * deltaFlow is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with deltaFlow.  If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#ifndef LOGGING_SOLVER_OBSERVER_H
#define LOGGING_SOLVER_OBSERVER_H
 
#include "ISolver.H"
#include "Logger.H"
#include "Progress.H"
 
class LoggingSolverObserver final : public ISolverObserver {
    public:
        void onIteration(const char* solverName, int iter, int maxIter, double error, double tolerance) override {
            printIterationProgress(solverName, iter, maxIter, error, tolerance);
            LOG_DEBUG("{} iteration {}: error = {:.16e}", solverName, iter, error);
        }
 
        void onFinished(const char* solverName, bool converged, int iter, int maxIter, double error, double tolerance) override {
            printConvergenceStatus(solverName, converged, iter, maxIter, error, tolerance);
            if (converged) {
                LOG_DEBUG("{} converged in {} iterations with error {:.6e}.", solverName, iter, error);
            } else {
                LOG_WARN("{} did not converge within {} iterations.", solverName, maxIter);
                LOG_DEBUG("Final error was {:.6e}, tolerance is {:.6e}.", error, tolerance);
            }
        }
 
        void onMessage(const char* solverName, const char* message) override {
            (void)solverName;
            LOG_DEBUG("{}", message);
        }
};
 
#endif