Buildings.Templates.Components.Data

Records for design and operating parameters

Information

This package provides records for design and operating parameters.

Extends from Modelica.Icons.MaterialPropertiesPackage (Icon for package containing property classes).

Package Content

Name Description
Buildings.Templates.Components.Data.Coil Coil Record for coil model
Buildings.Templates.Components.Data.Damper Damper Record for damper model
Buildings.Templates.Components.Data.Fan Fan Record for fan model
Buildings.Templates.Components.Data.HeatPump HeatPump Record for heat pump model
Buildings.Templates.Components.Data.PumpMultiple PumpMultiple Record for multiple-pump models
Buildings.Templates.Components.Data.PumpSingle PumpSingle Record for single pump model
Buildings.Templates.Components.Data.Valve Valve Record for valve model

Buildings.Templates.Components.Data.Coil Buildings.Templates.Components.Data.Coil

Record for coil model

Information

This record provides the set of sizing parameters for the classes within Buildings.Templates.Components.Coils.

Extends from Modelica.Icons.Record (Icon for records).

Parameters

TypeNameDefaultDescription
Carrier_Centurion_50PG06datCoiredeclare parameter Building...Performance data record of evaporator coil
Configuration
Coiltyp Equipment type
ValvetypVal Type of valve
Booleanhave_sou Set to true for fluid ports on the source side
Nominal condition
MassFlowRatemAir_flow_nominal Air mass flow rate [kg/s]
PressureDifferencedpAir_nominal Air pressure drop [Pa]
MassFlowRatemWat_flow_nominal Liquid mass flow rate [kg/s]
PressureDifferencedpWat_nominal Liquid pressure drop across coil [Pa]
PressureDifferencedpValve_nominal Liquid pressure drop across fully open valve [Pa]
HeatFlowRatecap_nominal Coil capacity [W]
TemperatureTWatEnt_nominal Nominal entering liquid temperature [K]
TemperatureTAirEnt_nominal Nominal entering air temperature [K]
MassFractionwAirEnt_nominal Nominal entering air humidity ratio [1]

Modelica definition

record Coil "Record for coil model" extends Modelica.Icons.Record; parameter Buildings.Templates.Components.Types.Coil typ "Equipment type"; parameter Buildings.Templates.Components.Types.Valve typVal "Type of valve"; parameter Boolean have_sou "Set to true for fluid ports on the source side"; /* For evaporator coils this is also provided by the performance data record. The coil model shall generate a warning in case the design value exceeds the maximum value from the performance data record. */ parameter Modelica.Units.SI.MassFlowRate mAir_flow_nominal( final min=0, start=if typ==Buildings.Templates.Components.Types.Coil.EvaporatorMultiStage or typ==Buildings.Templates.Components.Types.Coil.EvaporatorVariableSpeed then datCoi.sta[datCoi.nSta].nomVal.m_flow_nominal else 1) "Air mass flow rate"; parameter Modelica.Units.SI.PressureDifference dpAir_nominal( final min=0, displayUnit="Pa", start=if typ==Buildings.Templates.Components.Types.Coil.None then 0 else 100) "Air pressure drop"; parameter Modelica.Units.SI.MassFlowRate mWat_flow_nominal( final min=0, start=if typ==Buildings.Templates.Components.Types.Coil.WaterBasedHeating then Q_flow_nominal / 4186 / 10 elseif typ==Buildings.Templates.Components.Types.Coil.WaterBasedCooling then -Q_flow_nominal / 4186 / 5 else 0) "Liquid mass flow rate"; parameter Modelica.Units.SI.PressureDifference dpWat_nominal( final min=0, displayUnit="Pa", start=if typ==Buildings.Templates.Components.Types.Coil.WaterBasedHeating then 0.5e4 elseif typ==Buildings.Templates.Components.Types.Coil.WaterBasedCooling then 3e4 else 0) "Liquid pressure drop across coil"; parameter Modelica.Units.SI.PressureDifference dpValve_nominal( final min=0, displayUnit="Pa", start=if typVal==Buildings.Templates.Components.Types.Valve.None then 0 else dpWat_nominal / 2) "Liquid pressure drop across fully open valve"; parameter Modelica.Units.SI.HeatFlowRate cap_nominal( start=if typ==Buildings.Templates.Components.Types.Coil.None then 0 elseif typ==Buildings.Templates.Components.Types.Coil.EvaporatorMultiStage or typ==Buildings.Templates.Components.Types.Coil.EvaporatorVariableSpeed then datCoi.sta[datCoi.nSta].nomVal.Q_flow_nominal elseif typ==Buildings.Templates.Components.Types.Coil.WaterBasedCooling then -1E4 else 1E4) "Coil capacity"; /* For evaporator coils this is also provided by the performance data record. The coil model shall generate a warning in case the design value exceeds the maximum value from the performance data record. */ final parameter Modelica.Units.SI.HeatFlowRate Q_flow_nominal= if typ==Buildings.Templates.Components.Types.Coil.WaterBasedHeating or typ==Buildings.Templates.Components.Types.Coil.ElectricHeating then abs(cap_nominal) else -1 * abs(cap_nominal) "Nominal heat flow rate"; parameter Modelica.Units.SI.Temperature TWatEnt_nominal( final min=273.15, displayUnit="degC", start=if typ==Buildings.Templates.Components.Types.Coil.WaterBasedHeating then 50+273.15 elseif typ==Buildings.Templates.Components.Types.Coil.WaterBasedCooling then 7+273.15 else 273.15) "Nominal entering liquid temperature"; parameter Modelica.Units.SI.Temperature TAirEnt_nominal( final min=243.15, displayUnit="degC", start=if typ==Buildings.Templates.Components.Types.Coil.WaterBasedCooling then 30+273.15 else 273.15) "Nominal entering air temperature"; parameter Modelica.Units.SI.MassFraction wAirEnt_nominal( final min=0, start=0.01) "Nominal entering air humidity ratio"; replaceable parameter Buildings.Fluid.DXSystems.Cooling.AirSource.Data.SingleSpeed.Carrier_Centurion_50PG06 datCoi constrainedby Buildings.Fluid.DXSystems.Cooling.AirSource.Data.Generic.DXCoil "Performance data record of evaporator coil"; end Coil;

Buildings.Templates.Components.Data.Damper Buildings.Templates.Components.Data.Damper

Record for damper model

Information

This record provides the set of sizing parameters for the class Buildings.Templates.Components.Actuators.Damper.

Extends from Modelica.Icons.Record (Icon for records).

Parameters

TypeNameDefaultDescription
Configuration
Dampertyp Equipment type
Mechanical
MassFlowRatem_flow_nominal Air mass flow rate [kg/s]
PressureDifferencedp_nominal Air pressure drop [Pa]
PressureDifferencedpFixed_nominal0Air pressure drop of fixed elements in series with damper [Pa]

Modelica definition

record Damper "Record for damper model" extends Modelica.Icons.Record; parameter Buildings.Templates.Components.Types.Damper typ "Equipment type"; parameter Modelica.Units.SI.MassFlowRate m_flow_nominal( final min=0, start=1) "Air mass flow rate"; parameter Modelica.Units.SI.PressureDifference dp_nominal( final min=0, displayUnit="Pa", start=if typ==Buildings.Templates.Components.Types.Damper.None then 0 elseif typ==Buildings.Templates.Components.Types.Damper.PressureIndependent then 50 else 15) "Air pressure drop"; parameter Modelica.Units.SI.PressureDifference dpFixed_nominal( final min=0, displayUnit="Pa")=0 "Air pressure drop of fixed elements in series with damper"; end Damper;

Buildings.Templates.Components.Data.Fan Buildings.Templates.Components.Data.Fan

Record for fan model

Buildings.Templates.Components.Data.Fan

Information

This record provides the set of sizing parameters for the classes within Buildings.Templates.Components.Fans.

Extends from Modelica.Icons.Record (Icon for records).

Parameters

TypeNameDefaultDescription
Genericperper(pressure(V_flow={0,1,2}*...Performance data
Configuration
Fantyp Equipment type
IntegernFan Number of fans
Nominal condition
MassFlowRatem_flow_nominal Total air mass flow rate [kg/s]
PressureDifferencedp_nominal Total pressure rise [Pa]

Modelica definition

record Fan "Record for fan model" extends Modelica.Icons.Record; parameter Buildings.Templates.Components.Types.Fan typ "Equipment type"; parameter Integer nFan( final min=0, start=if typ==Buildings.Templates.Components.Types.Fan.None then 0 else 1) "Number of fans"; parameter Modelica.Units.SI.MassFlowRate m_flow_nominal( final min=0, start=1) "Total air mass flow rate"; parameter Modelica.Units.SI.PressureDifference dp_nominal( final min=0, displayUnit="Pa", start=if typ==Buildings.Templates.Components.Types.Fan.None then 1 else 500) "Total pressure rise"; replaceable parameter Buildings.Fluid.Movers.Data.Generic per( pressure( V_flow={0, 1, 2} * m_flow_nominal / 1.2 / max(1, nFan), dp={1.5, 1, 0} * dp_nominal)) constrainedby Buildings.Fluid.Movers.Data.Generic "Performance data"; end Fan;

Buildings.Templates.Components.Data.HeatPump Buildings.Templates.Components.Data.HeatPump

Record for heat pump model

Buildings.Templates.Components.Data.HeatPump

Information

This record provides the set of sizing and operating parameters for heat pump models that can be found within Buildings.Templates.Components.HeatPumps.

Performance data for the equation fit model

When using typMod=Buildings.Templates.Components.Types.HeatPumpModel.EquationFit, the design values declared at the top-level are propagated by default to the performance data record per under the assumption that the reference conditions used for assessing the performance data match the design conditions. This avoids duplicate parameter assignments when manually entering the performance curve coefficients.

Note that this propagation does not persist when redeclaring or reassigning the record. This is because the equation fit method uses reference values that must match the ones used to compute the performance curve coefficients.

Also note that placeholders values are assigned to the performance curves, the reference source temperature and the input power in cooling mode to avoid assigning these parameters in case of non-reversible heat pumps. These values are unrealistic and must be overwritten for reversible heat pumps, which is always the case when redeclaring or reassigning the performance record per. Models that use this record will issue a warning if these placeholders values are not overwritten in case of reversible heat pumps.

Extends from Modelica.Icons.Record (Icon for records).

Parameters

TypeNameDefaultDescription
GenericperFitperFit(dpHeaLoa_nominal=dpHe...Performance data - Equation fit model
Configuration
HeatPumptyp Equipment type
Booleanis_rev Set to true for reversible heat pumps, false for heating only
HeatPumpModeltypMod Type of heat pump model
SpecificHeatCapacitycpHeaWat_defaultBuildings.Utilities.Psychrom...HW default specific heat capacity [J/(kg.K)]
SpecificHeatCapacitycpSou_defaultif typ == Buildings.Template...Source fluid default specific heat capacity [J/(kg.K)]
Nominal condition
MassFlowRatemHeaWat_flow_nominal HW mass flow rate [kg/s]
PressureDifferencedpHeaWat_nominal Pressure drop at design HW mass flow rate [Pa]
HeatFlowRatecapHea_nominal Heating capacity [W]
TemperatureTHeaWatSup_nominal (Highest) HW supply temperature [K]
MassFlowRatemChiWat_flow_nominal CHW mass flow rate [kg/s]
HeatFlowRatecapCoo_nominal Cooling capacity [W]
TemperatureTChiWatSup_nominal (Lowest) CHW supply temperature [K]
TemperatureTSouHea_nominal OAT or source fluid supply temperature (evaporator entering) in heating mode [K]
MassFlowRatemSouWwHea_flow_nominal Source fluid mass flow rate in heating mode [kg/s]
PressureDifferencedpSouWwHea_nominal Source fluid pressure drop in heating mode [Pa]
TemperatureTSouCoo_nominal OAT or source fluid supply temperature (condenser entering) in cooling mode [K]
MassFlowRatemSouWwCoo_flow_nominal Source fluid mass flow rate in cooling mode [kg/s]

Modelica definition

record HeatPump "Record for heat pump model" extends Modelica.Icons.Record; parameter Buildings.Templates.Components.Types.HeatPump typ "Equipment type"; parameter Boolean is_rev "Set to true for reversible heat pumps, false for heating only"; parameter Buildings.Templates.Components.Types.HeatPumpModel typMod "Type of heat pump model"; // Default fluid properties parameter Modelica.Units.SI.SpecificHeatCapacity cpHeaWat_default= Buildings.Utilities.Psychrometrics.Constants.cpWatLiq "HW default specific heat capacity"; /* cpChiWat_default is for internal use only. It is the same as cpChiWat_default for reversible HP. Non-reversible HP that can be controlled to produce either HW or CHW shall be modeled with chiller components (as a chiller/heater). */ final parameter Modelica.Units.SI.SpecificHeatCapacity cpChiWat_default= cpHeaWat_default "CHW default specific heat capacity"; parameter Modelica.Units.SI.SpecificHeatCapacity cpSou_default= if typ==Buildings.Templates.Components.Types.HeatPump.AirToWater then Buildings.Utilities.Psychrometrics.Constants.cpAir else Buildings.Utilities.Psychrometrics.Constants.cpWatLiq "Source fluid default specific heat capacity"; parameter Modelica.Units.SI.MassFlowRate mHeaWat_flow_nominal( final min=0) "HW mass flow rate"; parameter Modelica.Units.SI.PressureDifference dpHeaWat_nominal( min=0, start=Buildings.Templates.Data.Defaults.dpChiWatChi) "Pressure drop at design HW mass flow rate"; parameter Modelica.Units.SI.HeatFlowRate capHea_nominal "Heating capacity"; parameter Modelica.Units.SI.Temperature THeaWatSup_nominal( final min=273.15) "(Highest) HW supply temperature"; final parameter Modelica.Units.SI.Temperature THeaWatRet_nominal= THeaWatSup_nominal-abs(capHea_nominal)/cpHeaWat_default/mHeaWat_flow_nominal "HW return temperature"; parameter Modelica.Units.SI.MassFlowRate mChiWat_flow_nominal( start=0, final min=0) "CHW mass flow rate"; final parameter Modelica.Units.SI.PressureDifference dpChiWat_nominal= dpHeaWat_nominal * (mChiWat_flow_nominal/mHeaWat_flow_nominal)^2 "Pressure drop at design CHW mass flow rate"; parameter Modelica.Units.SI.HeatFlowRate capCoo_nominal( start=0) "Cooling capacity"; parameter Modelica.Units.SI.Temperature TChiWatSup_nominal( start=Buildings.Templates.Data.Defaults.TChiWatSup, final min=253.15) "(Lowest) CHW supply temperature"; final parameter Modelica.Units.SI.Temperature TChiWatRet_nominal= if is_rev then TChiWatSup_nominal+abs(capCoo_nominal)/cpChiWat_default/mChiWat_flow_nominal else Buildings.Templates.Data.Defaults.TChiWatRet "CHW return temperature"; parameter Modelica.Units.SI.Temperature TSouHea_nominal( start=Buildings.Templates.Data.Defaults.TOutHpHeaLow, final min=220) "OAT or source fluid supply temperature (evaporator entering) in heating mode"; parameter Modelica.Units.SI.MassFlowRate mSouWwHea_flow_nominal( start=mHeaWat_flow_nominal, final min=0) "Source fluid mass flow rate in heating mode"; parameter Modelica.Units.SI.PressureDifference dpSouWwHea_nominal( min=0, start=Buildings.Templates.Data.Defaults.dpChiWatChi) "Source fluid pressure drop in heating mode"; final parameter Modelica.Units.SI.MassFlowRate mSouHea_flow_nominal= if typ==Buildings.Templates.Components.Types.HeatPump.WaterToWater then mSouWwHea_flow_nominal else Buildings.Templates.Data.Defaults.mAirFloByCapChi * abs(capHea_nominal) "Source fluid mass flow rate in heating mode"; final parameter Modelica.Units.SI.PressureDifference dpSouHea_nominal= if typ==Buildings.Templates.Components.Types.HeatPump.WaterToWater then dpSouWwHea_nominal else Buildings.Templates.Data.Defaults.dpAirChi "Source fluid pressure drop in heating mode"; parameter Modelica.Units.SI.Temperature TSouCoo_nominal( start=Buildings.Templates.Data.Defaults.TOutHpCoo, final min=273.15) "OAT or source fluid supply temperature (condenser entering) in cooling mode"; parameter Modelica.Units.SI.MassFlowRate mSouWwCoo_flow_nominal( start=mChiWat_flow_nominal, final min=0) "Source fluid mass flow rate in cooling mode"; final parameter Modelica.Units.SI.MassFlowRate mSouCoo_flow_nominal= if typ==Buildings.Templates.Components.Types.HeatPump.WaterToWater then mSouWwCoo_flow_nominal else Buildings.Templates.Data.Defaults.mAirFloByCapChi * abs(capCoo_nominal) "Source fluid mass flow rate in cooling mode"; final parameter Modelica.Units.SI.PressureDifference dpSouCoo_nominal= dpSouHea_nominal * (mSouCoo_flow_nominal/mSouHea_flow_nominal)^2 "Source fluid pressure drop in cooling mode"; replaceable parameter Buildings.Fluid.HeatPumps.Data.EquationFitReversible.Generic perFit( dpHeaLoa_nominal=dpHeaWat_nominal, dpHeaSou_nominal=dpSouHea_nominal, hea( Q_flow=abs(capHea_nominal), P=0, mLoa_flow=mHeaWat_flow_nominal, mSou_flow=mSouHea_flow_nominal, coeQ={1,0,0,0,0}, coeP={1,0,0,0,0}, TRefLoa=THeaWatRet_nominal, TRefSou=TSouHea_nominal), coo( Q_flow=if is_rev then -abs(capCoo_nominal) else -1, P=0, mLoa_flow=mChiWat_flow_nominal, mSou_flow=mSouCoo_flow_nominal, coeQ={1,0,0,0,0}, coeP={1,0,0,0,0}, TRefLoa=TChiWatRet_nominal, TRefSou=TSouCoo_nominal)) constrainedby Buildings.Fluid.HeatPumps.Data.EquationFitReversible.Generic "Performance data - Equation fit model"; end HeatPump;

Buildings.Templates.Components.Data.PumpMultiple Buildings.Templates.Components.Data.PumpMultiple

Record for multiple-pump models

Information

This record provides the set of sizing and operating parameters for the multiple-pump model Buildings.Templates.Components.Pumps.Multiple.

A default flow characteristic is provided, which goes through the design operating point and spans over 0 and twice the design flow rate at maximum speed. This default characteristic is based on a least squares polynomial fit of the characteristics from Buildings.Fluid.Movers.Data.Pumps.Wilo. The user may refer to the documentation of Buildings.Fluid.HydronicConfigurations.UsersGuide.ModelParameters for further details. Note that a default medium density is used to parameterize the pump characteristic. So models that use this record should overwrite this default value with the density of the medium in use, especially in the case of a water/glycol mix.

In order to modify the default characteristic, one may use either of the following methods.

Those various use cases are illustrated in Buildings.Templates.Components.Validation.PumpMultipleRecord.

Extends from Modelica.Icons.Record (Icon for records).

Parameters

TypeNameDefaultDescription
Genericper[max(nPum, 1)]per(pressure(V_flow=if typ <...Performance data - Each pump
Densityrho_defaultModelica.Media.Water.Constan...Default medium density [kg/m3]
Configuration
Pumptyp Equipment type
IntegernPum Number of pumps
Nominal condition
MassFlowRatem_flow_nominal[nPum] Mass flow rate - Each pump [kg/s]
PressureDifferencedp_nominal[nPum] Total pressure rise - Each pump [Pa]

Modelica definition

record PumpMultiple "Record for multiple-pump models" extends Modelica.Icons.Record; parameter Buildings.Templates.Components.Types.Pump typ "Equipment type"; parameter Integer nPum( final min=0, start=0) "Number of pumps"; parameter Modelica.Units.SI.MassFlowRate m_flow_nominal[nPum]( each start=1, each final min=0) "Mass flow rate - Each pump"; parameter Modelica.Units.SI.PressureDifference dp_nominal[nPum]( each start=0, each final min=0) "Total pressure rise - Each pump"; // To avoid missing support for zero-sized record in case of nPum=0 we use max(nPum, 1). replaceable parameter Fluid.Movers.Data.Generic per[max(nPum, 1)]( pressure( V_flow=if typ<>Buildings.Templates.Components.Types.Pump.None then {{0, 1, 2} * m_flow_nominal[i] / rho_default for i in 1:nPum} else [0], dp=if typ<>Buildings.Templates.Components.Types.Pump.None then {{1.14, 1, 0.42} * dp_nominal[i] for i in 1:nPum} else [0])) constrainedby Buildings.Fluid.Movers.Data.Generic "Performance data - Each pump"; parameter Modelica.Units.SI.Density rho_default= Modelica.Media.Water.ConstantPropertyLiquidWater.d_const "Default medium density"; end PumpMultiple;

Buildings.Templates.Components.Data.PumpSingle Buildings.Templates.Components.Data.PumpSingle

Record for single pump model

Information

This record provides the set of sizing and operating parameters for the single pump model Buildings.Templates.Components.Pumps.Single.

A default flow characteristic is provided and can be overwritten as described in the documentation of Buildings.Templates.Components.Data.PumpMultiple in the more generic case of multiple units.

Extends from Modelica.Icons.Record (Icon for records).

Parameters

TypeNameDefaultDescription
Genericperper(pressure(V_flow={0,1,2}*...Performance data
Densityrho_defaultModelica.Media.Water.Constan...Default medium density [kg/m3]
Configuration
Pumptyp Equipment type
Nominal condition
MassFlowRatem_flow_nominal Mass flow rate [kg/s]
PressureDifferencedp_nominal Total pressure rise [Pa]

Modelica definition

record PumpSingle "Record for single pump model" extends Modelica.Icons.Record; parameter Buildings.Templates.Components.Types.Pump typ "Equipment type"; parameter Modelica.Units.SI.MassFlowRate m_flow_nominal( start=1, final min=0) "Mass flow rate"; parameter Modelica.Units.SI.PressureDifference dp_nominal( start=0, final min=0) "Total pressure rise"; replaceable parameter Buildings.Fluid.Movers.Data.Generic per( pressure( V_flow={0, 1, 2} * m_flow_nominal / rho_default, dp={1.14, 1, 0.42} * dp_nominal)) constrainedby Buildings.Fluid.Movers.Data.Generic "Performance data"; parameter Modelica.Units.SI.Density rho_default= Modelica.Media.Water.ConstantPropertyLiquidWater.d_const "Default medium density"; end PumpSingle;

Buildings.Templates.Components.Data.Valve Buildings.Templates.Components.Data.Valve

Record for valve model

Information

This record provides the set of sizing parameters for the class Buildings.Templates.Components.Actuators.Valve.

Extends from Modelica.Icons.Record (Icon for records).

Parameters

TypeNameDefaultDescription
Configuration
Valvetyp Equipment type
Nominal condition
MassFlowRatem_flow_nominal Nominal mass flow rate of fully open valve [kg/s]
PressureDifferencedpValve_nominal Nominal pressure drop of fully open valve [Pa]
PressureDifferencedpFixed_nominal0Nominal pressure drop of pipes and other equipment in flow leg [Pa]
PressureDifferencedpFixedByp_nominaldpFixed_nominalNominal pressure drop in the bypass line [Pa]

Modelica definition

record Valve "Record for valve model" extends Modelica.Icons.Record; parameter Buildings.Templates.Components.Types.Valve typ "Equipment type"; parameter Modelica.Units.SI.MassFlowRate m_flow_nominal( final min=0, start=1) "Nominal mass flow rate of fully open valve"; parameter Modelica.Units.SI.PressureDifference dpValve_nominal( final min=0, displayUnit="Pa", start=0) "Nominal pressure drop of fully open valve"; parameter Modelica.Units.SI.PressureDifference dpFixed_nominal( final min=0, displayUnit="Pa")=0 "Nominal pressure drop of pipes and other equipment in flow leg"; parameter Modelica.Units.SI.PressureDifference dpFixedByp_nominal( final min=0, displayUnit="Pa")=dpFixed_nominal "Nominal pressure drop in the bypass line"; end Valve;