CreateForwardDifferencesJacobianAssembler.cpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#include "CreateForwardDifferencesJacobianAssembler.h"
 
#include "BaseLib/ConfigTree.h"
#include "BaseLib/Error.h"
#include "ForwardDifferencesJacobianAssembler.h"
 
namespace ProcessLib
{
std::unique_ptr<AbstractJacobianAssembler>
createForwardDifferencesJacobianAssembler(BaseLib::ConfigTree const& config)
{
    config.checkConfigParameter("type", "ForwardDifferences");
 
    // TODO: to be removed
    {
        std::vector<std::string> const deprecated_keys{"relative_epsilons",
                                                       "component_magnitudes"};
        for (auto const& key : deprecated_keys)
        {
            auto const deprecated_parameter =
                config.getConfigParameterOptional<std::vector<double>>(key);
 
            if ((deprecated_parameter.has_value() &&
                 !deprecated_parameter->empty()))
            {
                OGS_FATAL(
                    "Configuration parameter <{:s}> is deprecated and no "
                    "longer supported.\n"
                    "(Removed in OGS version 6.5.6)\n\n"
                    "The numerical Jacobian assembler now uses absolute "
                    "perturbation values instead of relative scaling.\n\n"
                    "Migration required:\n"
                    "  Old approach:\n"
                    "    <relative_epsilons>1e-6 1e-6</relative_epsilons>\n"
                    "    <component_magnitudes>1e2 1e2</component_magnitudes>\n"
                    "  New approach:\n"
                    "    <epsilons>1e-4 1e-4</epsilons>\n"
                    " where the epsilons are equal component-wise to "
                    "relative_epsilons * component_magnitudes",
                    key);
            }
        }
    }

    auto epsilons = config.getConfigParameter<std::vector<double>>("epsilons");
 
    return std::make_unique<ForwardDifferencesJacobianAssembler>(
        std::move(epsilons));
}
 
}  // namespace ProcessLib