MathLib::CubicSolver Class Reference

Detailed Description

Definition at line 25 of file CubicRoots.h.

#include <CubicRoots.h>

Public Member Functions
	CubicSolver (const double a, const double b, const double c, const double d)
std::vector< double >	solve ()
double	smallestPositiveRealRoot ()

Private Attributes
double	a_
double	b_
double	c_
double	d_

Constructor & Destructor Documentation

CubicSolver()

MathLib::CubicSolver::CubicSolver ( const double a, const double b, const double c, const double d )

inline

Definition at line 28 of file CubicRoots.h.

        : a_(a), b_(b), c_(c), d_(d)
    {
        if (std::abs(a_) < 1e-9)
        {
            OGS_FATAL("'a' must be non-zero for a cubic equation.");
        }
    }

References a_, and OGS_FATAL.

Member Function Documentation

smallestPositiveRealRoot()

double MathLib::CubicSolver::smallestPositiveRealRoot ( )

inline

Definition at line 55 of file CubicRoots.h.

    {
        std::vector<double> const roots = solve();
 
        auto positive_roots =
            roots | ranges::views::filter([](double root) { return root > 0; });
 
        // If no positive root exists, return NaN
        if (ranges::empty(positive_roots))
        {
            return std::numeric_limits<double>::quiet_NaN();
        }
 
        return ranges::min(positive_roots);
    }

References solve().

Referenced by MaterialPropertyLib::PengRobinson::value().

solve()

std::vector< double > MathLib::CubicSolver::solve ( )

inline

Definition at line 38 of file CubicRoots.h.

    {
        // Solve using Boost's cubic_roots
        std::array<double, 3> const roots =
            boost::math::tools::cubic_roots<double>(a_, b_, c_, d_);
 
        std::vector<double> filtered_roots =
            ranges::views::ref(roots) |
            ranges::views::filter([](double const root)
                                  { return !std::isnan(root); }) |
            ranges::to<std::vector>();
        ranges::sort(filtered_roots);
 
        return filtered_roots;
    }

References a_, b_, c_, and d_.

Referenced by smallestPositiveRealRoot().

Member Data Documentation

a_

double MathLib::CubicSolver::a_

private

Definition at line 72 of file CubicRoots.h.

Referenced by CubicSolver(), and solve().

b_

double MathLib::CubicSolver::b_

private

Definition at line 72 of file CubicRoots.h.

Referenced by solve().

c_

double MathLib::CubicSolver::c_

private

Definition at line 72 of file CubicRoots.h.

Referenced by solve().

d_

double MathLib::CubicSolver::d_

private

Definition at line 72 of file CubicRoots.h.

Referenced by solve().

---

The documentation for this class was generated from the following file:

• MathLib/Nonlinear/CubicRoots.h