Detailed Description

Definition at line 19 of file DiameterProfile.h.

#include <DiameterProfile.h>

Public Member Functions
	DiameterProfile (std::vector< double > bounds, std::vector< double > diams)
int	getSectionIndex (double distance_from_wellhead) const
	Find the section index for a given distance from wellhead. Uses binary search for O(log n) lookup.
double	diameterAtDistance (double distance_from_wellhead) const
	Get diameter at a given distance from wellhead.
double	areaAtDistance (double distance_from_wellhead) const
	Get cross-sectional area at a given distance from wellhead.
double	diameterAtSection (int const section_index) const
	Get diameter for a specific section.
double	areaAtSection (int const section_index) const
	Get cross-sectional area for a specific section.
int	getNumberOfSections () const
	Get the number of sections.

Public Attributes
std::vector< double > const	section_boundaries
std::vector< double > const	section_diameters

Static Private Member Functions
static double	circleArea (double const diameter)

Constructor & Destructor Documentation

◆ DiameterProfile()

ProcessLib::HeatTransportBHE::BHE::DiameterProfile::DiameterProfile	(	std::vector< double >	bounds,
		std::vector< double >	diams )

inline

Definition at line 21 of file DiameterProfile.h.

        : section_boundaries(std::move(bounds)),
          section_diameters(std::move(diams))
    {
        if (section_boundaries.empty() || section_diameters.empty())
        {
            OGS_FATAL("DiameterProfile: vectors must be non-empty.");
        }
        if (section_boundaries.size() != section_diameters.size())
        {
            OGS_FATAL(
                "DiameterProfile: section_boundaries (size {:d}) and "
                "section_diameters (size {:d}) must have the same size.",
                section_boundaries.size(), section_diameters.size());
        }
        if (std::any_of(section_diameters.begin(), section_diameters.end(),
                        [](double d) { return d <= 0.0; }))
        {
            OGS_FATAL("DiameterProfile: all diameters must be positive.");
        }
        if (std::adjacent_find(section_boundaries.begin(),
                               section_boundaries.end(),
                               std::greater_equal<>{}) !=
            section_boundaries.end())
        {
            OGS_FATAL(
                "DiameterProfile: section_boundaries must be strictly "
                "increasing.");
        }
    }

References section_boundaries, and section_diameters.

Member Function Documentation

◆ areaAtDistance()

double ProcessLib::HeatTransportBHE::BHE::DiameterProfile::areaAtDistance ( double distance_from_wellhead ) const

inline

Get cross-sectional area at a given distance from wellhead.

Parameters

distance_from_wellhead Distance from wellhead [m].

Returns: Cross-sectional area [m^2] for the corresponding section.

Definition at line 80 of file DiameterProfile.h.

    {
        return circleArea(diameterAtDistance(distance_from_wellhead));
    }

References circleArea(), and diameterAtDistance().

◆ areaAtSection()

double ProcessLib::HeatTransportBHE::BHE::DiameterProfile::areaAtSection ( int const section_index ) const

inline

Get cross-sectional area for a specific section.

Parameters

section_index Section index (0-based).

Returns: Cross-sectional area [m²].

Definition at line 101 of file DiameterProfile.h.

    {
        return circleArea(diameterAtSection(section_index));
    }

References circleArea(), and diameterAtSection().

◆ circleArea()

double ProcessLib::HeatTransportBHE::BHE::DiameterProfile::circleArea ( double const diameter )

inlinestaticprivate

Definition at line 114 of file DiameterProfile.h.

    {
        return std::numbers::pi * diameter * diameter / 4;
    }

Referenced by areaAtDistance(), and areaAtSection().

◆ diameterAtDistance()

double ProcessLib::HeatTransportBHE::BHE::DiameterProfile::diameterAtDistance ( double distance_from_wellhead ) const

inline

Get diameter at a given distance from wellhead.

Parameters

distance_from_wellhead Distance from wellhead [m].

Returns: Diameter [m] for the corresponding section.

Definition at line 72 of file DiameterProfile.h.

    {
        return section_diameters[getSectionIndex(distance_from_wellhead)];
    }

References getSectionIndex(), and section_diameters.

Referenced by areaAtDistance().

◆ diameterAtSection()

double ProcessLib::HeatTransportBHE::BHE::DiameterProfile::diameterAtSection ( int const section_index ) const

inline

Get diameter for a specific section.

Parameters

section_index Section index (0-based).

Returns: Diameter [m].

Definition at line 88 of file DiameterProfile.h.

    {
        if (section_index < 0 ||
            section_index >= static_cast<int>(section_diameters.size()))
        {
            OGS_FATAL("Invalid section index: {:d}", section_index);
        }
        return section_diameters[section_index];
    }

References OGS_FATAL, and section_diameters.

Referenced by areaAtSection().

◆ getNumberOfSections()

int ProcessLib::HeatTransportBHE::BHE::DiameterProfile::getNumberOfSections ( ) const

inline

Get the number of sections.

Returns: Number of sections.

Definition at line 108 of file DiameterProfile.h.

    {
        return static_cast<int>(section_diameters.size());
    }

References section_diameters.

◆ getSectionIndex()

int ProcessLib::HeatTransportBHE::BHE::DiameterProfile::getSectionIndex ( double distance_from_wellhead ) const

inline

Find the section index for a given distance from wellhead. Uses binary search for O(log n) lookup.

Parameters

distance_from_wellhead Distance from wellhead [m].

Returns: Section index (0-based). Returns last section if distance exceeds last boundary.

Definition at line 120 of file DiameterProfile.h.

{
    if (distance_from_wellhead < section_boundaries.front())
    {
        OGS_FATAL(
            "Distance from wellhead is negative or before first section: "
            "{:g}",
            distance_from_wellhead);
    }
 
    // Binary search to find the section.
    // Find the first boundary that is greater than distance_from_wellhead.
    auto it = std::upper_bound(section_boundaries.begin(),
                               section_boundaries.end(),
                               distance_from_wellhead);
 
    // Move back one position to get the section containing this distance.
    if (it != section_boundaries.begin())
    {
        --it;
    }
 
    return static_cast<int>(std::distance(section_boundaries.begin(), it));
}