Detailed Description

Definition at line 55 of file BHECommon.h.

#include <BHECommon.h>

Inheritance diagram for ProcessLib::HeatTransportBHE::BHE::BHECommon:

Collaboration diagram for ProcessLib::HeatTransportBHE::BHE::BHECommon:

Public Member Functions
	BHECommon (BoreholeGeometry const &borehole_geometry_, RefrigerantProperties const &refrigerant_, GroutParameters const &grout_, FlowAndTemperatureControl const &flowAndTemperatureControl_, bool const use_python_bcs_)
constexpr bool	isPowerBC () const
int	getNumberOfSections () const
	Get number of sections in the borehole geometry.
std::vector< double > const &	getSectionBoundaries () const
	Get section boundaries (cumulative distance from wellhead).
double	thermalResistanceAtSection (int const unknown_index, int const section_index) const
	Get thermal resistance for a specific section and unknown.

Public Attributes
BoreholeGeometry const	borehole_geometry
RefrigerantProperties const	refrigerant
GroutParameters const	grout
FlowAndTemperatureControl const	flowAndTemperatureControl
bool const	use_python_bcs

Protected Member Functions
template<typename Fn>
void	recomputeSectionalResistances (Fn &&calcForSection)
	Recompute _sectional_thermal_resistances for all sections.
double	getClampedFlowVelocity (int const section_index) const
	Get velocity for a section, clamping to last section if index exceeds the number of velocity entries. Returns 0 when empty.
std::vector< double > const &	getThermalResistancesAtSection (int const section_index) const
	Get the thermal resistance vector for a given section.

Protected Attributes
std::vector< double >	_flow_velocities
std::vector< std::vector< double > >	_sectional_thermal_resistances

Constructor & Destructor Documentation

◆ BHECommon()

ProcessLib::HeatTransportBHE::BHE::BHECommon::BHECommon	(	BoreholeGeometry const &	borehole_geometry_,
		RefrigerantProperties const &	refrigerant_,
		GroutParameters const &	grout_,
		FlowAndTemperatureControl const &	flowAndTemperatureControl_,
		bool const	use_python_bcs_ )

inline

Definition at line 58 of file BHECommon.h.

        : borehole_geometry(borehole_geometry_),
          refrigerant(refrigerant_),
          grout(grout_),
          flowAndTemperatureControl(flowAndTemperatureControl_),
          use_python_bcs(use_python_bcs_)
    {
    }

References borehole_geometry, flowAndTemperatureControl, grout, refrigerant, and use_python_bcs.

Referenced by ProcessLib::HeatTransportBHE::BHE::BHE_1P::BHE_1P(), ProcessLib::HeatTransportBHE::BHE::BHECommonCoaxial::BHECommonCoaxial(), and ProcessLib::HeatTransportBHE::BHE::BHECommonUType::BHECommonUType().

Member Function Documentation

◆ getClampedFlowVelocity()

double ProcessLib::HeatTransportBHE::BHE::BHECommon::getClampedFlowVelocity ( int const section_index ) const

inlineprotected

Get velocity for a section, clamping to last section if index exceeds the number of velocity entries. Returns 0 when empty.

Definition at line 133 of file BHECommon.h.

    {
        return _flow_velocities.empty()
                   ? 0.0
                   : _flow_velocities[std::min(
                         section_index,
                         static_cast<int>(_flow_velocities.size()) - 1)];
    }

References _flow_velocities.

Referenced by ProcessLib::HeatTransportBHE::BHE::BHE_1P::pipeAdvectionVectors(), ProcessLib::HeatTransportBHE::BHE::BHE_1U::pipeAdvectionVectors(), ProcessLib::HeatTransportBHE::BHE::BHE_2U::pipeAdvectionVectors(), ProcessLib::HeatTransportBHE::BHE::BHE_1P::pipeHeatConductions(), ProcessLib::HeatTransportBHE::BHE::BHE_1U::pipeHeatConductions(), and ProcessLib::HeatTransportBHE::BHE::BHE_2U::pipeHeatConductions().

◆ getNumberOfSections()

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

inline

Get number of sections in the borehole geometry.

Definition at line 83 of file BHECommon.h.

    {
        return borehole_geometry.sections.getNumberOfSections();
    }

References borehole_geometry.

Referenced by recomputeSectionalResistances().

◆ getSectionBoundaries()

std::vector< double > const & ProcessLib::HeatTransportBHE::BHE::BHECommon::getSectionBoundaries ( ) const

inline

Get section boundaries (cumulative distance from wellhead).

Definition at line 89 of file BHECommon.h.

    {
        return borehole_geometry.sections.section_boundaries;
    }

References borehole_geometry.

◆ getThermalResistancesAtSection()

std::vector< double > const & ProcessLib::HeatTransportBHE::BHE::BHECommon::getThermalResistancesAtSection ( int const section_index ) const

inlineprotected

Get the thermal resistance vector for a given section.

Definition at line 147 of file BHECommon.h.

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

References _sectional_thermal_resistances, and OGS_FATAL.

Referenced by thermalResistanceAtSection().

◆ isPowerBC()

bool ProcessLib::HeatTransportBHE::BHE::BHECommon::isPowerBC ( ) const

inlineconstexpr

Definition at line 76 of file BHECommon.h.

    {
        return std::visit([](auto const& ftc) { return ftc.is_power_bc; },
                          flowAndTemperatureControl);
    }

References flowAndTemperatureControl.

◆ recomputeSectionalResistances()

template<typename Fn>

void ProcessLib::HeatTransportBHE::BHE::BHECommon::recomputeSectionalResistances ( Fn && calcForSection )

inlineprotected

Recompute _sectional_thermal_resistances for all sections.

Parameters

calcForSection Callable (int section_index) -> std::vector<double> that returns the resistance vector for that section.

Definition at line 117 of file BHECommon.h.

    {
        int const n = getNumberOfSections();
        _sectional_thermal_resistances.clear();
        _sectional_thermal_resistances.reserve(n);
        for (int i = 0; i < n; ++i)
        {
            _sectional_thermal_resistances.push_back(calcForSection(i));
        }
    }

References _sectional_thermal_resistances, and getNumberOfSections().

Referenced by ProcessLib::HeatTransportBHE::BHE::BHE_1P::updateHeatTransferCoefficients(), ProcessLib::HeatTransportBHE::BHE::BHE_1U::updateHeatTransferCoefficients(), ProcessLib::HeatTransportBHE::BHE::BHE_2U::updateHeatTransferCoefficients(), and ProcessLib::HeatTransportBHE::BHE::BHECommonCoaxial::updateHeatTransferCoefficients().

◆ thermalResistanceAtSection()

double ProcessLib::HeatTransportBHE::BHE::BHECommon::thermalResistanceAtSection	(	int const	unknown_index,
		int const	section_index ) const

inline

Get thermal resistance for a specific section and unknown.

Definition at line 95 of file BHECommon.h.

    {
        auto const& thermal_resistances =
            getThermalResistancesAtSection(section_index);
        if (unknown_index < 0 ||
            unknown_index >= static_cast<int>(thermal_resistances.size()))
        {
            OGS_FATAL("Invalid unknown index {:d} for section {:d}.",
                      unknown_index, section_index);
        }
        return thermal_resistances[unknown_index];
    }

References getThermalResistancesAtSection(), and OGS_FATAL.

Member Data Documentation

◆ _flow_velocities

std::vector<double> ProcessLib::HeatTransportBHE::BHE::BHECommon::_flow_velocities

protected

Flow velocities per section [m/s]. For single-section pipes, will have one element.

Definition at line 129 of file BHECommon.h.

Referenced by ProcessLib::HeatTransportBHE::BHE::BHE_CXA::assignVelocities(), ProcessLib::HeatTransportBHE::BHE::BHE_CXC::assignVelocities(), getClampedFlowVelocity(), ProcessLib::HeatTransportBHE::BHE::BHE_1P::updateHeatTransferCoefficients(), ProcessLib::HeatTransportBHE::BHE::BHE_1U::updateHeatTransferCoefficients(), ProcessLib::HeatTransportBHE::BHE::BHE_2U::updateHeatTransferCoefficients(), and ProcessLib::HeatTransportBHE::BHE::BHECommonCoaxial::velocities().

◆ _sectional_thermal_resistances

std::vector<std::vector<double> > ProcessLib::HeatTransportBHE::BHE::BHECommon::_sectional_thermal_resistances

protected

Thermal resistances per section. Each element is a vector of resistances for that section's unknowns.

Definition at line 144 of file BHECommon.h.

Referenced by getThermalResistancesAtSection(), and recomputeSectionalResistances().

◆ borehole_geometry

BoreholeGeometry const ProcessLib::HeatTransportBHE::BHE::BHECommon::borehole_geometry

Definition at line 71 of file BHECommon.h.

◆ flowAndTemperatureControl

FlowAndTemperatureControl const ProcessLib::HeatTransportBHE::BHE::BHECommon::flowAndTemperatureControl

Definition at line 74 of file BHECommon.h.

◆ grout

GroutParameters const ProcessLib::HeatTransportBHE::BHE::BHECommon::grout

Definition at line 73 of file BHECommon.h.

◆ refrigerant

RefrigerantProperties const ProcessLib::HeatTransportBHE::BHE::BHECommon::refrigerant

Definition at line 72 of file BHECommon.h.

◆ use_python_bcs

bool const ProcessLib::HeatTransportBHE::BHE::BHECommon::use_python_bcs

Definition at line 75 of file BHECommon.h.

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

BHECommon.h

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ BHECommon()

Member Function Documentation

◆ getClampedFlowVelocity()

◆ getNumberOfSections()

◆ getSectionBoundaries()

◆ getThermalResistancesAtSection()

◆ isPowerBC()

◆ recomputeSectionalResistances()

◆ thermalResistanceAtSection()

Member Data Documentation

◆ _flow_velocities

◆ _sectional_thermal_resistances

◆ borehole_geometry

◆ flowAndTemperatureControl

◆ grout

◆ refrigerant

◆ use_python_bcs