OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
FindRoot.hpp
Go to the documentation of this file.
1// SPDX-License-Identifier: Apache-2.0
2//
3// Copyright 2026 Caleb Buahin
4//
5// Licensed under the Apache License, Version 2.0 (the "License");
6// you may not use this file except in compliance with the License.
7// You may obtain a copy of the License at
8//
9// http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing, software
12// distributed under the License is distributed on an "AS IS" BASIS,
13// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14// See the License for the specific language governing permissions and
15// limitations under the License.
16
33
34#ifndef OPENSWMM_FIND_ROOT_HPP
35#define OPENSWMM_FIND_ROOT_HPP
36
37#include <functional>
38
39namespace openswmm {
40namespace findroot {
41
42constexpr int MAXIT = 60;
43
58using NewtonFunc = std::function<void(double x, double* f, double* df)>;
59
60int newton(double x1, double x2, double* rts, double xacc, const NewtonFunc& func);
61
71using RidderFunc = std::function<double(double x)>;
72
73double ridder(double x1, double x2, double xacc, const RidderFunc& func);
74
75} // namespace findroot
76} // namespace openswmm
77
78#endif // OPENSWMM_FIND_ROOT_HPP
Definition FindRoot.cpp:31
std::function< double(double x)> RidderFunc
Ridder's method (derivative-free).
Definition FindRoot.hpp:71
std::function< void(double x, double *f, double *df)> NewtonFunc
Newton-Raphson with bisection fallback.
Definition FindRoot.hpp:58
int newton(double x1, double x2, double *rts, double xacc, const NewtonFunc &func)
Definition FindRoot.cpp:33
constexpr int MAXIT
Maximum iterations.
Definition FindRoot.hpp:42
double ridder(double x1, double x2, double xacc, const RidderFunc &func)
Definition FindRoot.cpp:76
Definition NodeCoupling.cpp:16