---
url: /dyad/dev/stdlib/FluidComponents.md
description: >-
  Dyad index docs.  This is the documentation for the FluidComponents library. 
  Here you will find the documentation for the various definitions contained in
  Fl...
---

# FluidComponents {#FluidComponents}

This is the documentation for the `FluidComponents` library.  Here you will find the documentation for the various definitions contained in `FluidComponents`.

Note that this documentation is automatically generated primarily from the doc strings and metadata associated with those definitions.

## Types {#Types}

* [`Interfaces.PartialDistributedFlow`](types/Interfaces.PartialDistributedFlow.md) - Base class for a distributed momentum balance.

* [`Interfaces.PartialDistributedVolume`](types/Interfaces.PartialDistributedVolume.md) - Base class for a one-dimensional finite-volume discretization of fluid storage.

* [`Interfaces.PartialHeatTransfer`](types/Interfaces.PartialHeatTransfer.md) - Common interface for heat transfer between distributed fluid segments and

* [`Interfaces.PartialStaggeredFlowModel`](types/Interfaces.PartialStaggeredFlowModel.md) - Base class for staggered-grid momentum balances between adjacent fluid states.

* [`Interfaces.PartialTwoPort`](types/Interfaces.PartialTwoPort.md) - Partial interface for fluid components with two ports.

* [`Interfaces.PartialTwoPortTransport`](types/Interfaces.PartialTwoPortTransport.md) - Partial element transporting fluid between two ports without storing mass or

* [`Pipes.BaseClasses.FlowModels.PartialStaggeredFlowModel`](types/Pipes.BaseClasses.FlowModels.PartialStaggeredFlowModel.md) - Base class for staggered-grid momentum balances between adjacent fluid states.

* [`Pipes.BaseClasses.HeatTransfer.PartialFlowHeatTransfer`](types/Pipes.BaseClasses.HeatTransfer.PartialFlowHeatTransfer.md) - Base class for heat-transfer correlations along a distributed fluid-flow path.

* [`Pipes.BaseClasses.PartialTwoPortFlow`](types/Pipes.BaseClasses.PartialTwoPortFlow.md) - Base class for distributed fluid flow with finite-volume storage and staggered momentum balances.

* [`Sources.BaseClasses.PartialFlowSource`](types/Sources.BaseClasses.PartialFlowSource.md) - Base class for prescribed fluid-flow sources with one or more fluid ports.

* [`Sources.BaseClasses.PartialSource`](types/Sources.BaseClasses.PartialSource.md) - Base class for prescribed fluid boundaries with one or more fluid ports.

* [`Types.CvTypes`](types/Types.CvTypes.md)

* [`Types.Dynamics`](types/Types.Dynamics.md)

* [`Types.ModelStructure`](types/Types.ModelStructure.md)

* [`Types.Roughness`](types/Types.Roughness.md)

* [`Valves.BaseClasses.PartialValve`](types/Valves.BaseClasses.PartialValve.md) - Base class for valves that transport fluid without storing mass or energy.

* [`Valves.BaseClasses.ValveCharacteristic`](types/Valves.BaseClasses.ValveCharacteristic.md) - Inherent valve-flow characteristic selected for a valve model.

## Connectors {#Connectors}

* [`Interfaces.FluidPort`](connectors/Interfaces.FluidPort.md) - Interface for quasi one-dimensional fluid flow in a piping network.

* [`Interfaces.FluidPort_a`](connectors/Interfaces.FluidPort_a.md) - Generic fluid connector at the design inlet.

* [`Interfaces.FluidPort_b`](connectors/Interfaces.FluidPort_b.md) - Generic fluid connector at the design outlet.

## Components {#Components}

* [`Examples.BranchingDynamicPipes`](components/Examples.BranchingDynamicPipes.md) - Branching network of dynamic pipes with a pressure step at the upper boundary.

* [`Examples.HeatExchanger.BaseClasses.BasicHX`](components/Examples.HeatExchanger.BaseClasses.BasicHX.md) - Two-stream heat exchanger composed of distributed fluid pipes and a separating

* [`Examples.HeatExchanger.BaseClasses.WallConstProps`](components/Examples.HeatExchanger.BaseClasses.WallConstProps.md) - Pipe wall with lumped thermal capacitance, one-dimensional heat conduction,

* [`Examples.HeatExchanger.WaterToWaterCounterFlow`](components/Examples.HeatExchanger.WaterToWaterCounterFlow.md) - Transient counterflow heat exchanger with hot liquid water transferring heat to

* [`Examples.IncompressibleFluidNetwork`](components/Examples.IncompressibleFluidNetwork.md) - Multi-way network of eleven dynamic pipes, three incompressible valves, and

* [`Pipes.BaseClasses.FlowModels.NominalLaminarFlow`](components/Pipes.BaseClasses.FlowModels.NominalLaminarFlow.md) - Linear laminar flow model parameterized by nominal pressure loss and mass flow.

* [`Pipes.BaseClasses.HeatTransfer.ConstantFlowHeatTransfer`](components/Pipes.BaseClasses.HeatTransfer.ConstantFlowHeatTransfer.md) - Distributed heat-transfer model with a constant heat-transfer coefficient.

* [`Pipes.DynamicPipe`](components/Pipes.DynamicPipe.md) - Straight pipe with distributed storage of mass and energy and staggered

* [`Sources.Boundary_pT`](components/Sources.Boundary_pT.md) - Fluid boundary with prescribed pressure, temperature, composition, and trace

* [`Sources.MassFlowSource_T`](components/Sources.MassFlowSource_T.md) - Ideal fluid source with prescribed total mass flow, temperature, composition,

* [`Tests.ValveIncompressibleVerification`](components/Tests.ValveIncompressibleVerification.md) - Concrete verification network for the three operating modes of

* [`Valves.ValveIncompressible`](components/Valves.ValveIncompressible.md) - Valve for liquids and other fluids whose density changes little across the

## Analyses {#Analyses}

* [`Examples.BranchingDynamicPipesTransient`](analyses/Examples.BranchingDynamicPipesTransient.md) - Transient pressure-step analysis of the branching dynamic-pipe network.

* [`Examples.HeatExchanger.WaterToWaterCounterFlowTransient`](analyses/Examples.HeatExchanger.WaterToWaterCounterFlowTransient.md) - Transient analysis of hot water transferring heat to cold water.

* [`Examples.IncompressibleFluidNetworkTransient`](analyses/Examples.IncompressibleFluidNetworkTransient.md) - Transient analysis of the incompressible multi-way pipe network.

* [`Tests.ValveIncompressibleVerificationTransient`](analyses/Tests.ValveIncompressibleVerificationTransient.md) - Transient verification of the incompressible-valve operating modes.
