---
url: /dyad/dev/stdlib/FluidComponents/components/Pipes.BaseClasses.FlowModels.NominalLaminarFlow.md
description: >-
  Dyad Pipes.BaseClasses.FlowModels.NominalLaminarFlow docs.  Linear laminar
  flow model parameterized by nominal pressure loss and mass flow.
---

# `Pipes.BaseClasses.FlowModels.NominalLaminarFlow` {#Pipes.BaseClasses.FlowModels.NominalLaminarFlow}

Linear laminar flow model parameterized by nominal pressure loss and mass flow.

This component extends from [`FluidComponents.Pipes.BaseClasses.FlowModels.PartialStaggeredFlowModel`](../types/PartialStaggeredFlowModel.md)

## Usage {#Usage}

`FluidComponents.Pipes.BaseClasses.FlowModels.NominalLaminarFlow(m_flow_start, nParallel, g=9.80665, p_a_start, p_b_start, rho_nominal=MediaComponents.Interfaces.density_pTX(medium_data, MediaComponents.Interfaces.medium_p_default(medium_data), MediaComponents.Interfaces.medium_T_default(medium_data), MediaComponents.Interfaces.medium_X_default(medium_data)), mu_nominal=MediaComponents.Interfaces.dynamicViscosity_pTX(medium_data, MediaComponents.Interfaces.medium_p_default(medium_data), MediaComponents.Interfaces.medium_T_default(medium_data), MediaComponents.Interfaces.medium_X_default(medium_data)), Re_turbulent=4000, dp_nominal, m_flow_nominal)`

## Parameters: {#Parameters:}

|                Name | Description | Units |             Default value |
| -------------------:| -----------:| -----:| -------------------------:|
|       `medium_data` |             |     – |                           |
| `allowFlowReversal` |             |     – |                           |
|                 `m` |             |     – |                     n - 1 |
|  `momentumDynamics` |             |     – |                           |
|                 `n` |             |     – |                           |
|         `n_minus_1` |             |     – |                     n - 1 |
| `useUpstreamScheme` |             |     – |                      true |
|      `use_Ib_flows` |             |     – | !\_\_dyad_isa...teadyState) |
|   `use_rho_nominal` |             |     – |                     false |
|    `use_mu_nominal` |             |     – |                 !show_Res |
|          `show_Res` |             |     – |                     false |
|      `m_flow_start` |             |  kg/s |                           |
|         `nParallel` |             |     – |                           |
|                 `g` |             |  m/s2 |                   9.80665 |
|         `p_a_start` |             |    Pa |                           |
|         `p_b_start` |             |    Pa |                           |
|       `rho_nominal` |             | kg/m3 | MediaCompon...dium_data)) |
|        `mu_nominal` |             |  Pa.s | MediaCompon...dium_data)) |
|      `Re_turbulent` |             |     1 |                      4000 |
|        `dp_nominal` |             |    Pa |                           |
|    `m_flow_nominal` |             |  kg/s |                           |

## Variables {#Variables}

|                  Name | Description |  Units |
| ---------------------:| -----------:| ------:|
|         `pathLengths` |             |      m |
|             `m_flows` |             |   kg/s |
|                  `Is` |             | kg.m/s |
|            `Ib_flows` |             |      N |
|                `Fs_p` |             |      N |
|               `Fs_fg` |             |      N |
|                  `vs` |             |    m/s |
|          `crossAreas` |             |     m2 |
|          `dimensions` |             |      m |
|         `roughnesses` |             |      m |
|            `dheights` |             |      m |
|                `rhos` |             |  kg/m3 |
|            `rhos_act` |             |  kg/m3 |
|                 `mus` |             |   Pa.s |
|             `mus_act` |             |   Pa.s |
|                 `Res` |             |      1 |
|   `m_flows_turbulent` |             |   kg/s |
|              `dps_fg` |             |     Pa |
| `pathLengths_nominal` |             |      m |

## Behavior {#Behavior}

## Source {#Source}

```dyad
"Linear laminar flow model parameterized by nominal pressure loss and mass flow."
component NominalLaminarFlow
  extends FluidComponents.Pipes.BaseClasses.FlowModels.PartialStaggeredFlowModel(use_mu_nominal = !show_Res)
  # Nominal pressure loss [Pa]
  parameter dp_nominal::MediaComponents.Types.AbsolutePressure
  # Mass flow rate at the nominal pressure loss [kg/s]
  parameter m_flow_nominal::MediaComponents.Types.MassFlowRate
  # Circular-tube lengths implied by the nominal values [m]
  variable pathLengths_nominal::Length[n_minus_1] if show_Res
relations
  if show_Res
    for i in 1:n_minus_1
      pathLengths_nominal[i] = (dp_nominal / n_minus_1 - g * dheights[i]) * pi * ((dimensions[i] + dimensions[i + 1]) / 2) ^ 4 * rhos_act[i] / (128 * mus_act[i]) / (m_flow_nominal / nParallel)
    end
  end
  if !allowFlowReversal or use_rho_nominal or !useUpstreamScheme
    for i in 1:n_minus_1
      dps_fg[i] = g * dheights[i] * rhos_act[i] + dp_nominal / n_minus_1 / m_flow_nominal * m_flows[i]
    end
  else
    for i in 1:n_minus_1
      dps_fg[i] = g * dheights[i] * (m_flows[i] > 0 ? rhos[i] : rhos[i + 1]) + dp_nominal / n_minus_1 / m_flow_nominal * m_flows[i]
    end
  end
end
```

```dyad
"Linear laminar flow model parameterized by nominal pressure loss and mass flow."
component NominalLaminarFlow
  # Immutable medium definition selected at model construction [-]
  structural parameter medium_data::MediaComponents.Interfaces.AbstractPartialMediumData
  # Whether flow reversal is permitted [-]
  structural parameter allowFlowReversal::Boolean
  # Number of momentum-balance segments [-]
  structural parameter m::Integer(min = 1)
  # Formulation of the momentum balances [-]
  structural parameter momentumDynamics::FluidComponents.Types.Dynamics
  # Start value of the segment mass flow rates [kg/s]
  parameter m_flow_start::MediaComponents.Types.MassFlowRate
  # Lengths of the momentum-balance segments supplied by the composing model [m]
  variable pathLengths::Length[m]
  # Mass flow rates between thermodynamic states [kg/s]
  variable m_flows::MediaComponents.Types.MassFlowRate(min = allowFlowReversal ? -Inf : 0)[m]
  # Momentum stored in the flow segments [kg.m/s]
  variable Is::Momentum[m]
  # Momentum flow across segment boundaries [N]
  variable Ib_flows::Force[m]
  # Pressure forces acting on the flow segments [N]
  variable Fs_p::Force[m]
  # Friction and gravity forces acting on the flow segments [N]
  variable Fs_fg::Force[m]
  # Number of discrete thermodynamic states [-]
  structural parameter n::Integer(min = 2)
  # Number of momentum segments between adjacent thermodynamic states [-]
  final structural parameter n_minus_1::Integer = n - 1
  "Thermodynamic states along the design-flow direction."
  states = [MediaComponents.Interfaces.ThermodynamicState(medium_data = medium_data) for i in 1:n]
  # Mean fluid velocities at the state locations [m/s]
  variable vs::Velocity[n]
  # Number of identical parallel flow devices [-]
  parameter nParallel::Real
  # Cross-sectional flow areas at the state locations [m2]
  variable crossAreas::Area[n]
  # Characteristic flow dimensions at the state locations [m]
  variable dimensions::Length[n]
  # Average surface roughness at the state locations [m]
  variable roughnesses::FluidComponents.Types.Roughness[n]
  # Height differences between adjacent state locations [m]
  variable dheights::Length[n_minus_1]
  # Constant gravitational acceleration [m/s2]
  parameter g::Acceleration = 9.80665
  # Start pressure at the design inlet [Pa]
  parameter p_a_start::MediaComponents.Types.AbsolutePressure
  # Start pressure at the design outlet [Pa]
  parameter p_b_start::MediaComponents.Types.AbsolutePressure
  # Whether segment properties are selected from the upstream state [-]
  structural parameter useUpstreamScheme::Boolean = true
  # Whether momentum-flow differences across boundaries are included [-]
  structural parameter use_Ib_flows::Boolean = !case(momentumDynamics, FluidComponents.Types.Dynamics.SteadyState)
  # Whether nominal rather than state-dependent density is used [-]
  structural parameter use_rho_nominal::Boolean = false
  # Whether nominal rather than state-dependent viscosity is used [-]
  structural parameter use_mu_nominal::Boolean = false
  # Nominal fluid density [kg/m3]
  parameter rho_nominal::MediaComponents.Types.Density = MediaComponents.Interfaces.density_pTX(medium_data, MediaComponents.Interfaces.medium_p_default(medium_data), MediaComponents.Interfaces.medium_T_default(medium_data), MediaComponents.Interfaces.medium_X_default(medium_data))
  # Nominal dynamic viscosity [Pa.s]
  parameter mu_nominal::MediaComponents.Types.DynamicViscosity = MediaComponents.Interfaces.dynamicViscosity_pTX(medium_data, MediaComponents.Interfaces.medium_p_default(medium_data), MediaComponents.Interfaces.medium_T_default(medium_data), MediaComponents.Interfaces.medium_X_default(medium_data))
  # Reynolds number at the start of the turbulent regime [-]
  parameter Re_turbulent::ReynoldsNumber = 4000
  # Whether Reynolds-number diagnostics are included [-]
  structural parameter show_Res::Boolean = false
  # Density at each thermodynamic state [kg/m3]
  variable rhos::MediaComponents.Types.Density[n]
  # Actual density selected for each momentum segment [kg/m3]
  variable rhos_act::MediaComponents.Types.Density[n_minus_1]
  # Dynamic viscosity at each thermodynamic state [Pa.s]
  variable mus::MediaComponents.Types.DynamicViscosity[n]
  # Actual dynamic viscosity selected for each momentum segment [Pa.s]
  variable mus_act::MediaComponents.Types.DynamicViscosity[n_minus_1]
  # Reynolds number at each thermodynamic state [-]
  variable Res::ReynoldsNumber[n] if show_Res
  # Mass flow rate at the start of turbulent flow for each segment [kg/s]
  variable m_flows_turbulent::MediaComponents.Types.MassFlowRate[n_minus_1] if show_Res
  # Friction-plus-gravity pressure drop across each momentum segment [Pa]
  variable dps_fg::Pressure[n_minus_1]
  # Nominal pressure loss [Pa]
  parameter dp_nominal::MediaComponents.Types.AbsolutePressure
  # Mass flow rate at the nominal pressure loss [kg/s]
  parameter m_flow_nominal::MediaComponents.Types.MassFlowRate
  # Circular-tube lengths implied by the nominal values [m]
  variable pathLengths_nominal::Length[n_minus_1] if show_Res
relations
  guess m_flows = fill(m_flow_start, m)
  for i in 1:m
    Is[i] = m_flows[i] * pathLengths[i]
  end
  if case(momentumDynamics, FluidComponents.Types.Dynamics.SteadyState)
    for i in 1:m
      0 = Ib_flows[i] - Fs_p[i] - Fs_fg[i]
    end
  else
    for i in 1:m
      der(Is[i]) = Ib_flows[i] - Fs_p[i] - Fs_fg[i]
    end
  end
  if case(momentumDynamics, FluidComponents.Types.Dynamics.FixedInitial)
    initial m_flows = fill(m_flow_start, m)
  end
  if case(momentumDynamics, FluidComponents.Types.Dynamics.SteadyStateInitial)
    initial der(m_flows) = fill(0, m)
  end
  if use_rho_nominal
    rhos = fill(rho_nominal, n)
  else
    for i in 1:n
      rhos[i] = MediaComponents.Interfaces.density_state(medium_data, states[i].p, states[i].T, states[i].d, states[i].h, states[i].X)
    end
  end
  if use_mu_nominal
    mus = fill(mu_nominal, n)
  else
    for i in 1:n
      mus[i] = MediaComponents.Interfaces.dynamicViscosity_state(medium_data, states[i].p, states[i].T, states[i].d, states[i].h, states[i].X)
    end
  end
  if !allowFlowReversal
    for i in 1:n - 1
      rhos_act[i] = rhos[i]
      mus_act[i] = mus[i]
    end
  elseif !useUpstreamScheme
    for i in 1:n - 1
      rhos_act[i] = 0.5 * (rhos[i] + rhos[i + 1])
      mus_act[i] = 0.5 * (mus[i] + mus[i + 1])
    end
  else
    for i in 1:n - 1
      rhos_act[i] = m_flows[i] > 0 ? rhos[i] : rhos[i + 1]
      mus_act[i] = m_flows[i] > 0 ? mus[i] : mus[i + 1]
    end
  end
  if use_Ib_flows
    for i in 1:n - 1
      Ib_flows[i] = nParallel * (rhos[i] * vs[i] ^ 2 * crossAreas[i] - rhos[i + 1] * vs[i + 1] ^ 2 * crossAreas[i + 1])
    end
  else
    Ib_flows = fill(0, n - 1)
  end
  guess dps_fg = fill((p_a_start - p_b_start) / (n - 1), n - 1)
  for i in 1:n - 1
    Fs_p[i] = nParallel * 0.5 * (crossAreas[i] + crossAreas[i + 1]) * (MediaComponents.Interfaces.pressure_state(medium_data, states[i + 1].p, states[i + 1].T, states[i + 1].d, states[i + 1].h, states[i + 1].X) - MediaComponents.Interfaces.pressure_state(medium_data, states[i].p, states[i].T, states[i].d, states[i].h, states[i].X))
    dps_fg[i] = Fs_fg[i] / nParallel * 2 / (crossAreas[i] + crossAreas[i + 1])
  end
  if show_Res
    for i in 1:n
      Res[i] = FluidComponents.Pipes.BaseClasses.CharacteristicNumbers.ReynoldsNumber(vs[i], rhos[i], mus[i], dimensions[i])
    end
    for i in 1:n - 1
      m_flows_turbulent[i] = nParallel * (crossAreas[i] + crossAreas[i + 1]) / (dimensions[i] + dimensions[i + 1]) * mus_act[i] * Re_turbulent
    end
  end
  if show_Res
    for i in 1:n_minus_1
      pathLengths_nominal[i] = (dp_nominal / n_minus_1 - g * dheights[i]) * pi * ((dimensions[i] + dimensions[i + 1]) / 2) ^ 4 * rhos_act[i] / (128 * mus_act[i]) / (m_flow_nominal / nParallel)
    end
  end
  if !allowFlowReversal or use_rho_nominal or !useUpstreamScheme
    for i in 1:n_minus_1
      dps_fg[i] = g * dheights[i] * rhos_act[i] + dp_nominal / n_minus_1 / m_flow_nominal * m_flows[i]
    end
  else
    for i in 1:n_minus_1
      dps_fg[i] = g * dheights[i] * (m_flows[i] > 0 ? rhos[i] : rhos[i + 1]) + dp_nominal / n_minus_1 / m_flow_nominal * m_flows[i]
    end
  end
metadata {}
end
```

## Test Cases {#Test-Cases}

No test cases defined.

## Related {#Related}

* Examples

* Experiments

* Analyses
