ConvergenceCriterion.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <memory>
 
#include "MathLib/LinAlg/LinAlg.h"  // For MathLib::VecNormType
#include "NumLib/NumericsConfig.h"
 
namespace BaseLib
{
class ConfigTree;
}  // namespace BaseLib
 
namespace NumLib
{
class ConvergenceCriterion
{
public:
    explicit ConvergenceCriterion(const MathLib::VecNormType norm_type)
        : _norm_type(norm_type)
    {
    }

    virtual bool hasDeltaXCheck() const = 0;

    virtual bool hasResidualCheck() const = 0;
 
    virtual bool hasNonNegativeDamping() const = 0;

    virtual void checkDeltaX(GlobalVector const& minus_delta_x,
                             GlobalVector const& x) = 0;

    virtual void checkResidual(GlobalVector const& residual) = 0;
 
    virtual double getDampingFactor(GlobalVector const& minus_delta_x,
                                    GlobalVector const& x,
                                    double damping_orig) = 0;

    virtual void preFirstIteration() { _is_first_iteration = true; }

    virtual void setNoFirstIteration() { _is_first_iteration = false; }

    virtual void reset()
    {
        _satisfied = true;
        _is_first_iteration = false;
    };

    virtual bool isSatisfied() const { return _satisfied; };
 
    MathLib::VecNormType getVectorNormType() const { return _norm_type; }
 
    virtual ~ConvergenceCriterion() = default;
 
protected:
    bool _satisfied = true;
    bool _is_first_iteration = true;
    const MathLib::VecNormType _norm_type;
};

std::unique_ptr<ConvergenceCriterion> createConvergenceCriterion(
    BaseLib::ConfigTree const& config);

bool checkRelativeTolerance(double const reltol,
                            double const numerator,
                            double const denominator);
 
}  // namespace NumLib