ConvergenceCriterion.cpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#include "ConvergenceCriterion.h"
 
#include "BaseLib/ConfigTree.h"
#include "BaseLib/Error.h"
#include "ConvergenceCriterionDeltaX.h"
#include "ConvergenceCriterionPerComponentDeltaX.h"
#include "ConvergenceCriterionPerComponentResidual.h"
#include "ConvergenceCriterionResidual.h"
 
namespace NumLib
{
std::unique_ptr<ConvergenceCriterion> createConvergenceCriterion(
    const BaseLib::ConfigTree& config)
{
    auto const type = config.peekConfigParameter<std::string>("type");
 
    if (type == "DeltaX")
    {
        return createConvergenceCriterionDeltaX(config);
    }
    if (type == "Residual")
    {
        return createConvergenceCriterionResidual(config);
    }
    if (type == "PerComponentDeltaX")
    {
        return createConvergenceCriterionPerComponentDeltaX(config);
    }
    if (type == "PerComponentResidual")
    {
        return createConvergenceCriterionPerComponentResidual(config);
    }
 
    OGS_FATAL("There is no convergence criterion of type `{:s}'.", type);
}
 
bool checkRelativeTolerance(const double reltol, const double numerator,
                            const double denominator)
{
    auto const eps = std::numeric_limits<double>::epsilon();
    return std::abs(numerator) <
           std::abs(reltol) * (std::abs(denominator) + eps);
}
 
}  // namespace NumLib