rosenbrock_formula_base.h

Go to the documentation of this file.

/*
 * Copyright 2021 MusicScience37 (Kenta Kabashima)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once
 
#include "num_collect/ode/concepts/problem.h"
#include "num_collect/ode/concepts/rosenbrock_equation_solver.h"
#include "num_collect/ode/error_tolerances.h"
#include "num_collect/ode/formula_base.h"
 
namespace num_collect::ode::rosenbrock {
 
template <typename Derived, concepts::problem Problem,
    concepts::rosenbrock_equation_solver EquationSolver>
class rosenbrock_formula_base : public formula_base<Derived, Problem> {
public:
    using base_type = formula_base<Derived, Problem>;
 
    using typename base_type::problem_type;
    using typename base_type::scalar_type;
    using typename base_type::variable_type;
 
    using equation_solver_type = EquationSolver;
 
protected:
    using base_type::coeff;
    using base_type::derived;
 
public:
    rosenbrock_formula_base(
        const problem_type& problem, const scalar_type& inverted_jacobian_coeff)
        : base_type(problem), solver_(inverted_jacobian_coeff) {}
 
    auto tolerances(const error_tolerances<variable_type>& val) -> Derived& {
        if constexpr (requires(equation_solver_type& solver,
                          const error_tolerances<variable_type>& val) {
                          solver.tolerances(val);
                      }) {
            solver_.tolerances(val);
        }
        return derived();
    }
 
    [[nodiscard]] auto equation_solver() const -> const equation_solver_type& {
        return solver_;
    }
 
    [[nodiscard]] auto equation_solver() -> equation_solver_type& {
        return solver_;
    }
 
private:
    equation_solver_type solver_;
};
 
}  // namespace num_collect::ode::rosenbrock