Skip to content
LIBRARY
Interfaces.PartialDistributedVolume.md

Interfaces.PartialDistributedVolume ​

Base class for a one-dimensional finite-volume discretization of fluid storage.

The extending component supplies the segment volumes and all boundary source terms. Each volume stores mass, energy, composition, and trace substances according to the selected balance formulations.

Usage ​

FluidComponents.Interfaces.PartialDistributedVolume(p_a_start, p_b_start=p_a_start, ps_start=n > 1 ? collect(range(p_a_start, p_b_start, length = n)) : fill((p_a_start + p_b_start) / 2, n), T_start, h_start, X_start=MediaComponents.Interfaces.medium_X_default(medium_data), C_start=MediaComponents.Interfaces.medium_C_default(medium_data))

Parameters: ​

NameDescriptionUnitsDefault value
medium_data–
n–
ThermoStates–MediaCompon...edium_data)
singleState–MediaCompon...edium_data)
nX–MediaCompon...edium_data)
nXi–MediaCompon...edium_data)
nC–MediaCompon...edium_data)
energyDynamics–
massDynamics–
substanceDynamics–massDynamics
traceDynamics–massDynamics
use_T_start–
initialize_p–!singleState
p_a_startPa
p_b_startPap_a_start
T_startK
h_startJ/kg
X_startkg/kgMediaCompon...edium_data)
C_start–MediaCompon...edium_data)

Variables ​

NameDescriptionUnits
fluidVolumesm3
UsJ
mskg
mXiskg
mCskg
mCs_scaledkg
Cs–
mb_flowskg/s
mbXi_flowskg/s
mbC_flowskg/s
Hb_flowsW
Qb_flowsW
Wb_flowsW

Source ​

dyad
"""
Base class for a one-dimensional finite-volume discretization of fluid storage.

The extending component supplies the segment volumes and all boundary source
terms. Each volume stores mass, energy, composition, and trace substances
according to the selected balance formulations.
"""
partial component PartialDistributedVolume
  # Immutable medium definition selected at model construction [-]
  structural parameter medium_data::MediaComponents.Interfaces.AbstractPartialMediumData
  # Number of discrete fluid volumes [-]
  structural parameter n::Integer(min = 1)
  # Choice of independent thermodynamic variables [-]
  final structural parameter ThermoStates::MediaComponents.Interfaces.Choices.IndependentVariables = MediaComponents.Interfaces.medium_thermo_states(medium_data)
  # Whether internal energy and density are independent of pressure [-]
  final structural parameter singleState::Boolean = MediaComponents.Interfaces.medium_single_state(medium_data)
  # Number of mass fractions [-]
  final structural parameter nX::Integer = MediaComponents.Interfaces.medium_nX(medium_data)
  # Number of independent mass fractions [-]
  final structural parameter nXi::Integer = MediaComponents.Interfaces.medium_nXi(medium_data)
  # Number of extra transported properties [-]
  final structural parameter nC::Integer = MediaComponents.Interfaces.medium_nC(medium_data)
  # Formulation of the energy balances [-]
  structural parameter energyDynamics::FluidComponents.Types.Dynamics
  # Formulation of the mass balances [-]
  structural parameter massDynamics::FluidComponents.Types.Dynamics
  # Formulation of the substance balances [-]
  final structural parameter substanceDynamics::FluidComponents.Types.Dynamics = massDynamics
  # Formulation of the trace-substance balances [-]
  final structural parameter traceDynamics::FluidComponents.Types.Dynamics = massDynamics
  # Start value of pressure at port a [Pa]
  parameter p_a_start::MediaComponents.Types.AbsolutePressure
  # Start value of pressure at port b [Pa]
  parameter p_b_start::MediaComponents.Types.AbsolutePressure = p_a_start
  # Start values of pressure across the fluid volumes [Pa]
  final parameter ps_start::MediaComponents.Types.AbsolutePressure[n] = n > 1 ? collect(range(p_a_start, p_b_start, length = n)) : fill((p_a_start + p_b_start) / 2, n)
  # Whether temperature rather than specific enthalpy supplied the start state [-]
  structural parameter use_T_start::Boolean
  # Start value of temperature [K]
  parameter T_start::MediaComponents.Types.Temperature
  # Start value of specific enthalpy [J/kg]
  parameter h_start::MediaComponents.Types.SpecificEnthalpy
  # Start values of mass fractions [kg/kg]
  parameter X_start::MediaComponents.Types.MassFraction[nX] = MediaComponents.Interfaces.medium_X_default(medium_data)
  # Start values of trace substances [-]
  parameter C_start::MediaComponents.Types.ExtraProperty[nC] = MediaComponents.Interfaces.medium_C_default(medium_data) if nC > 0
  # Discretized fluid volumes supplied by the extending component [m3]
  variable fluidVolumes::Volume[n]
  # Internal energy stored in each fluid volume [J]
  variable Us::Energy[n]
  # Fluid mass stored in each fluid volume [kg]
  variable ms::Mass[n]
  # Independent-substance mass stored in each fluid volume [kg]
  variable mXis::Mass[n, nXi] if nXi > 0
  # Trace-substance mass stored in each fluid volume [kg]
  variable mCs::Mass[n, nC] if nC > 0
  # Scaled trace-substance mass state [kg]
  variable mCs_scaled::Mass[n, nC] if nC > 0
  # Trace-substance mixture content [-]
  variable Cs::MediaComponents.Types.ExtraProperty[n, nC] if nC > 0
  "Thermodynamic properties for each fluid volume."
  mediums = [MediaComponents.Interfaces.BaseProperties(medium_data = medium_data, preferredMediumStates = true) for i in 1:n]
  # Mass source flow for each fluid volume [kg/s]
  variable mb_flows::MediaComponents.Types.MassFlowRate[n]
  # Independent-substance source flow for each fluid volume [kg/s]
  variable mbXi_flows::MediaComponents.Types.MassFlowRate[n, nXi] if nXi > 0
  # Trace-substance source flow for each fluid volume [kg/s]
  variable mbC_flows::MediaComponents.Types.ExtraPropertyFlowRate[n, nC] if nC > 0
  # Enthalpy source flow for each fluid volume [W]
  variable Hb_flows::EnthalpyFlowRate[n]
  # Heat source flow for each fluid volume [W]
  variable Qb_flows::HeatFlowRate[n]
  # Mechanical power supplied to each fluid volume [W]
  variable Wb_flows::Power[n]
  # Whether pressure requires an explicit initialization equation [-]
  final structural parameter initialize_p::Boolean = !singleState
relations
  for i in 1:n
    guess mediums[i].p = ps_start[i]
    guess mediums[i].h = h_start
    guess mediums[i].T = T_start
    ms[i] = fluidVolumes[i] * mediums[i].d
    Us[i] = ms[i] * mediums[i].u
    if nXi > 0
      for j in 1:nXi
        guess mediums[i].Xi[j] = X_start[j]
        mXis[i, j] = ms[i] * mediums[i].Xi[j]
      end
    end
    if nC > 0
      for j in 1:nC
        mCs[i, j] = ms[i] * Cs[i, j]
      end
    end
  end
  if case(energyDynamics, FluidComponents.Types.Dynamics.SteadyState)
    for i in 1:n
      0 = Hb_flows[i] + Wb_flows[i] + Qb_flows[i]
    end
  else
    for i in 1:n
      der(Us[i]) = Hb_flows[i] + Wb_flows[i] + Qb_flows[i]
    end
  end
  if case(massDynamics, FluidComponents.Types.Dynamics.SteadyState)
    for i in 1:n
      0 = mb_flows[i]
    end
  else
    for i in 1:n
      der(ms[i]) = mb_flows[i]
    end
  end
  if nXi > 0
    if case(substanceDynamics, FluidComponents.Types.Dynamics.SteadyState)
      for i in 1:n
        for j in 1:nXi
          0 = mbXi_flows[i, j]
        end
      end
    else
      for i in 1:n
        for j in 1:nXi
          der(mXis[i, j]) = mbXi_flows[i, j]
        end
      end
    end
  end
  if nC > 0
    if case(traceDynamics, FluidComponents.Types.Dynamics.SteadyState)
      for i in 1:n
        for j in 1:nC
          0 = mbC_flows[i, j]
        end
      end
    else
      for i in 1:n
        for j in 1:nC
          der(mCs_scaled[i, j]) = mbC_flows[i, j] / MediaComponents.Interfaces.medium_C_nominal_at(medium_data, j)
          mCs[i, j] = mCs_scaled[i, j] * MediaComponents.Interfaces.medium_C_nominal_at(medium_data, j)
        end
      end
    end
  end
  if case(energyDynamics, FluidComponents.Types.Dynamics.FixedInitial)
    if case(ThermoStates, MediaComponents.Interfaces.Choices.IndependentVariables.ph) or case(ThermoStates, MediaComponents.Interfaces.Choices.IndependentVariables.phX)
      for i in 1:n
        initial mediums[i].h = h_start
      end
    else
      for i in 1:n
        initial mediums[i].T = T_start
      end
    end
  end
  if case(energyDynamics, FluidComponents.Types.Dynamics.SteadyStateInitial)
    if case(ThermoStates, MediaComponents.Interfaces.Choices.IndependentVariables.ph) or case(ThermoStates, MediaComponents.Interfaces.Choices.IndependentVariables.phX)
      for i in 1:n
        initial der(mediums[i].h) = 0
      end
    else
      for i in 1:n
        initial der(mediums[i].T) = 0
      end
    end
  end
  if initialize_p
    if case(massDynamics, FluidComponents.Types.Dynamics.FixedInitial)
      for i in 1:n
        initial mediums[i].p = ps_start[i]
      end
    end
    if case(massDynamics, FluidComponents.Types.Dynamics.SteadyStateInitial)
      for i in 1:n
        initial der(mediums[i].p) = 0
      end
    end
  end
  if nXi > 0
    if case(substanceDynamics, FluidComponents.Types.Dynamics.FixedInitial)
      for i in 1:n
        for j in 1:nXi
          initial mediums[i].Xi[j] = X_start[j]
        end
      end
    end
    if case(substanceDynamics, FluidComponents.Types.Dynamics.SteadyStateInitial)
      for i in 1:n
        for j in 1:nXi
          initial der(mediums[i].Xi[j]) = 0
        end
      end
    end
  end
  if nC > 0
    if case(traceDynamics, FluidComponents.Types.Dynamics.FixedInitial)
      for i in 1:n
        for j in 1:nC
          initial Cs[i, j] = C_start[j]
        end
      end
    end
    if case(traceDynamics, FluidComponents.Types.Dynamics.SteadyStateInitial)
      for i in 1:n
        for j in 1:nC
          initial der(mCs[i, j]) = 0
        end
      end
    end
  end
end
Flattened Source
dyad
"""
Base class for a one-dimensional finite-volume discretization of fluid storage.

The extending component supplies the segment volumes and all boundary source
terms. Each volume stores mass, energy, composition, and trace substances
according to the selected balance formulations.
"""
partial component PartialDistributedVolume
  # Immutable medium definition selected at model construction [-]
  structural parameter medium_data::MediaComponents.Interfaces.AbstractPartialMediumData
  # Number of discrete fluid volumes [-]
  structural parameter n::Integer(min = 1)
  # Choice of independent thermodynamic variables [-]
  final structural parameter ThermoStates::MediaComponents.Interfaces.Choices.IndependentVariables = MediaComponents.Interfaces.medium_thermo_states(medium_data)
  # Whether internal energy and density are independent of pressure [-]
  final structural parameter singleState::Boolean = MediaComponents.Interfaces.medium_single_state(medium_data)
  # Number of mass fractions [-]
  final structural parameter nX::Integer = MediaComponents.Interfaces.medium_nX(medium_data)
  # Number of independent mass fractions [-]
  final structural parameter nXi::Integer = MediaComponents.Interfaces.medium_nXi(medium_data)
  # Number of extra transported properties [-]
  final structural parameter nC::Integer = MediaComponents.Interfaces.medium_nC(medium_data)
  # Formulation of the energy balances [-]
  structural parameter energyDynamics::FluidComponents.Types.Dynamics
  # Formulation of the mass balances [-]
  structural parameter massDynamics::FluidComponents.Types.Dynamics
  # Formulation of the substance balances [-]
  final structural parameter substanceDynamics::FluidComponents.Types.Dynamics = massDynamics
  # Formulation of the trace-substance balances [-]
  final structural parameter traceDynamics::FluidComponents.Types.Dynamics = massDynamics
  # Start value of pressure at port a [Pa]
  parameter p_a_start::MediaComponents.Types.AbsolutePressure
  # Start value of pressure at port b [Pa]
  parameter p_b_start::MediaComponents.Types.AbsolutePressure = p_a_start
  # Start values of pressure across the fluid volumes [Pa]
  final parameter ps_start::MediaComponents.Types.AbsolutePressure[n] = n > 1 ? collect(range(p_a_start, p_b_start, length = n)) : fill((p_a_start + p_b_start) / 2, n)
  # Whether temperature rather than specific enthalpy supplied the start state [-]
  structural parameter use_T_start::Boolean
  # Start value of temperature [K]
  parameter T_start::MediaComponents.Types.Temperature
  # Start value of specific enthalpy [J/kg]
  parameter h_start::MediaComponents.Types.SpecificEnthalpy
  # Start values of mass fractions [kg/kg]
  parameter X_start::MediaComponents.Types.MassFraction[nX] = MediaComponents.Interfaces.medium_X_default(medium_data)
  # Start values of trace substances [-]
  parameter C_start::MediaComponents.Types.ExtraProperty[nC] = MediaComponents.Interfaces.medium_C_default(medium_data) if nC > 0
  # Discretized fluid volumes supplied by the extending component [m3]
  variable fluidVolumes::Volume[n]
  # Internal energy stored in each fluid volume [J]
  variable Us::Energy[n]
  # Fluid mass stored in each fluid volume [kg]
  variable ms::Mass[n]
  # Independent-substance mass stored in each fluid volume [kg]
  variable mXis::Mass[n, nXi] if nXi > 0
  # Trace-substance mass stored in each fluid volume [kg]
  variable mCs::Mass[n, nC] if nC > 0
  # Scaled trace-substance mass state [kg]
  variable mCs_scaled::Mass[n, nC] if nC > 0
  # Trace-substance mixture content [-]
  variable Cs::MediaComponents.Types.ExtraProperty[n, nC] if nC > 0
  "Thermodynamic properties for each fluid volume."
  mediums = [MediaComponents.Interfaces.BaseProperties(medium_data = medium_data, preferredMediumStates = true) for i in 1:n]
  # Mass source flow for each fluid volume [kg/s]
  variable mb_flows::MediaComponents.Types.MassFlowRate[n]
  # Independent-substance source flow for each fluid volume [kg/s]
  variable mbXi_flows::MediaComponents.Types.MassFlowRate[n, nXi] if nXi > 0
  # Trace-substance source flow for each fluid volume [kg/s]
  variable mbC_flows::MediaComponents.Types.ExtraPropertyFlowRate[n, nC] if nC > 0
  # Enthalpy source flow for each fluid volume [W]
  variable Hb_flows::EnthalpyFlowRate[n]
  # Heat source flow for each fluid volume [W]
  variable Qb_flows::HeatFlowRate[n]
  # Mechanical power supplied to each fluid volume [W]
  variable Wb_flows::Power[n]
  # Whether pressure requires an explicit initialization equation [-]
  final structural parameter initialize_p::Boolean = !singleState
relations
  for i in 1:n
    guess mediums[i].p = ps_start[i]
    guess mediums[i].h = h_start
    guess mediums[i].T = T_start
    ms[i] = fluidVolumes[i] * mediums[i].d
    Us[i] = ms[i] * mediums[i].u
    if nXi > 0
      for j in 1:nXi
        guess mediums[i].Xi[j] = X_start[j]
        mXis[i, j] = ms[i] * mediums[i].Xi[j]
      end
    end
    if nC > 0
      for j in 1:nC
        mCs[i, j] = ms[i] * Cs[i, j]
      end
    end
  end
  if case(energyDynamics, FluidComponents.Types.Dynamics.SteadyState)
    for i in 1:n
      0 = Hb_flows[i] + Wb_flows[i] + Qb_flows[i]
    end
  else
    for i in 1:n
      der(Us[i]) = Hb_flows[i] + Wb_flows[i] + Qb_flows[i]
    end
  end
  if case(massDynamics, FluidComponents.Types.Dynamics.SteadyState)
    for i in 1:n
      0 = mb_flows[i]
    end
  else
    for i in 1:n
      der(ms[i]) = mb_flows[i]
    end
  end
  if nXi > 0
    if case(substanceDynamics, FluidComponents.Types.Dynamics.SteadyState)
      for i in 1:n
        for j in 1:nXi
          0 = mbXi_flows[i, j]
        end
      end
    else
      for i in 1:n
        for j in 1:nXi
          der(mXis[i, j]) = mbXi_flows[i, j]
        end
      end
    end
  end
  if nC > 0
    if case(traceDynamics, FluidComponents.Types.Dynamics.SteadyState)
      for i in 1:n
        for j in 1:nC
          0 = mbC_flows[i, j]
        end
      end
    else
      for i in 1:n
        for j in 1:nC
          der(mCs_scaled[i, j]) = mbC_flows[i, j] / MediaComponents.Interfaces.medium_C_nominal_at(medium_data, j)
          mCs[i, j] = mCs_scaled[i, j] * MediaComponents.Interfaces.medium_C_nominal_at(medium_data, j)
        end
      end
    end
  end
  if case(energyDynamics, FluidComponents.Types.Dynamics.FixedInitial)
    if case(ThermoStates, MediaComponents.Interfaces.Choices.IndependentVariables.ph) or case(ThermoStates, MediaComponents.Interfaces.Choices.IndependentVariables.phX)
      for i in 1:n
        initial mediums[i].h = h_start
      end
    else
      for i in 1:n
        initial mediums[i].T = T_start
      end
    end
  end
  if case(energyDynamics, FluidComponents.Types.Dynamics.SteadyStateInitial)
    if case(ThermoStates, MediaComponents.Interfaces.Choices.IndependentVariables.ph) or case(ThermoStates, MediaComponents.Interfaces.Choices.IndependentVariables.phX)
      for i in 1:n
        initial der(mediums[i].h) = 0
      end
    else
      for i in 1:n
        initial der(mediums[i].T) = 0
      end
    end
  end
  if initialize_p
    if case(massDynamics, FluidComponents.Types.Dynamics.FixedInitial)
      for i in 1:n
        initial mediums[i].p = ps_start[i]
      end
    end
    if case(massDynamics, FluidComponents.Types.Dynamics.SteadyStateInitial)
      for i in 1:n
        initial der(mediums[i].p) = 0
      end
    end
  end
  if nXi > 0
    if case(substanceDynamics, FluidComponents.Types.Dynamics.FixedInitial)
      for i in 1:n
        for j in 1:nXi
          initial mediums[i].Xi[j] = X_start[j]
        end
      end
    end
    if case(substanceDynamics, FluidComponents.Types.Dynamics.SteadyStateInitial)
      for i in 1:n
        for j in 1:nXi
          initial der(mediums[i].Xi[j]) = 0
        end
      end
    end
  end
  if nC > 0
    if case(traceDynamics, FluidComponents.Types.Dynamics.FixedInitial)
      for i in 1:n
        for j in 1:nC
          initial Cs[i, j] = C_start[j]
        end
      end
    end
    if case(traceDynamics, FluidComponents.Types.Dynamics.SteadyStateInitial)
      for i in 1:n
        for j in 1:nC
          initial der(mCs[i, j]) = 0
        end
      end
    end
  end
metadata {}
end


Test Cases ​

No test cases defined.

  • Examples

  • Experiments

  • Analyses