Borehole

This document contains all the information of the borehole class.

class GHEtool.VariableClasses.Borehole.Borehole(fluid_data: Optional[FluidData] = None, pipe_data: Optional[_PipeData] = None)

Bases: BaseClass

The borehole class contains all the functionalities related to the calculation of the equivalent borehole thermal resistance and contains a fluid and pipe class object.

Parameters

fluid_dataFluidData: Fluid data
pipe_dataPipeData: Pipe data

property Rb: float

This returns the constant, equivalent borehole thermal resistance [mK/W].

Returns

Rb*float: Equivalent borehole thermal resistance [mK/W]

property Re: float

Reynolds number.

Returns

Reynolds numberfloat

calculate_Rb(H: float, D: float, r_b: float, k_s: float) → float

This function calculates the equivalent borehole thermal resistance.

Parameters

Hfloat: Borehole depth [m]
Dfloat: Borehole burial depth [m]
r_bfloat: Borehole radius [m]
k_sfloat: Ground thermal conductivity [mk/W]

Returns

Rbfloat: Equivalent borehole thermal resistance

Raises

ValueError: ValueError when the pipe and/or fluid data is not set correctly.

property fluid_data: FluidData

This function returns the fluid data object.

Returns

FluidData

get_Rb(H: float, D: float, r_b: float, k_s: float) → float

This function returns the equivalent borehole thermal resistance. If use_constant_Rb is True, self._Rb is returned, otherwise the resistance is calculated.

Parameters

Hfloat: Borehole depth [m]
Dfloat: Borehole burial depth [m]
r_bfloat: Borehole radius [m]
k_sfloat: Ground thermal conductivity [mk/W]

Returns

Rb*float: Equivalent borehole thermal resistance [mK/W]

property pipe_data: _PipeData

This function returns the pipe data object.

Returns

PipeData