ConvergenceCriterionResidual.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 <optional>
 
#include "ConvergenceCriterion.h"
#include "MathLib/LinAlg/LinAlgEnums.h"
 
namespace NumLib
{
class ConvergenceCriterionResidual final : public ConvergenceCriterion
{
public:
    ConvergenceCriterionResidual(std::optional<double>&& absolute_tolerance,
                                 std::optional<double>&& relative_tolerance,
                                 const MathLib::VecNormType norm_type);
 
    bool hasDeltaXCheck() const override { return true; }
    bool hasResidualCheck() const override { return true; }
    bool hasNonNegativeDamping() const override { return false; }

    void checkDeltaX(const GlobalVector& minus_delta_x,
                     GlobalVector const& x) override;
    void checkResidual(const GlobalVector& residual) override;
    double getDampingFactor(GlobalVector const& /*minus_delta_x*/,
                            GlobalVector const& /*x*/,
                            double damping_scalar) override
    {
        return damping_scalar;
    }
 
private:
    const std::optional<double> _abstol;
    const std::optional<double> _reltol;
    double _residual_norm_0;
};
 
std::unique_ptr<ConvergenceCriterionResidual>
createConvergenceCriterionResidual(BaseLib::ConfigTree const& config);
 
}  // namespace NumLib