Electric Load Center-Generator Specifications¶
32 object types from idfpy.models.electric_load · EnergyPlus 26.2
| Object | Summary |
|---|---|
| ElectricLoadCenter:Distribution | ElectricLoadCenter:Distribution objects are used to include on-site electricity generators and or storage in … |
| ElectricLoadCenter:Generators | List of electric power generators to include in the simulation including the name and type of each generators … |
| ElectricLoadCenter:Inverter:FunctionOfPower | Electric power inverter to convert from direct current (DC) to alternating current (AC) in an electric load … |
| ElectricLoadCenter:Inverter:LookUpTable | California Energy Commission tests and publishes data on inverters This inverter model interpolates using CEC … |
| ElectricLoadCenter:Inverter:PVWatts | Electric power inverter to convert from direct current (DC) to alternating current (AC) in an electric load … |
| ElectricLoadCenter:Inverter:Simple | Electric power inverter to convert from direct current (DC) to alternating current (AC) in an electric load … |
| ElectricLoadCenter:Storage:Battery | Uses the kinetic battery model (KiBaM) to simulate rechargeable battery banks in an electrical load center. |
| ElectricLoadCenter:Storage:Converter | This model is for converting AC to DC for grid-supplied charging of DC storage |
| ElectricLoadCenter:Storage:LiIonNMCBattery | Uses Lithium Ion NMC model to simulate rechargeable battery banks in an electrical load center. |
| ElectricLoadCenter:Storage:Simple | Used to model storage of electricity in an electric load center. |
| ElectricLoadCenter:Transformer | This object is used to model the energy losses of transformers when they are used to transfer electricity … |
| Generator:CombustionTurbine | This generator model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program. |
| Generator:FuelCell | This generator model is the FC model from IEA Annex 42 |
| Generator:FuelCell:AirSupply | Used to define details of the air supply subsystem for a fuel cell power generator. |
| Generator:FuelCell:AuxiliaryHeater | Intended for modeling an auxiliary heater for a fuel cell power generator, however this portion of the model … |
| Generator:FuelCell:ElectricalStorage | Used to describe the electrical storage subsystem for a fuel cell power generator. |
| Generator:FuelCell:ExhaustGasToWaterHeatExchanger | Describes the exhaust gas heat exchanger subsystem of a fuel cell power generator used to recovery thermal … |
| Generator:FuelCell:Inverter | Used to describe the power condition unit subsystem of a fuel cell power generator. |
| Generator:FuelCell:PowerModule | Describe the core power module subsystem of a fuel cell power generator. |
| Generator:FuelCell:StackCooler | This object is optional and is used to define details needed to model the stack cooler on PEMFC. |
| Generator:FuelCell:WaterSupply | Used to provide details of the water supply subsystem for a fuel cell power generator. |
| Generator:FuelSupply | Used only with Generator:FuelCell and Generator:MicroCHP |
| Generator:InternalCombustionEngine | This generator model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program. |
| Generator:MicroCHP | Small-scale combined heat and power (micro CHP) electric generator using the model developed by IEA/ECBCS … |
| Generator:MicroCHP:NonNormalizedParameters | This object is referenced by a Generator:MicroCHP object and provides the non-normalized parameters for the … |
| Generator:MicroTurbine | MicroTurbine generators are small combustion turbines (e.g., 25kW to 500kW). |
| Generator:PVWatts | Describes a simple set of inputs for an array of photovoltaic (PV) modules as described in the PVWatts … |
| Generator:Photovoltaic | Describes an array of photovoltaic (PV) modules. |
| Generator:WindTurbine | Wind turbine generator. |
| PhotovoltaicPerformance:EquivalentOne-Diode | Describes the performance characteristics of Photovoltaic (PV) modules to be modeled using an equivalent … |
| PhotovoltaicPerformance:Sandia | Describes performance input data needed for specific makes and models of production PV panels using the … |
| PhotovoltaicPerformance:Simple | Describes a simple model of photovoltaics that may be useful for early phase design analysis. |
ElectricLoadCenter:Distribution¶
from idfpy.models import ElectricLoadCenterDistribution
ElectricLoadCenter:Distribution objects are used to include on-site electricity generators and or storage in a simulation.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
generator_Generator List Name |
reference | Name of an ElectricLoadCenter:Generators object Names a ElectricLoadCenter:Generators |
|
generator_Generator Operation Scheme Type |
choice | Determines how generators are to be controlled Required if Generator List is entered. One of Baseload, DemandLimit, FollowThermal, FollowThermalLimitElectrical, TrackElectrical, TrackMeter, TrackSchedule |
|
generator_Generator Demand Limit Scheme Purchased Electric Demand Limit |
number W |
||
generator_Generator Track Schedule Name Scheme Schedule Name |
reference | required when Generator Operation Scheme Type=TrackSchedule schedule values in Watts Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
generator_Generator Track Meter Scheme Meter Name |
string | required when Generator Operation Scheme Type=TrackMeter | |
electrical_Electrical Buss Type |
choice | AlternatingCurrent |
One of AlternatingCurrent, AlternatingCurrentWithStorage, DirectCurrentWithInverter, DirectCurrentWithInverterACStorage, DirectCurrentWithInverterDCStorage |
inverter_Inverter Name |
reference | required when Electrical Buss Type=DirectCurrentWithInverter, DirectCurrentWithInverterDCStorage, or DirectCurrentWithInverterACStorage Names a ElectricLoadCenter:Inverter:FunctionOfPower, ElectricLoadCenter:Inverter:LookUpTable, ElectricLoadCenter:Inverter:PVWatts, ElectricLoadCenter:Inverter:Simple |
|
electrical_Electrical Storage Object Name |
reference | required when Electrical Buss Type=AlternatingCurrentWithStorage, DirectCurrentWithInverterDCStorage, or DirectCurrentWithInverterACStorage Names a ElectricLoadCenter:Storage:Battery, ElectricLoadCenter:Storage:LiIonNMCBattery, ElectricLoadCenter:Storage:Simple |
|
transformer_Transformer Object Name |
reference | required when power needs to be output from on-site generation or storage to the grid via transformer Names a ElectricLoadCenter:Transformer |
|
storage_Storage Operation Scheme |
choice | TrackFacilityElectricDemandStoreExcessOnSite |
Select method to govern how storage charge and discharge is controlled TrackFacilityElectricDemandStoreExcessOnSite indicates that storage control will follow the facility power demand while accounting for any on-site generation. Only excess on site generation gets stored (legacy behavior). TrackMeterDemandStoreExcessOnSite indicates that storage discharge control will follow an electric meter named in the field called Storage Control Track Meter Name. This scheme is similar to TrackFacilityElectricDemandStoreExcessOnSite except that instead of the main facility electric meter, the control is based off of a user-selected meter. TrackChargeDischargeSchedules indicates that control will follow the charging and discharging power and schedules defined in the fields called Maximum Storage Charge Grid Supply Power, Storage Charge Grid Supply Power Fraction Schedule Name, Design Storage Discharge Grid Export Power, and Storage Discharge Grid Export Fraction Schedule Name. FacilityDemandLeveling indicates that storage control will attempt to control the facility's power demand drawn from the utility service to a prescribed level. The target utility demand is entered in the fields called Storage Control Utility Demand Limit and Storage Control Utility Demand Limit Fraction Schedule Name This scheme first accounts for any on-site generation and during times of high use will discharge storage to reduce facility grid demand to meet the target level and during times of low use will charge storage from the grid to increase facility grid demand to meet the target level. One of FacilityDemandLeveling, TrackChargeDischargeSchedules, TrackFacilityElectricDemandStoreExcessOnSite, TrackMeterDemandStoreExcessOnSite |
storage_Storage Control Track Meter Name |
string | required when Storage Operation Scheme is set to TrackMeterDemandStoreExcessOnSite. | |
storage_Storage Converter Object Name |
reference | Name of an ElectricLoadCenter:Storage:Converter used to convert AC to DC when charging DC storage from grid supply. A converter is expected when using Storage Operation Schemes FacilityDemandLeveling or TrackChargeDischargeSchedules A single bidirectional device will reference both an inverter object (DC to AC) and a converter object (AC to DC). Names a ElectricLoadCenter:Storage:Converter |
|
maximum_Maximum Storage State of Charge Fraction |
number | 1.0 |
Fraction of storage capacity used as upper limit for controlling charging, for all storage operation schemes. |
minimum_Minimum Storage State of Charge Fraction |
number | 0.0 |
Fraction of storage capacity used as lower limit for controlling discharging, for all storage operation schemes. |
design_Design Storage Control Charge Power |
number W |
Maximum rate that electric power can be charged into storage. Storage charging adjusted downward for conversion losses. Rate is modified by fractional values in the schedule named in the next field. Required field when using Storage Operation Schemes FacilityDemandLeveling or TrackChargeDischargeSchedules. | |
storage_Storage Charge Power Fraction Schedule Name |
reference | Controls timing and magnitude of charging storage. Required field if Storage Operation Scheme is set to TrackChargeDischargeSchedules. Schedule values should be fractions from 0.0 to 1.0, inclusive. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
design_Design Storage Control Discharge Power |
number W |
Maximum rate that electric power can be discharged from storage. Rate is modified by fractional values in the schedule named in the next field. Required field when using Storage Operation Schemes FacilityDemandLeveling or TrackChargeDischargeSchedules. | |
storage_Storage Discharge Power Fraction Schedule Name |
reference | Controls timing and magnitude of discharging storage Required field if Storage Operation Scheme is set to TrackChargeDischargeSchedules. Schedule values should be fractions from 0.0 to 1.0, inclusive. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
storage_Storage Control Utility Demand Target |
number W |
Target utility service demand power for discharge control. Storage draws are adjusted upwards for conversion losses. Required field for FacilityDemandLeveling storage operation scheme | |
storage_Storage Control Utility Demand Target Fraction Schedule Name |
reference | Modifies the target utility service demand power over time. Schedule values should be fractions from -1.0 to 1.0, inclusive. if omitted a schedule value of 1.0 is used. Negative values indicate export to grid Schedule is used if Storage Operation Scheme is set to FacilityDemandLeveling. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
ElectricLoadCenter:Generators¶
from idfpy.models import ElectricLoadCenterGenerators extensible
List of electric power generators to include in the simulation including the name and type of each generators along with availability schedule, rated power output, and thermal-to-electrical power ratio.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
generator_ |
list | Each item: generator_name, generator_object_type, generator_rated_electric_power_output (W), generator_availability_schedule_name, generator_rated_thermal_to_electrical_power_ratio |
Referenced by 1 object types
ElectricLoadCenter:Inverter:FunctionOfPower¶
from idfpy.models import ElectricLoadCenterInverterFunctionOfPower
Electric power inverter to convert from direct current (DC) to alternating current (AC) in an electric load center that contains photovoltaic modules. This input object is for an inverter model where efficiency is a function of normalized power.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Name |
reference | Enter name of zone to receive inverter losses as heat if blank then inverter is assumed to be outdoors Names a Zone |
|
radiative_Radiative Fraction |
number | ||
efficiency_Efficiency Function of Power Curve Name |
reference | curve describes efficiency as a function of power curve is normalized relative to rated power in next field Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
rated_Rated Maximum Continuous Input Power |
number W |
||
minimum_Minimum Efficiency |
number | Range: ≥ 0, ≤ 1 | |
maximum_Maximum Efficiency |
number | Range: ≥ 0, ≤ 1 | |
minimum_Minimum Power Output |
number W |
||
maximum_Maximum Power Output |
number W |
||
ancillary_Ancillary Power Consumed In Standby |
number W |
Referenced by 1 object types
ElectricLoadCenter:Inverter:LookUpTable¶
from idfpy.models import ElectricLoadCenterInverterLookUpTable
California Energy Commission tests and publishes data on inverters This inverter model interpolates using CEC test data Input data are at http://www.gosolarcalifornia.org/equipment/inverter_tests/summaries
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Name |
reference | Enter name of zone to receive inverter losses as heat if blank then inverter is assumed to be outdoors Names a Zone |
|
radiative_Radiative Fraction |
number | Range: ≥ 0, ≤ 1 | |
rated_Rated Maximum Continuous Output Power |
number W |
||
night_Night Tare Loss Power |
number W |
||
nominal_Nominal Voltage Input |
number V |
||
efficiency_Efficiency at 10% Power and Nominal Voltage |
number | Range: ≥ 0, ≤ 1 | |
efficiency_Efficiency at 20% Power and Nominal Voltage |
number | Range: ≥ 0, ≤ 1 | |
efficiency_Efficiency at 30% Power and Nominal Voltage |
number | Range: ≥ 0, ≤ 1 | |
efficiency_Efficiency at 50% Power and Nominal Voltage |
number | Range: ≥ 0, ≤ 1 | |
efficiency_Efficiency at 75% Power and Nominal Voltage |
number | Range: ≥ 0, ≤ 1 | |
efficiency_Efficiency at 100% Power and Nominal Voltage |
number | Range: ≥ 0, ≤ 1 |
Referenced by 1 object types
ElectricLoadCenter:Inverter:PVWatts¶
from idfpy.models import ElectricLoadCenterInverterPVWatts
Electric power inverter to convert from direct current (DC) to alternating current (AC) in an electric load center that contains Generator:PVWatts objects. It implements the PVWatts inverter performance curves.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
dc_DC to AC Size Ratio |
number | 1.1 |
Range: > 0 |
inverter_Inverter Efficiency |
number | 0.96 |
Range: > 0, ≤ 1 |
Referenced by 1 object types
ElectricLoadCenter:Inverter:Simple¶
from idfpy.models import ElectricLoadCenterInverterSimple
Electric power inverter to convert from direct current (DC) to alternating current (AC) in an electric load center that contains photovoltaic modules. This input object is for the simplest inverter model and uses a fixed efficiency.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Name |
reference | enter name of zone to receive inverter losses as heat if blank then inverter is assumed to be outdoors Names a Zone |
|
radiative_Radiative Fraction |
number | Range: ≥ 0, ≤ 1 | |
inverter_Inverter Efficiency |
number | Range: ≥ 0, ≤ 1 |
Referenced by 1 object types
ElectricLoadCenter:Storage:Battery¶
from idfpy.models import ElectricLoadCenterStorageBattery
Uses the kinetic battery model (KiBaM) to simulate rechargeable battery banks in an electrical load center. The battery bank is a collection of one or more individual battery modules. Given the surplus or deficit power from the electrical system and the state of charge from the previous time step, this object can model the voltage, current, and energy losses with charging and discharging during each time step. The cumulative battery damage can be also modeled and reported at the end of each simulation run.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Name |
reference | Enter name of zone to receive electrical storage losses as heat if blank then electrical storage losses are dissipated to outdoors Names a Zone |
|
radiative_Radiative Fraction |
number | 0.0 |
Range: ≥ 0, ≤ 1 |
number_Number of Battery Modules in Parallel |
integer | 1 |
A module usually consists of several cells. The total number of modules in the battery bank is equal to number of modules in parallel times number of modules in series. Range: ≥ 1 |
number_Number of Battery Modules in Series |
integer | 1 |
A module usually consists of several cells. The total number of modules in the battery bank is equal to number of modules in parallel times number of modules in series. Range: ≥ 1 |
maximum_Maximum Module Capacity |
number Ah |
The capacity is for each module. A model parameter from manufacturer's data or test data. Range: ≥ 0 |
|
initial_Initial Fractional State of Charge |
number | 1.0 |
The state of charge is evaluated based on the maximum capacity defined in the next field. Range: ≥ 0, ≤ 1 |
fraction_Fraction of Available Charge Capacity |
number | A model parameter usually derived from test data by curve fitting. Range: ≥ 0, ≤ 1 |
|
change_Change Rate from Bound Charge to Available Charge |
number 1/hr |
A model parameter usually derived from test data by curve fitting. Range: ≥ 0 |
|
fully_Fully Charged Module Open Circuit Voltage |
number V |
The voltage is for each battery module. Range: ≥ 0 |
|
fully_Fully Discharged Module Open Circuit Voltage |
number V |
The voltage is for each battery module. Range: ≥ 0 |
|
voltage_Voltage Change Curve Name for Charging |
reference | Determines how the open circuit voltage change with state of charge relative to the fully discharged state. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
voltage_Voltage Change Curve Name for Discharging |
reference | Determines how the open circuit voltage change with state of charge relative to the fully charged state. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
module_Module Internal Electrical Resistance |
number ohms |
A model parameter from manufacture or derived from test data. Internal resistance is assumed to be constant. The internal resistance is for each battery module. Range: ≥ 0 |
|
maximum_Maximum Module Discharging Current |
number A |
The constraint on discharging current is for each battery module. Range: ≥ 0 |
|
module_Module Cut-off Voltage |
number V |
The voltage constraint is for each battery module. Range: ≥ 0 |
|
module_Module Charge Rate Limit |
number | 1.0 |
units 1/hr Charge rate limit is the division between charging current the remaining capacity. The constraint on charging current is for each module. Range: ≥ 0 |
battery_Battery Life Calculation |
choice | No |
One of No, Yes |
number_Number of Cycle Bins |
integer | 10 |
Only required when battery life calculation is activated Range: ≥ 5 |
battery_Battery Life Curve Name |
reference | Determines the number of cycles to failure in relation to cycle range. Only required when battery life calculation is activated. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
Referenced by 1 object types
ElectricLoadCenter:Storage:Converter¶
from idfpy.models import ElectricLoadCenterStorageConverter
This model is for converting AC to DC for grid-supplied charging of DC storage
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the converter is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
power_Power Conversion Efficiency Method |
choice | SimpleFixed |
SimpleFixed indicates power conversion losses are based on Simple Fixed Efficiency FunctionOfPower indicates power conversion losses are a function of normalized power using a curve or table. One of FunctionOfPower, SimpleFixed |
simple_Simple Fixed Efficiency |
number | 0.95 |
Constant efficiency for conversion of AC to DC at all power levels. Field is only used when Power Conversion Efficiency Method is set to SimpleFixed. Range: > 0, ≤ 1 |
design_Design Maximum Continuous Input Power |
number W |
Required field when Power Conversion Efficiency Method is set to FunctionOfPower. | |
efficiency_Efficiency Function of Power Curve Name |
reference | Curve or table with a single independent variable that describes efficiency as a function of normalized power. The "x" input for curve or table is the ratio of current input power divided by design power in the previous field Required field when Power Conversion Efficiency Method is set to FunctionOfPower. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
ancillary_Ancillary Power Consumed In Standby |
number W |
Optional standby power consumed when converter is available but no power is being conditioned. | |
zone_Zone Name |
reference | enter name of zone to receive converter losses as heat if blank then converter is assumed to be outdoors Names a Zone |
|
radiative_Radiative Fraction |
number | fraction of zone heat gains treated as thermal radiation Range: ≥ 0, ≤ 1 |
Referenced by 1 object types
ElectricLoadCenter:Storage:LiIonNMCBattery¶
from idfpy.models import ElectricLoadCenterStorageLiIonNMCBattery
Uses Lithium Ion NMC model to simulate rechargeable battery banks in an electrical load center. The battery bank is a collection of one or more individual battery modules. Given the surplus or deficit power from the electrical system and the state of charge from the previous time step, this object can model the voltage, current, and energy losses with charging and discharging during each time step. The cumulative battery damage can be also modeled and reported at the end of each simulation run.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Name |
reference | Enter name of zone to receive electrical storage losses as heat if blank then electrical storage losses are dissipated to outdoors Names a Zone |
|
radiative_Radiative Fraction |
number | 0.0 |
Range: ≥ 0, ≤ 1 |
lifetime_Lifetime Model |
choice | KandlerSmith |
One of KandlerSmith, None |
number_Number of Cells in Series required |
integer | Battery voltage is calculated by multiplying this field by the nominal cell voltage (Numeric Field 13, default 3.342V) Range: ≥ 1 |
|
number_Number of Strings in Parallel required |
integer | Capacity (Ah) is determined by multiplying this field by the cell capacity (Numeric Field 14, default 3.2 Ah) Range: ≥ 1 |
|
initial_Initial Fractional State of Charge |
number | 0.5 |
The state of charge is evaluated based on the maximum capacity defined in the next field. Range: ≥ 0, ≤ 1 |
dc_DC to DC Charging Efficiency |
number | 0.95 |
Range: > 0, ≤ 1 |
battery_Battery Mass required |
number kg |
Range: > 0 | |
battery_Battery Surface Area required |
number m2 |
Range: > 0 | |
battery_Battery Specific Heat Capacity |
number J/kg-K |
1500.0 |
Range: > 0 |
heat_Heat Transfer Coefficient Between Battery and Ambient |
number W/m2-K |
7.5 |
Range: > 0 |
fully_Fully Charged Cell Voltage |
number V |
4.2 |
Most users should not need to change this value. Range: > 0 |
cell_Cell Voltage at End of Exponential Zone |
number V |
3.53 |
Most users should not need to change this value. Range: > 0 |
cell_Cell Voltage at End of Nominal Zone |
number V |
3.342 |
Most users should not need to change this value. Range: > 0 |
default_Default Nominal Cell Voltage |
number V |
3.342 |
Most users should not need to change this value. Range: > 0 |
fully_Fully Charged Cell Capacity |
number Ah |
3.2 |
Most users should not need to change this value. Range: > 0 |
fraction_Fraction of Cell Capacity Removed at the End of Exponential Zone |
number | 0.8075 |
Most users should not need to change this value. Range: > 0, < 1 |
fraction_Fraction of Cell Capacity Removed at the End of Nominal Zone |
number | 0.976875 |
Most users should not need to change this value. Range: > 0, < 1 |
charge_Charge Rate at Which Voltage vs Capacity Curve Was Generated |
number | 1.0 |
Most users should not need to change this value. Range: > 0 |
battery_Battery Cell Internal Electrical Resistance |
number ohms |
0.09 |
for a single cell Most users should not need to change this value. Range: ≥ 0 |
Referenced by 1 object types
ElectricLoadCenter:Storage:Simple¶
from idfpy.models import ElectricLoadCenterStorageSimple
Used to model storage of electricity in an electric load center. This is a simple model that does not attempt to represent any of the characteristics of a real storage device such as a battery. The type of power, AC or DC, depends on the configuration chosen as the Electrical Buss Type in the ElectricLoadCenter:Distribution object.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Name |
reference | Enter name of zone to receive storage losses as heat if blank then storage is assumed to be outdoors Names a Zone |
|
radiative_Radiative Fraction for Zone Heat Gains |
number | Range: ≥ 0, ≤ 1 | |
nominal_Nominal Energetic Efficiency for Charging |
number | Range: ≥ 0.001, ≤ 1 | |
nominal_Nominal Discharging Energetic Efficiency |
number | Range: ≥ 0.001, ≤ 1 | |
maximum_Maximum Storage Capacity |
number J |
||
maximum_Maximum Power for Discharging |
number W |
||
maximum_Maximum Power for Charging |
number W |
||
initial_Initial State of Charge |
number J |
Referenced by 1 object types
ElectricLoadCenter:Transformer¶
from idfpy.models import ElectricLoadCenterTransformer extensible
This object is used to model the energy losses of transformers when they are used to transfer electricity from the grid to a building (as distribution transformers) or transfer electricity from onsite generators to the grid.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
transformer_Transformer Usage |
choice | PowerInFromGrid |
A transformer can be used to transfer electric energy from utility grid to building (PowerInFromGrid)or from building on-site generation to the grid (PowerOutToGrid) or within a load center to match generation to the facility service main panel (LoadCenterPowerConditioning) One of LoadCenterPowerConditioning, PowerInFromGrid, PowerOutToGrid |
zone_Zone Name |
reference | Enter name of zone to receive transformer losses as heat if blank then transformer losses are dissipated to outdoors Names a Zone |
|
radiative_Radiative Fraction |
number | 0.0 |
Range: ≥ 0, ≤ 1 |
rated_Rated Capacity |
number VA |
the unit is VA, instead of kVA as usually shown on transformer nameplates. Range: ≥ 0 |
|
phasePhase |
1 or 3 |
3.0 |
Must be single or three phase transformer. NOT used in the current model. |
conductor_Conductor Material |
choice | Aluminum |
Winding material used by the transformer. One of Aluminum, Copper |
full_Full Load Temperature Rise |
number C |
150.0 |
Range: ≥ 50, ≤ 180 |
fraction_Fraction of Eddy Current Losses |
number | 0.1 |
Range: ≥ 0, ≤ 1 |
performance_Performance Input Method |
choice | RatedLosses |
User can define transformer performance by specifying load and no load losses at rated conditions or nameplate efficiency and maximum efficiency One of NominalEfficiency, RatedLosses |
rated_Rated No Load Loss |
number W |
Only required when RatedLosses is the performance input method Range: > 0 |
|
rated_Rated Load Loss |
number W |
Only required when RatedLosses is the performance input method Range: ≥ 0 |
|
nameplate_Nameplate Efficiency |
number | 0.98 |
Only required when NominalEfficiency is the performance input method Range: > 0, ≤ 1 |
per_Per Unit Load for Nameplate Efficiency |
number | 0.35 |
Percentage of the rated capacity at which the nameplate efficiency is defined Only required when NominalEfficiency is the performance input method Range: > 0, ≤ 1 |
reference_Reference Temperature for Nameplate Efficiency |
number C |
75.0 |
Conductor operating temperature at which the nameplate efficiency is defined Only required when NominalEfficiency is the performance input method Range: ≥ 20, ≤ 150 |
per_Per Unit Load for Maximum Efficiency |
number | Percentage of the rate capacity at which the maximum efficiency is obtained Only required when NominalEfficiency is the performance input method Range: > 0, ≤ 1 |
|
consider_Consider Transformer Loss for Utility Cost |
choice | Yes |
Only required when the transformer is used for power in from the utility grid One of No, Yes |
meters |
list | Each item: meter_name |
Referenced by 1 object types
Generator:CombustionTurbine¶
from idfpy.models import GeneratorCombustionTurbine
This generator model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Generator performance curves are generated by fitting catalog data to second order polynomial equations. Three sets of coefficients are required.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
rated_Rated Power Output |
number W |
||
electric_Electric Circuit Node Name |
string | ||
minimum_Minimum Part Load Ratio |
number | Range: ≥ 0, ≤ 1 | |
maximum_Maximum Part Load Ratio |
number | Range: > 0, ≤ 1 | |
optimum_Optimum Part Load Ratio |
number | ||
part_Part Load Based Fuel Input Curve Name |
reference | curve = a + b*PLR + c*PLR**2 PLR = Ratio of Generator Load to Rated Power Output this curve is multiplied to the Temperature Based Fuel Input Curve to determine Fuel Energy In Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
temperature_Temperature Based Fuel Input Curve Name |
reference | curve = a + b*AT + c*AT**2 AT = Ambient Delta T this curve is multiplied to the Part Load Based Fuel Input Curve to determine Fuel Energy In Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
exhaust_Exhaust Flow Curve Name |
reference | curve = a + b*AT + c*AT**2 AT = Ambient Delta T Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
part_Part Load Based Exhaust Temperature Curve Name |
reference | curve = a + b*PLR + c*PLR**2 PLR = Ratio of Generator Load to Rated Power Output this curve is multiplied to the Temperature Based Exhaust Temperature Curve to determine Exhaust Temperature Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
temperature_Temperature Based Exhaust Temperature Curve Name |
reference | curve = a + b*AT + c*AT**2 AT = Ambient Delta T this curve is multiplied to the Part Load Based Exhaust Temperature Curve to determine Exhaust Temperature Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
heat_Heat Recovery Lube Energy Curve Name |
reference | curve = a + b*PLR + c*PLR**2 PLR = Ratio of Generator Load to Rated Power Output Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
coefficient_Coefficient 1 of U-Factor Times Area Curve |
number | curve = C1 * Rated Power Output**C2 | |
coefficient_Coefficient 2 of U-Factor Times Area Curve |
number | curve = C1 * Rated Power Output**C2 typical value .9 Range: ≤ 2 |
|
maximum_Maximum Exhaust Flow per Unit of Power Output |
number (kg/s)/W |
||
design_Design Minimum Exhaust Temperature |
number C |
||
design_Design Air Inlet Temperature |
number C |
||
fuel_Fuel Higher Heating Value |
number kJ/kg |
||
design_Design Heat Recovery Water Flow Rate |
number m3/s |
0.0 |
if non-zero, then inlet, outlet nodes must be entered. Range: ≥ 0 |
heat_Heat Recovery Inlet Node Name |
string | ||
heat_Heat Recovery Outlet Node Name |
string | ||
fuel_Fuel Type |
choice | NaturalGas |
One of Coal, Diesel, FuelOilNo1, FuelOilNo2, Gasoline, NaturalGas, OtherFuel1, OtherFuel2, Propane |
heat_Heat Recovery Maximum Temperature |
number C |
80.0 |
Range: ≥ 0, ≤ 100 |
outdoor_Outdoor Air Inlet Node Name |
string | Enter the name of an outdoor air node |
Referenced by 3 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, ElectricLoadCenter:Generators
Generator:FuelCell¶
from idfpy.models import GeneratorFuelCell
This generator model is the FC model from IEA Annex 42
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
power_Power Module Name required |
reference | Enter the name of a Generator:FuelCell:PowerModule object. Names a Generator:FuelCell:PowerModule |
|
air_Air Supply Name required |
reference | Enter the name of a Generator:FuelCell:AirSupply object. Names a Generator:FuelCell:AirSupply |
|
fuel_Fuel Supply Name required |
reference | Enter the name of a Generator:FuelSupply object. Names a Generator:FuelSupply |
|
water_Water Supply Name required |
reference | Enter the name of a Generator:FuelCell:WaterSupply object. Names a Generator:FuelCell:WaterSupply |
|
auxiliary_Auxiliary Heater Name required |
reference | Enter the name of a Generator:FuelCell:AuxiliaryHeater object. Names a Generator:FuelCell:AuxiliaryHeater |
|
heat_Heat Exchanger Name required |
reference | Enter the name of a Generator:FuelCell:ExhaustGasToWaterHeatExchanger object. Names a Generator:FuelCell:ExhaustGasToWaterHeatExchanger |
|
electrical_Electrical Storage Name required |
reference | Enter the name of a Generator:FuelCell:ElectricalStorage object. Names a Generator:FuelCell:ElectricalStorage |
|
inverter_Inverter Name required |
reference | Enter the name of a Generator:FuelCell:Inverter object. Names a Generator:FuelCell:Inverter |
|
stack_Stack Cooler Name |
reference | Enter the name of a Generator:FuelCell:StackCooler object. optional, used for PEMFC Names a Generator:FuelCell:StackCooler |
Referenced by 1 object types
Generator:FuelCell:AirSupply¶
from idfpy.models import GeneratorFuelCellAirSupply extensible
Used to define details of the air supply subsystem for a fuel cell power generator.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
air_Air Inlet Node Name |
string | ||
blower_Blower Power Curve Name |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more | |
blower_Blower Heat Loss Factor |
number | Range: ≥ 0, ≤ 1 | |
air_Air Supply Rate Calculation Mode required |
choice | One of AirRatiobyStoics, QuadraticFunctionofElectricPower, QuadraticFunctionofFuelRate |
|
stoichiometric_Stoichiometric Ratio |
number | This is the excess air "stoics" the value entered is incremented by 1 in the model. | |
air_Air Rate Function of Electric Power Curve Name |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more | |
air_Air Rate Air Temperature Coefficient |
number | ||
air_Air Rate Function of Fuel Rate Curve Name |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more | |
air_Air Intake Heat Recovery Mode required |
choice | One of NoRecovery, RecoverAuxiliaryBurner, RecoverBurnerInverterStorage, RecoverElectricalStorage, RecoverInverter, RecoverInverterandStorage |
|
air_Air Supply Constituent Mode required |
choice | One of AmbientAir, UserDefinedConstituents |
|
number_Number of UserDefined Constituents |
number | Range: ≤ 5 | |
constituent_ |
list | Each item: constituent_name, molar_fraction |
Referenced by 1 object types
Generator:FuelCell:AuxiliaryHeater¶
from idfpy.models import GeneratorFuelCellAuxiliaryHeater
Intended for modeling an auxiliary heater for a fuel cell power generator, however this portion of the model is not yet available. The program still requires one of these objects be included even though the data are not yet used (so that internal data structures can be allocated).
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
excess_Excess Air Ratio |
number | ||
ancillary_Ancillary Power Constant Term |
number | ||
ancillary_Ancillary Power Linear Term |
number | ||
skin_Skin Loss U-Factor Times Area Value |
number W/K |
||
skin_Skin Loss Destination |
choice | One of AirInletForFuelCell, SurroundingZone |
|
zone_Zone Name to Receive Skin Losses |
reference | Names a Zone | |
heating_Heating Capacity Units |
choice | One of Watts, kmol/s |
|
maximum_Maximum Heating Capacity in Watts |
number W |
||
minimum_Minimum Heating Capacity in Watts |
number W |
||
maximum_Maximum Heating Capacity in Kmol per Second |
number kmol/s |
||
minimum_Minimum Heating Capacity in Kmol per Second |
number kmol/s |
Referenced by 1 object types
Generator:FuelCell:ElectricalStorage¶
from idfpy.models import GeneratorFuelCellElectricalStorage
Used to describe the electrical storage subsystem for a fuel cell power generator. The electrical storage model is a very simple "constrained bucket" model. Note that this electrical storage is embedded within the FC device.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
choice_Choice of Model |
choice | One of SimpleEfficiencyWithConstraints |
|
nominal_Nominal Charging Energetic Efficiency |
number | Range: ≥ 0, ≤ 1 | |
nominal_Nominal Discharging Energetic Efficiency |
number | Range: ≥ 0, ≤ 1 | |
simple_Simple Maximum Capacity |
number J |
||
simple_Simple Maximum Power Draw |
number W |
||
simple_Simple Maximum Power Store |
number W |
||
initial_Initial Charge State |
number J |
Referenced by 1 object types
Generator:FuelCell:ExhaustGasToWaterHeatExchanger¶
from idfpy.models import GeneratorFuelCellExhaustGasToWaterHeatExchanger
Describes the exhaust gas heat exchanger subsystem of a fuel cell power generator used to recovery thermal energy
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
heat_Heat Recovery Water Inlet Node Name |
string | ||
heat_Heat Recovery Water Outlet Node Name |
string | ||
heat_Heat Recovery Water Maximum Flow Rate |
number m3/s |
||
exhaust_Exhaust Outlet Air Node Name |
string | ||
heat_Heat Exchanger Calculation Method |
choice | One of Condensing, EmpiricalUAeff, FixedEffectiveness, FundementalUAeff |
|
method_Method 1 Heat Exchanger Effectiveness |
number | ||
method_Method 2 Parameter hxs0 |
number | ||
method_Method 2 Parameter hxs1 |
number | ||
method_Method 2 Parameter hxs2 |
number | ||
method_Method 2 Parameter hxs3 |
number | ||
method_Method 2 Parameter hxs4 |
number | ||
method_Method 3 h0Gas Coefficient |
number | ||
method_Method 3 NdotGasRef Coefficient |
number | ||
method_Method 3 n Coefficient |
number | ||
method_Method 3 Gas Area |
number m2 |
||
method_Method 3 h0 Water Coefficient |
number | ||
method_Method 3 N dot Water ref Coefficient |
number | ||
method_Method 3 m Coefficient |
number | ||
method_Method 3 Water Area |
number m2 |
||
method_Method 3 F Adjustment Factor |
number | ||
method_Method 4 hxl1 Coefficient |
number | ||
method_Method 4 hxl2 Coefficient |
number | ||
method_Method 4 Condensation Threshold |
number C |
Referenced by 4 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, Generator:FuelCell, PlantEquipmentList
Generator:FuelCell:Inverter¶
from idfpy.models import GeneratorFuelCellInverter
Used to describe the power condition unit subsystem of a fuel cell power generator. This object models an inverter system contained within a fuel cell system that converts from direct current (DC) to alternating current (AC).
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
inverter_Inverter Efficiency Calculation Mode |
choice | One of Constant, Quadratic |
|
inverter_Inverter Efficiency |
number | Range: ≥ 0, ≤ 1 | |
efficiency_Efficiency Function of DC Power Curve Name |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
Referenced by 1 object types
Generator:FuelCell:PowerModule¶
from idfpy.models import GeneratorFuelCellPowerModule
Describe the core power module subsystem of a fuel cell power generator. This includes the fuel cell stack, fuel reformer, and whatever ancillary devices are included inside. If the model has multiple FC generators that are of the exact same type, then only one of these objects is needed and all the Generator:FuelCell objects can reference it.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
efficiency_Efficiency Curve Mode |
choice | One of Annex42, Normalized |
|
efficiency_Efficiency Curve Name required |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more | |
nominal_Nominal Efficiency |
number | This field is not used. | |
nominal_Nominal Electrical Power |
number W |
This field is not used | |
number_Number of Stops at Start of Simulation |
number | this is Nstops in SOFC model specification | |
cycling_Cycling Performance Degradation Coefficient |
number | this is D in SOFC model specification | |
number_Number of Run Hours at Beginning of Simulation |
number hr |
||
accumulated_Accumulated Run Time Degradation Coefficient |
number | this is L in SOFC model specification | |
run_Run Time Degradation Initiation Time Threshold |
number hr |
||
power_Power Up Transient Limit |
number W/s |
Maximum rate of change in electrical output [power increasing] | |
power_Power Down Transient Limit |
number W/s |
Maximum rate of change in electrical output [power decreasing] Enter positive value for rate of change | |
start_Start Up Time |
number s |
Time from start up to normal operation | |
start_Start Up Fuel |
number kmol |
||
start_Start Up Electricity Consumption |
number J |
||
start_Start Up Electricity Produced |
number J |
||
shut_Shut Down Time |
number s |
||
shut_Shut Down Fuel |
number kmol |
||
shut_Shut Down Electricity Consumption |
number J |
||
ancillary_Ancillary Electricity Constant Term |
number | ||
ancillary_Ancillary Electricity Linear Term |
number | ||
skin_Skin Loss Calculation Mode |
choice | One of ConstantRate, QuadraticFunctionOfFuelRate, UAForProcessGasTemperature |
|
zone_Zone Name |
reference | Names a Zone | |
skin_Skin Loss Radiative Fraction |
number | Range: ≥ 0, ≤ 1 | |
constant_Constant Skin Loss Rate |
number W |
||
skin_Skin Loss U-Factor Times Area Term |
number W/K |
||
skin_Skin Loss Quadratic Curve Name |
reference | curve is function of fuel use rate Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
dilution_Dilution Air Flow Rate |
number kmol/s |
||
stack_Stack Heat loss to Dilution Air |
number W |
||
dilution_Dilution Inlet Air Node Name |
string | ||
dilution_Dilution Outlet Air Node Name |
string | ||
minimum_Minimum Operating Point |
number W |
||
maximum_Maximum Operating Point |
number W |
Referenced by 1 object types
Generator:FuelCell:StackCooler¶
from idfpy.models import GeneratorFuelCellStackCooler
This object is optional and is used to define details needed to model the stack cooler on PEMFC.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
heat_Heat Recovery Water Inlet Node Name |
string | ||
heat_Heat Recovery Water Outlet Node Name |
string | ||
nominal_Nominal Stack Temperature |
number C |
||
actual_Actual Stack Temperature |
number C |
||
coefficient_Coefficient r0 |
number | ||
coefficient_Coefficient r1 |
number | ||
coefficient_Coefficient r2 |
number | ||
coefficient_Coefficient r3 |
number | ||
stack_Stack Coolant Flow Rate |
number kg/s |
||
stack_Stack Cooler U-Factor Times Area Value |
number W/K |
||
fs_Fs-cogen Adjustment Factor |
number | ||
stack_Stack Cogeneration Exchanger Area |
number m2 |
||
stack_Stack Cogeneration Exchanger Nominal Flow Rate |
number kg/s |
||
stack_Stack Cogeneration Exchanger Nominal Heat Transfer Coefficient |
number W/m2-K |
||
stack_Stack Cogeneration Exchanger Nominal Heat Transfer Coefficient Exponent |
number | ||
stack_Stack Cooler Pump Power |
number W |
||
stack_Stack Cooler Pump Heat Loss Fraction |
number | Range: ≥ 0, ≤ 1 | |
stack_Stack Air Cooler Fan Coefficient f0 |
number | ||
stack_Stack Air Cooler Fan Coefficient f1 |
number | ||
stack_Stack Air Cooler Fan Coefficient f2 |
number |
Referenced by 3 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, Generator:FuelCell
Generator:FuelCell:WaterSupply¶
from idfpy.models import GeneratorFuelCellWaterSupply
Used to provide details of the water supply subsystem for a fuel cell power generator. This water is used for steam reforming of the fuel and is not the same as the water used for thermal heat recovery.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
reformer_Reformer Water Flow Rate Function of Fuel Rate Curve Name |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more | |
reformer_Reformer Water Pump Power Function of Fuel Rate Curve Name |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more | |
pump_Pump Heat Loss Factor |
number | ||
water_Water Temperature Modeling Mode |
choice | One of MainsWaterTemperature, TemperatureFromAirNode, TemperatureFromSchedule, TemperatureFromWaterNode |
|
water_Water Temperature Reference Node Name |
string | ||
water_Water Temperature Schedule Name |
reference | Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
Referenced by 1 object types
Generator:FuelSupply¶
from idfpy.models import GeneratorFuelSupply
Used only with Generator:FuelCell and Generator:MicroCHP
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
fuel_Fuel Temperature Modeling Mode |
choice | One of Scheduled, TemperatureFromAirNode |
|
fuel_Fuel Temperature Reference Node Name |
string | ||
fuel_Fuel Temperature Schedule Name |
reference | Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules | |
compressor_Compressor Power Multiplier Function of Fuel Rate Curve Name |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more | |
compressor_Compressor Heat Loss Factor |
number | Range: ≥ 0, ≤ 1 | |
fuel_Fuel Type |
choice | One of GaseousConstituents, LiquidGeneric |
|
liquid_Liquid Generic Fuel Lower Heating Value |
number kJ/kg |
||
liquid_Liquid Generic Fuel Higher Heating Value |
number kJ/kg |
||
liquid_Liquid Generic Fuel Molecular Weight |
number g/mol |
||
liquid_Liquid Generic Fuel CO2 Emission Factor |
number | ||
number_Number of Constituents in Gaseous Constituent Fuel Supply |
number | Range: ≥ 0, ≤ 12 | |
constituent_Constituent 1 Name |
choice | One of Argon, Butane, CarbonDioxide, Ethane, Ethanol, Hexane, Hydrogen, Methane, Methanol, Nitrogen, Oxygen, Pentane, Propane, Water |
|
constituent_Constituent 1 Molar Fraction |
number | Range: ≥ 0, ≤ 1 | |
constituent_Constituent 2 Name |
choice | One of Argon, Butane, CarbonDioxide, Ethane, Ethanol, Hexane, Hydrogen, Methane, Methanol, Nitrogen, Oxygen, Pentane, Propane, Water |
|
constituent_Constituent 2 Molar Fraction |
number | Range: ≥ 0, ≤ 1 | |
constituent_Constituent 3 Name |
choice | One of Argon, Butane, CarbonDioxide, Ethane, Ethanol, Hexane, Hydrogen, Methane, Methanol, Nitrogen, Oxygen, Pentane, Propane, Water |
|
constituent_Constituent 3 Molar Fraction |
number | Range: ≥ 0, ≤ 1 | |
constituent_Constituent 4 Name |
choice | One of Argon, Butane, CarbonDioxide, Ethane, Ethanol, Hexane, Hydrogen, Methane, Methanol, Nitrogen, Oxygen, Pentane, Propane, Water |
|
constituent_Constituent 4 Molar Fraction |
number | Range: ≥ 0, ≤ 1 | |
constituent_Constituent 5 Name |
choice | One of Argon, Butane, CarbonDioxide, Ethane, Ethanol, Hexane, Hydrogen, Methane, Methanol, Nitrogen, Oxygen, Pentane, Propane, Water |
|
constituent_Constituent 5 Molar Fraction |
number | Range: ≥ 0, ≤ 1 | |
constituent_Constituent 6 Name |
choice | One of Argon, Butane, CarbonDioxide, Ethane, Ethanol, Hexane, Hydrogen, Methane, Methanol, Nitrogen, Oxygen, Pentane, Propane, Water |
|
constituent_Constituent 6 Molar Fraction |
number | Range: ≥ 0, ≤ 1 | |
constituent_Constituent 7 Name |
choice | One of Butane, Ethane, Ethanol, Hexane, Hydrogen, Methane, Methanol, Pentane, Propane |
|
constituent_Constituent 7 Molar Fraction |
number | Range: ≥ 0, ≤ 1 | |
constituent_Constituent 8 Name |
choice | One of Argon, Butane, CarbonDioxide, Ethane, Ethanol, Hexane, Hydrogen, Methane, Methanol, Nitrogen, Oxygen, Pentane, Propane, Water |
|
constituent_Constituent 8 Molar Fraction |
number | Range: ≥ 0, ≤ 1 | |
constituent_Constituent 9 Name |
choice | One of Argon, Butane, CarbonDioxide, Ethane, Ethanol, Hexane, Hydrogen, Methane, Methanol, Nitrogen, Oxygen, Pentane, Propane, Water |
|
constituent_Constituent 9 Molar Fraction |
number | Range: ≥ 0, ≤ 1 | |
constituent_Constituent 10 Name |
choice | One of Argon, Butane, CarbonDioxide, Ethane, Ethanol, Hexane, Hydrogen, Methane, Methanol, Nitrogen, Oxygen, Pentane, Propane, Water |
|
constituent_Constituent 10 Molar Fraction |
number | Range: ≥ 0, ≤ 1 | |
constituent_Constituent 11 Name |
choice | One of Argon, Butane, CarbonDioxide, Ethane, Ethanol, Hexane, Hydrogen, Methane, Methanol, Nitrogen, Oxygen, Pentane, Propane, Water |
|
constituent_Constituent 11 Molar Fraction |
number | Range: ≥ 0, ≤ 1 | |
constituent_Constituent 12 Name |
choice | One of Argon, Butane, CarbonDioxide, Ethane, Ethanol, Hexane, Hydrogen, Methane, Methanol, Nitrogen, Oxygen, Pentane, Propane, Water |
|
constituent_Constituent 12 Molar Fraction |
number | Range: ≥ 0, ≤ 1 |
Referenced by 2 object types
Generator:InternalCombustionEngine¶
from idfpy.models import GeneratorInternalCombustionEngine
This generator model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Engine performance curves are generated by fitting catalog data to second order polynomial equations. Three sets of coefficients are required.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
rated_Rated Power Output |
number W |
||
electric_Electric Circuit Node Name |
string | ||
minimum_Minimum Part Load Ratio |
number | Range: ≥ 0, ≤ 1 | |
maximum_Maximum Part Load Ratio |
number | Range: > 0, ≤ 1 | |
optimum_Optimum Part Load Ratio |
number | ||
shaft_Shaft Power Curve Name |
reference | curve = a + b*PLR + c*PLR**2 PLR = Ratio of Generator Load to Rated Power Output Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
jacket_Jacket Heat Recovery Curve Name |
reference | curve = a + b*PLR + c*PLR**2 PLR = Ratio of Generator Load to Rated Power Output Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
lube_Lube Heat Recovery Curve Name |
reference | curve = a + b*PLR + c*PLR**2 PLR = Ratio of Generator Load to Rated Power Output Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
total_Total Exhaust Energy Curve Name |
reference | curve = a + b*PLR + c*PLR**2 PLR = Ratio of Generator Load to Rated Power Output Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
exhaust_Exhaust Temperature Curve Name |
reference | curve = a + b*PLR + c*PLR**2 PLR = Ratio of Generator Load to Rated Power Output Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
coefficient_Coefficient 1 of U-Factor Times Area Curve |
number | curve = C1 * Generator Rated Power Output**C2 | |
coefficient_Coefficient 2 of U-Factor Times Area Curve |
number | curve = C1 * Generator Rated Power Output**C2 typical value .9 Range: ≤ 2 |
|
maximum_Maximum Exhaust Flow per Unit of Power Output |
number (kg/s)/W |
||
design_Design Minimum Exhaust Temperature |
number C |
||
fuel_Fuel Higher Heating Value |
number kJ/kg |
||
design_Design Heat Recovery Water Flow Rate |
number m3/s |
0.0 |
if non-zero, then inlet, outlet nodes must be entered. Range: ≥ 0 |
heat_Heat Recovery Inlet Node Name |
string | ||
heat_Heat Recovery Outlet Node Name |
string | ||
fuel_Fuel Type |
choice | Diesel |
One of Diesel, FuelOilNo1, FuelOilNo2, Gasoline, NaturalGas, OtherFuel1, OtherFuel2, Propane |
heat_Heat Recovery Maximum Temperature |
number C |
80.0 |
Range: ≥ 0, ≤ 100 |
Referenced by 3 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, ElectricLoadCenter:Generators
Generator:MicroCHP¶
from idfpy.models import GeneratorMicroCHP
Small-scale combined heat and power (micro CHP) electric generator using the model developed by IEA/ECBCS Annex 42 see www.cogen-sim.net. The model was developed for both internal combustion and Stirling cycle engines, but might be used for other types of residential CHP devices.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
performance_Performance Parameters Name |
reference | Enter the name of a Generator:MicroCHP:NonNormalizedParameters object. Names a Generator:MicroCHP:NonNormalizedParameters |
|
zone_Zone Name |
reference | Names a Zone | |
cooling_Cooling Water Inlet Node Name |
string | ||
cooling_Cooling Water Outlet Node Name |
string | ||
air_Air Inlet Node Name |
string | ||
air_Air Outlet Node Name |
string | ||
generator_Generator Fuel Supply Name |
reference | Enter the name of a Generator:FuelSupply object. Names a Generator:FuelSupply |
|
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
Referenced by 4 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, ElectricLoadCenter:Generators, PlantEquipmentList
Generator:MicroCHP:NonNormalizedParameters¶
from idfpy.models import GeneratorMicroCHPNonNormalizedParameters
This object is referenced by a Generator:MicroCHP object and provides the non-normalized parameters for the MicroCHP generator model.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
maximum_Maximum Electric Power |
number W |
||
minimum_Minimum Electric Power |
number W |
||
minimum_Minimum Cooling Water Flow Rate |
number kg/s |
||
maximum_Maximum Cooling Water Temperature |
number C |
||
electrical_Electrical Efficiency Curve Name |
reference | TriQuadratic Names a Curve:ChillerPartLoadWithLift, Curve:Triquadratic, Table:Lookup |
|
thermal_Thermal Efficiency Curve Name |
reference | TriQuadratic Names a Curve:ChillerPartLoadWithLift, Curve:Triquadratic, Table:Lookup |
|
cooling_Cooling Water Flow Rate Mode |
choice | One of InternalControl, PlantControl |
|
cooling_Cooling Water Flow Rate Curve Name |
reference | Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup | |
air_Air Flow Rate Curve Name |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more | |
maximum_Maximum Net Electrical Power Rate of Change |
number W/s |
||
maximum_Maximum Fuel Flow Rate of Change |
number kg/s2 |
||
heat_Heat Exchanger U-Factor Times Area Value |
number W/K |
||
skin_Skin Loss U-Factor Times Area Value |
number W/K |
||
skin_Skin Loss Radiative Fraction |
number | ||
aggregated_Aggregated Thermal Mass of Energy Conversion Portion of Generator |
number W/K |
Range: > 0 | |
aggregated_Aggregated Thermal Mass of Heat Recovery Portion of Generator |
number W/K |
Range: > 0 | |
standby_Standby Power |
number W |
||
warm_Warm Up Mode |
choice | Stirling engines use Nominal Engine Temperature Internal combustion engines use Time Delay One of NominalEngineTemperature, TimeDelay |
|
warm_Warm Up Fuel Flow Rate Coefficient |
number | ||
nominal_Nominal Engine Operating Temperature |
number C |
||
warm_Warm Up Power Coefficient |
number | ||
warm_Warm Up Fuel Flow Rate Limit Ratio |
number | ||
warm_Warm Up Delay Time |
number s |
||
cool_Cool Down Power |
number W |
||
cool_Cool Down Delay Time |
number s |
||
restart_Restart Mode |
choice | One of MandatoryCoolDown, OptionalCoolDown |
Referenced by 1 object types
Generator:MicroTurbine¶
from idfpy.models import GeneratorMicroTurbine
MicroTurbine generators are small combustion turbines (e.g., 25kW to 500kW). The model calculates electrical power output, fuel use, standby and ancillary power. Energy recovery from exhaust air can be used to heat water.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
reference_Reference Electrical Power Output required |
number W |
Range: > 0 | |
minimum_Minimum Full Load Electrical Power Output |
number W |
0.0 |
Range: ≥ 0 |
maximum_Maximum Full Load Electrical Power Output |
number W |
If left blank, Maximum Full Load Electrical Power Output will be set equal to the Reference Electrical Power Output. Range: > 0 |
|
reference_Reference Electrical Efficiency Using Lower Heating Value required |
number | Electric power output divided by fuel energy input (LHV basis) at reference conditions. Range: > 0, ≤ 1 |
|
reference_Reference Combustion Air Inlet Temperature |
number C |
15.0 |
|
reference_Reference Combustion Air Inlet Humidity Ratio |
number kgWater/kgDryAir |
0.00638 |
Range: > 0 |
reference_Reference Elevation |
number m |
0.0 |
Range: ≥ -300 |
electrical_Electrical Power Function of Temperature and Elevation Curve Name required |
reference | curve = a + b*T + c*T**2 + d*Elev + e*Elev**2 + f*T*Elev T = combustion air inlet temperature (C) Elev = elevation (m) Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
electrical_Electrical Efficiency Function of Temperature Curve Name required |
reference | Quadratic curve = a + b*T + c*T**2 Cubic curve = a + b*T + c*T**2 + d*T**3 T = combustion air inlet temperature (C) Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
electrical_Electrical Efficiency Function of Part Load Ratio Curve Name required |
reference | Quadratic curve = a + b*PLR + c*PLR**2 Cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3 PLR = ratio of Generator Load to steady state Electrical Power Output at current operating conditions Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
fuel_Fuel Type |
choice | NaturalGas |
One of Coal, Diesel, FuelOilNo1, FuelOilNo2, Gasoline, NaturalGas, OtherFuel1, OtherFuel2, Propane |
fuel_Fuel Higher Heating Value |
number kJ/kg |
50000.0 |
Range: > 0 |
fuel_Fuel Lower Heating Value |
number kJ/kg |
45450.0 |
Range: > 0 |
standby_Standby Power |
number W |
0.0 |
Electric power consumed when the generator is available but not being called by the Electric Load Center. Range: ≥ 0 |
ancillary_Ancillary Power |
number W |
0.0 |
Electric power consumed by ancillary equipment (e.g., external fuel pressurization pump). Set to zero if Reference Electrical Power Output is the 'net' value (ancillary power already deducted). Input value is positive, but indicates negative electric generation. Range: ≥ 0 |
ancillary_Ancillary Power Function of Fuel Input Curve Name |
reference | Quadratic curve = a + b*mdot + c*mdot**2 mdot = fuel mass flow rate (kg/s) If left blank, model assumes ancillary power defined in previous field is constant whenever the generator is operating. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
heat_Heat Recovery Water Inlet Node Name |
string | ||
heat_Heat Recovery Water Outlet Node Name |
string | ||
reference_Reference Thermal Efficiency Using Lower Heat Value |
number | 0.0 |
Reference thermal efficiency (heat recovery to water) based on the Lower Heating Value (LHV) of the fuel. Range: ≥ 0, ≤ 1 |
reference_Reference Inlet Water Temperature |
number C |
||
heat_Heat Recovery Water Flow Operating Mode |
choice | PlantControl |
PlantControl means the heat recovery water flow rate is determined by the plant, but the user needs to supply a heat recovery water flow rate. InternalControl means the heat recovery water flow rate is controlled by this generator. If 'InternalControl' is selected, then the user needs to supply a reference heat recovery water flow rate and optionally the name of a heat recovery flow rate modifier curve. One of InternalControl, PlantControl |
reference_Reference Heat Recovery Water Flow Rate |
number m3/s |
Range: > 0 | |
heat_Heat Recovery Water Flow Rate Function of Temperature and Power Curve Name |
reference | curve = a + b*T + c*T**2 + d*Pnet + e*Pnet + f*T*Pnet T = heat recovery inlet water temperature Pnet = net power output = electric power output - ancillary power If left blank, model assumes the heat recovery water flow rate is constant whenever the generator is operating, at the Reference HR Water Flow Rate defined in the previous field. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
thermal_Thermal Efficiency Function of Temperature and Elevation Curve Name |
reference | Bicubic curve = a + b*T + c*T**2 + d*Elev + e*Elev**2 + f*T*Elev + g*T**3 + h*Elev**3 + i*T**2*Elev + j*T*Elev**2 Biquadratic curve = a + b*T + c*T**2 + d*Elev + e*Elev**2 + f*T*Elev T = combustion air inlet temperature (C) Elev = elevation (m) If field is left blank, model assumes this modifier equals 1 for entire simulation. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
heat_Heat Recovery Rate Function of Part Load Ratio Curve Name |
reference | Quadratic curve = a + b*PLR + c*PLR**2 Cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3 PLR = ratio of Generator Load to steady state Electrical Power Output at current operating conditions If field is left blank, model assumes this modifier equals 1 for entire simulation. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
heat_Heat Recovery Rate Function of Inlet Water Temperature Curve Name |
reference | Quadratic curve = a + b*T + c*T**2 T = inlet water temperature (C) If field is left blank, model assumes this modifier equals 1 for entire simulation. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
heat_Heat Recovery Rate Function of Water Flow Rate Curve Name |
reference | Quadratic curve = a + b*Flow + c*Flow**2 Flow = flow rate of water through the heat exchanger (m3/s) If field is left blank, model assumes this modifier equals 1 for entire simulation. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
minimum_Minimum Heat Recovery Water Flow Rate |
number m3/s |
0.0 |
Range: ≥ 0 |
maximum_Maximum Heat Recovery Water Flow Rate |
number m3/s |
0.0 |
Range: ≥ 0 |
maximum_Maximum Heat Recovery Water Temperature |
number C |
||
combustion_Combustion Air Inlet Node Name |
string | Must be an outdoor air node. | |
combustion_Combustion Air Outlet Node Name |
string | ||
reference_Reference Exhaust Air Mass Flow Rate |
number kg/s |
Range: > 0 | |
exhaust_Exhaust Air Flow Rate Function of Temperature Curve Name |
reference | Quadratic curve = a + b*T + c*T**2 Cubic curve = a + b*T + c*T**2 + d*T**3 T = combustion air inlet temperature (C) If field is left blank, model assumes this modifier equals 1 for entire simulation. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
exhaust_Exhaust Air Flow Rate Function of Part Load Ratio Curve Name |
reference | Quadratic curve = a + b*PLR + c*PLR**2 Cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3 PLR = ratio of Generator Load to steady state Electrical Power Output at current operating conditions. If field is left blank, model assumes this modifier equals 1 for entire simulation. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
nominal_Nominal Exhaust Air Outlet Temperature |
number | Exhaust air outlet temperature at reference conditions. | |
exhaust_Exhaust Air Temperature Function of Temperature Curve Name |
reference | Quadratic curve = a + b*T + c*T**2 Cubic curve = a + b*T + c*T**2 + d*T**3 T = combustion air inlet temperature (C) If field is left blank, model assumes this modifier equals 1 for entire simulation. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
exhaust_Exhaust Air Temperature Function of Part Load Ratio Curve Name |
reference | Quadratic curve = a + b*PLR + c*PLR**2 Cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3 PLR = ratio of Generator Load to steady state Electrical Power Output at current operating conditions. If field is left blank, model assumes this modifier equals 1 for entire simulation. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
Referenced by 6 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, ChillerHeater:Absorption:DoubleEffect, CondenserEquipmentList, ElectricLoadCenter:Generators, PlantEquipmentList
Generator:PVWatts¶
from idfpy.models import GeneratorPVWatts
Describes a simple set of inputs for an array of photovoltaic (PV) modules as described in the PVWatts software. A series of different PVWatts arrays can be connected to a single electric load center (preferably through an ElectricLoadCenter:Inverter:PVWatts). Array tilt and azimuth can be either specified on this object or taken from a referenced building surface or shading surface. If a surface is specified, the array participates normally in all shading calculations.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
pvwatts_PVWatts Version |
choice | One of 5 |
|
dc_DC System Capacity required |
number W |
Nameplate rated DC system capacity in watts Range: > 0 |
|
module_Module Type required |
choice | One of Premium, Standard, ThinFilm |
|
array_Array Type required |
choice | One of FixedOpenRack, FixedRoofMounted, OneAxis, OneAxisBacktracking, TwoAxis |
|
system_System Losses |
number | 0.14 |
Range: ≥ 0, ≤ 1 |
array_Array Geometry Type |
choice | TiltAzimuth |
TiltAzimuth - The tilt and azimuth angles are specified in the next two fields. An unshaded array is assumed. Surface - The array geometry (tilt and azimuth) as well as shading is determined from surface referenced. One of Surface, TiltAzimuth |
tilt_Tilt Angle |
number deg |
20.0 |
The tilt angle is the angle from horizontal of the photovoltaic modules in the array. Range: ≥ 0, ≤ 90 |
azimuth_Azimuth Angle |
number deg |
180.0 |
For a fixed array, the azimuth angle is the angle clockwise from true north describing the direction that the array faces. For an array with one-axis tracking, the azimuth angle is the angle clockwise from true north of the axis of rotation. Range: ≥ 0, < 360 |
surface_Surface Name |
reference | Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, GlazedDoor, GlazedDoor:Interzone and 18 more | |
ground_Ground Coverage Ratio |
number | 0.4 |
Applies only to arrays with one-axis tracking and is the ratio of module surface area to area of the ground or roof occupied by the array. Range: ≥ 0, ≤ 1 |
Referenced by 1 object types
Generator:Photovoltaic¶
from idfpy.models import GeneratorPhotovoltaic
Describes an array of photovoltaic (PV) modules. A series of different PV arrays can be connected to a single electric load center (and inverter) by listing them all in an ElectricLoadCenter:Generator object. PV performance is taken from the referenced PhotovoltaicPerformance:* object. Array tilt, azimuth, and gross area are taken from the referenced building surface or shading surface. The array surface participates normally in all shading calculations.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
surface_Surface Name required |
reference | Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, GlazedDoor, GlazedDoor:Interzone and 18 more | |
photovoltaic_Photovoltaic Performance Object Type |
choice | One of PhotovoltaicPerformance:EquivalentOne-Diode, PhotovoltaicPerformance:Sandia, PhotovoltaicPerformance:Simple |
|
module_Module Performance Name |
reference | PV array modeling details Names a PhotovoltaicPerformance:EquivalentOne-Diode, PhotovoltaicPerformance:Sandia, PhotovoltaicPerformance:Simple |
|
heat_Heat Transfer Integration Mode |
choice | Decoupled |
One of Decoupled, DecoupledUllebergDynamic, IntegratedExteriorVentedCavity, IntegratedSurfaceOutsideFace, IntegratedTranspiredCollector, PhotovoltaicThermalSolarCollector |
number_Number of Series Strings in Parallel |
number dimensionless |
1.0 |
number of series-wired strings of PV modules that are in parallel Range: ≥ 1 |
number_Number of Modules in Series |
number dimensionless |
1.0 |
Number of PV modules wired in series for each string. Range: ≥ 1 |
Referenced by 2 object types
ElectricLoadCenter:Generators, SolarCollector:FlatPlate:PhotovoltaicThermal
Generator:WindTurbine¶
from idfpy.models import GeneratorWindTurbine
Wind turbine generator.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
rotor_Rotor Type |
choice | HorizontalAxisWindTurbine |
allowed values are: Horizontal Axis Wind Turbine or Vertical Axis Wind Turbine One of HorizontalAxisWindTurbine, VerticalAxisWindTurbine |
power_Power Control |
choice | VariableSpeedVariablePitch |
Constant power output is obtained in the last three control types when the wind speed exceeds the rated wind speed. allowed values are: Fixed Speed Fixed Pitch, Fixed Speed Variable Pitch, Variable Speed Fixed Pitch or Variable Speed Variable Pitch One of FixedSpeedFixedPitch, FixedSpeedVariablePitch, VariableSpeedFixedPitch, VariableSpeedVariablePitch |
rated_Rated Rotor Speed required |
number rev/min |
Range: > 0 | |
rotor_Rotor Diameter required |
number m |
This field is the diameter of the perpendicular circle of the Vertical Axis Wind Turbine system from the upright pole on the ground. Range: > 0 |
|
overall_Overall Height required |
number m |
This field is the height of the hub for the Horizontal Axis Wind Turbines and of the pole for the Vertical Axis Wind Turbines. Range: > 0 |
|
number_Number of Blades |
number | 3.0 |
Range: ≥ 2 |
rated_Rated Power required |
number W |
This field is the nominal power at the rated wind speed. Users should input maximum power in case of Fixed Speed Fixed Pitch control type. Range: > 0 |
|
rated_Rated Wind Speed required |
number m/s |
Range: > 0 | |
cut_Cut In Wind Speed required |
number m/s |
Range: > 0 | |
cut_Cut Out Wind Speed required |
number m/s |
Range: > 0 | |
fraction_Fraction system Efficiency |
number | 0.835 |
Range: > 0, ≤ 1 |
maximum_Maximum Tip Speed Ratio |
number | 5.0 |
Range: > 0, ≤ 12 |
maximum_Maximum Power Coefficient |
number | 0.25 |
This field should be input if the rotor type is Horizontal Axis Wind Turbine Range: > 0, ≤ 0.59 |
annual_Annual Local Average Wind Speed |
number m/s |
Range: > 0 | |
height_Height for Local Average Wind Speed |
number m |
50.0 |
Range: > 0 |
blade_Blade Chord Area |
number m2 |
||
blade_Blade Drag Coefficient |
number | 0.9 |
This field is only for Vertical Axis Wind Turbine.. The user must input this field if the rotor type is Vertical Axis Wind Turbine. |
blade_Blade Lift Coefficient |
number | 0.05 |
This field is only for Vertical Axis Wind Turbine.. The user must input this field if the rotor type is Vertical Axis Wind Turbine. |
power_Power Coefficient C1 |
number | 0.5176 |
This field is only available for Horizontal Axis Wind Turbine. The user should input all six parameters so that the analytic approximation is assumed. The simple approximation will be assumed, if any field C1 through C6 is not input. Leave this field blank, if the manufacturer's data is unavailable so that the simple approximation will be assumed. Range: > 0 |
power_Power Coefficient C2 |
number | 116.0 |
Range: > 0 |
power_Power Coefficient C3 |
number | 0.4 |
Range: > 0 |
power_Power Coefficient C4 |
number | 0.0 |
Range: ≥ 0 |
power_Power Coefficient C5 |
number | 5.0 |
Range: > 0 |
power_Power Coefficient C6 |
number | 21.0 |
Range: > 0 |
Referenced by 1 object types
PhotovoltaicPerformance:EquivalentOne-Diode¶
from idfpy.models import PhotovoltaicPerformanceEquivalentOneDiode
Describes the performance characteristics of Photovoltaic (PV) modules to be modeled using an equivalent one-diode circuit. This model is also known as the 4- or 5-parameter TRNSYS model for photovoltaics.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
cell_Cell type |
choice | One of AmorphousSilicon, CrystallineSilicon |
|
number_Number of Cells in Series |
integer dimensionless |
36 |
Range: ≥ 0 |
active_Active Area |
number m2 |
0.89 |
The total power output of the array is determined by the number of modules (see above). The Active Area is only used to calculate the PV Array Efficiency output variable. Range: ≥ 0.1 |
transmittance_Transmittance Absorptance Product |
number dimensionless |
0.95 |
Range: ≥ 0, ≤ 1 |
semiconductor_Semiconductor Bandgap |
number eV |
1.12 |
Range: ≥ 0 |
shunt_Shunt Resistance |
number ohms |
1000000.0 |
Range: ≥ 0 |
short_Short Circuit Current |
number A |
6.5 |
Range: ≥ 0 |
open_Open Circuit Voltage |
number V |
21.6 |
Range: ≥ 0 |
reference_Reference Temperature |
number C |
25.0 |
Range: ≥ 0 |
reference_Reference Insolation |
number W/m2 |
1000.0 |
Range: ≥ 0 |
module_Module Current at Maximum Power |
number A |
5.9 |
Single module current at the maximum power point and reference conditions. Module Current, Module Voltage, Number of Modules in Parallel and Number of Modules in Series determine the maximum power output of the array. Range: ≥ 0 |
module_Module Voltage at Maximum Power |
number V |
17.0 |
Single module voltage at the maximum power point and reference conditions. Module Current, Module Voltage, Number of Modules in Parallel and Number of Modules in Series determine the maximum power output of the array. Range: ≥ 0 |
temperature_Temperature Coefficient of Short Circuit Current |
number A/K |
0.02 |
|
temperature_Temperature Coefficient of Open Circuit Voltage |
number V/K |
-0.079 |
|
nominal_Nominal Operating Cell Temperature Test Ambient Temperature |
number C |
20.0 |
Range: ≥ 0 |
nominal_Nominal Operating Cell Temperature Test Cell Temperature |
number C |
40.0 |
Range: ≥ 0 |
nominal_Nominal Operating Cell Temperature Test Insolation |
number W/m2 |
800.0 |
Range: ≥ 0 |
module_Module Heat Loss Coefficient |
number W/m2-K |
30.0 |
Range: ≥ 0 |
total_Total Heat Capacity |
number J/m2-K |
50000.0 |
Range: ≥ 0 |
Referenced by 1 object types
PhotovoltaicPerformance:Sandia¶
from idfpy.models import PhotovoltaicPerformanceSandia
Describes performance input data needed for specific makes and models of production PV panels using the empirical coefficients assembled by Sandia National Laboratory.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
active_Active Area |
number m2 |
1.0 |
(m2, single module) Range: ≥ 0 |
number_Number of Cells in Series |
integer dimensionless |
1 |
Range: ≥ 1 |
number_Number of Cells in Parallel |
integer dimensionless |
1 |
Range: ≥ 1 |
short_Short Circuit Current |
number A |
(Amps) | |
open_Open Circuit Voltage |
number V |
(Volts) | |
current_Current at Maximum Power Point |
number A |
(Amps) | |
voltage_Voltage at Maximum Power Point |
number V |
(Volts) | |
sandia_Sandia Database Parameter aIsc |
number 1/K |
(1/degC) | |
sandia_Sandia Database Parameter aImp |
number 1/K |
(1/degC) | |
sandia_Sandia Database Parameter c0 |
number dimensionless |
||
sandia_Sandia Database Parameter c1 |
number dimensionless |
||
sandia_Sandia Database Parameter BVoc0 |
number V/K |
(Volts/degC) | |
sandia_Sandia Database Parameter mBVoc |
number V/K |
(Volts/degC) | |
sandia_Sandia Database Parameter BVmp0 |
number V/K |
(Volts/degC) | |
sandia_Sandia Database Parameter mBVmp |
number V/K |
(Volts/degC) | |
diode_Diode Factor |
number dimensionless |
||
sandia_Sandia Database Parameter c2 |
number dimensionless |
||
sandia_Sandia Database Parameter c3 |
number dimensionless |
||
sandia_Sandia Database Parameter a0 |
number dimensionless |
||
sandia_Sandia Database Parameter a1 |
number dimensionless |
||
sandia_Sandia Database Parameter a2 |
number dimensionless |
||
sandia_Sandia Database Parameter a3 |
number dimensionless |
||
sandia_Sandia Database Parameter a4 |
number dimensionless |
||
sandia_Sandia Database Parameter b0 |
number dimensionless |
||
sandia_Sandia Database Parameter b1 |
number dimensionless |
||
sandia_Sandia Database Parameter b2 |
number dimensionless |
||
sandia_Sandia Database Parameter b3 |
number dimensionless |
||
sandia_Sandia Database Parameter b4 |
number dimensionless |
||
sandia_Sandia Database Parameter b5 |
number dimensionless |
||
sandia_Sandia Database Parameter Delta(Tc) |
number deltaC |
(deg C) | |
sandia_Sandia Database Parameter fd |
number dimensionless |
||
sandia_Sandia Database Parameter a |
number dimensionless |
||
sandia_Sandia Database Parameter b |
number dimensionless |
||
sandia_Sandia Database Parameter c4 |
number dimensionless |
||
sandia_Sandia Database Parameter c5 |
number dimensionless |
||
sandia_Sandia Database Parameter Ix0 |
number | (Amps) | |
sandia_Sandia Database Parameter Ixx0 |
number | (Amps) | |
sandia_Sandia Database Parameter c6 |
number dimensionless |
||
sandia_Sandia Database Parameter c7 |
number dimensionless |
(non-dimensional) |
Referenced by 1 object types
PhotovoltaicPerformance:Simple¶
from idfpy.models import PhotovoltaicPerformanceSimple
Describes a simple model of photovoltaics that may be useful for early phase design analysis. In this model the user has direct access to the efficiency with which surfaces convert incident solar radiation to electricity and need not specify arrays of specific modules.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
fraction_Fraction of Surface Area with Active Solar Cells required |
number dimensionless |
Range: ≥ 0, ≤ 1 | |
conversion_Conversion Efficiency Input Mode |
choice | One of Fixed, Scheduled |
|
value_Value for Cell Efficiency if Fixed |
number | Efficiency = (power generated [W])/(incident solar[W]) Range: ≥ 0, ≤ 1 |
|
efficiency_Efficiency Schedule Name |
reference | Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |