implicit_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/logging/logger.h"
#include "num_collect/ode/concepts/ode_equation_solver.h"
#include "num_collect/ode/concepts/problem.h"
#include "num_collect/ode/error_tolerances.h"
#include "num_collect/ode/formula_base.h"
 
namespace num_collect::ode::runge_kutta {
 
template <typename Derived, concepts::problem Problem,
    concepts::ode_equation_solver FormulaSolver>
class implicit_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 formula_solver_type = FormulaSolver;
 
protected:
    using base_type::derived;
 
public:
    explicit implicit_formula_base(const problem_type& problem = problem_type())
        : base_type(problem), formula_solver_() {}
 
    [[nodiscard]] auto formula_solver() -> formula_solver_type& {
        return formula_solver_;
    }
 
    [[nodiscard]] auto formula_solver() const -> const formula_solver_type& {
        return formula_solver_;
    }
 
    auto tolerances(const error_tolerances<variable_type>& val) -> Derived& {
        formula_solver_.tolerances(val);
        return derived();
    }
 
    [[nodiscard]] auto logger() const noexcept
        -> const num_collect::logging::logger& {
        return formula_solver_.logger();
    }
 
    [[nodiscard]] auto logger() noexcept -> num_collect::logging::logger& {
        return formula_solver_.logger();
    }
 
private:
    formula_solver_type formula_solver_;
};
 
}  // namespace num_collect::ode::runge_kutta