.. Thermofluids documentation master file, created by
   sphinx-quickstart on Thu Oct  8 13:47:07 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Thermofluids
============


.. toctree::
   :maxdepth: 2
   :caption: Contents:

Essential Functionality
_______________________
.. autoclass:: thermofluids.Base.Statepoint.Statepoint
   :members: __add__, __div__
.. autoclass:: ...src.Base.Quantity

Fluids
______
.. automodule:: thermofluids.Fluids.Drag
   :members: f_drag, settling_vel
.. automodule:: thermofluids.Fluids.Moody
   :members: frictionfactor
.. automodule:: thermofluids.Fluids.Re
   :members: Re, Re_ext
.. automodule:: thermofluids.Fluids.PressureDrop
   :members: pressure_drop, pressure_drop_fitting, pressure_drop_packed_bed, pressure_drop_corrugated_plates, flow_at_dp

Heat Transfer
_____________
.. automodule:: thermofluids.HeatTransfer.lmtd
   :members: lmtd
.. automodule:: thermofluids.HeatTransfer.Nusselt
   :members: Nu, Nu_natural
.. automodule:: thermofluids.HeatTransfer.Ra
   :members: Ra
.. automodule:: thermofluids.HeatTransfer.Gr
   :members: Gr
.. automodule:: thermofluids.HeatTransfer.NTU
   :members: NTU
.. automodule:: thermofluids.HeatTransfer.TwoPhase
   :members: Co, Bo, Fr_le, crit_heat_flux, heat_flux_nucleate_boiling, htc_conv_boil

Special Properties
__________________
.. automodule:: thermofluids.Properties
.. automodule:: thermofluids.Properties.BrineProps
   :members: get_c_freeze, get_T_liq_sat, get_T_vap_sat, get_P_liq_sat, get_P_vap_sat, get_h_mix, get_C_vap_sat, get_C_liq_sat

Process Equipment
_________________
.. automodule:: thermofluids.ProcessEquipment
.. automodule:: thermofluids.ProcessEquipment.Column
   :members: Column
.. automodule:: thermofluids.ProcessEquipment.Compressor
   :members: Compressor
.. automodule:: thermofluids.ProcessEquipment.HeatExchanger
   :members: HX_Energy
.. automodule:: thermofluids.ProcessEquipment.IsoCompressor
   :members: IsoCompressor
.. automodule:: thermofluids.ProcessEquipment.Pump
   :members: Pump
.. automodule:: thermofluids.ProcessEquipment.Turbine
   :members: Turbine
.. automodule:: thermofluids.ProcessEquipment.Valve
   :members: get_valve_flow_rate, get_valve_dP, get_valve_C_v
