doxygen/html/CD__PolyUtils_8H_source.html

/*

 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research

 *

 * SPDX-License-Identifier: GPL-3.0-or-later

 */


#ifndef CD_POLYUTILS_H

#define CD_POLYUTILS_H


// Chombo includes

#include <RefCountedPtr.H>

#include <BaseIF.H>


// Our includes

#include <CD_NamespaceHeader.H>


namespace PolyUtils {


RealVect

brentRootFinder(const RefCountedPtr<BaseIF>& a_impFunc, const RealVect& a_point1, const RealVect& a_point2);


Real

brentSolve(const Real a_point1, const Real a_point2, const std::function<Real(const Real x)>& a_func) noexcept;

} // namespace PolyUtils


#include <CD_NamespaceFooter.H>


#endif

PolyUtils
Agglomeration class for various useful polynomial routines.
Definition CD_PolyUtils.H:26

PolyUtils::brentSolve
Real brentSolve(const Real a_point1, const Real a_point2, const std::function< Real(const Real x)> &a_func) noexcept
Compute the root of a function between two points. This is a 1D problem.
Definition CD_PolyUtils.cpp:169

PolyUtils::brentRootFinder
RealVect brentRootFinder(const RefCountedPtr< BaseIF > &a_impFunc, const RealVect &a_point1, const RealVect &a_point2)
Compute the root of a function between two points. This is a 1D problem along the line.
Definition CD_PolyUtils.cpp:25