pyidf.electric_load_center module

Data objects in group “Electric Load Center”

class pyidf.electric_load_center.ElectricLoadCenterDistribution

Bases: pyidf.helper.DataObject

Corresponds to IDD object ElectricLoadCenter:Distribution a list of meters that can be reported are available after a run on the meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

demand_limit_scheme_purchased_electric_demand_limit

field Demand Limit Scheme Purchased Electric Demand Limit

Units: W

Parameters:value (float) – value for IDD Field Demand Limit Scheme Purchased Electric Demand Limit Raises:ValueError – if value is not a valid value Returns:the value of demand_limit_scheme_purchased_electric_demand_limit or None if not set Return type:float

electrical_buss_type

field Electrical Buss Type

Default value: AlternatingCurrent

Parameters:value (str) – value for IDD Field Electrical Buss Type Raises:ValueError – if value is not a valid value Returns:the value of electrical_buss_type or None if not set Return type:str

electrical_storage_object_name

field Electrical Storage Object Name

required when Electrical Buss Type=AlternatingCurrentWithStorage, DirectCurrentWithInverterDCStorage,

or DirectCurrentWithInverterACStorage

Parameters:value (str) – value for IDD Field Electrical Storage Object Name Raises:ValueError – if value is not a valid value Returns:the value of electrical_storage_object_name or None if not set Return type:str

generator_list_name

field Generator List Name

Parameters:value (str) – value for IDD Field Generator List Name Raises:ValueError – if value is not a valid value Returns:the value of generator_list_name or None if not set Return type:str

generator_operation_scheme_type

field Generator Operation Scheme Type

required if Generator List is entered.

Parameters:value (str) – value for IDD Field Generator Operation Scheme Type Raises:ValueError – if value is not a valid value Returns:the value of generator_operation_scheme_type or None if not set Return type:str

inverter_object_name

field Inverter Object Name

required when Electrical Buss Type=DirectCurrentWithInverter, DirectCurrentWithInverterDCStorage,

or DirectCurrentWithInverterACStorage

Parameters:value (str) – value for IDD Field Inverter Object Name Raises:ValueError – if value is not a valid value Returns:the value of inverter_object_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

track_meter_scheme_meter_name

field Track Meter Scheme Meter Name

required when Generator Operation Scheme Type=TrackMeter

Parameters:value (str) – value for IDD Field Track Meter Scheme Meter Name Raises:ValueError – if value is not a valid value Returns:the value of track_meter_scheme_meter_name or None if not set Return type:str

track_schedule_name_scheme_schedule_name

field Track Schedule Name Scheme Schedule Name

required when Generator Operation Scheme Type=TrackSchedule

Parameters:value (str) – value for IDD Field Track Schedule Name Scheme Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of track_schedule_name_scheme_schedule_name or None if not set Return type:str

transformer_object_name

field Transformer Object Name

required when power needs to be output from on-site generation to the grid via transformer

Parameters:value (str) – value for IDD Field Transformer Object Name Raises:ValueError – if value is not a valid value Returns:the value of transformer_object_name or None if not set Return type:str

class pyidf.electric_load_center.ElectricLoadCenterGenerators

Bases: pyidf.helper.DataObject

Corresponds to IDD object ElectricLoadCenter:Generators 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.

add_extensible(generator_1_name=None, generator_1_object_type=None, generator_1_rated_electric_power_output=None, generator_1_availability_schedule_name=None, generator_1_rated_thermal_to_electrical_power_ratio=None)

Add values for extensible fields

Parameters:

• generator_1_name (str) – value for IDD Field Generator 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• generator_1_object_type (str) – value for IDD Field Generator 1 Object Type if value is None it will not be checked against the specification and is assumed to be a missing value
• generator_1_rated_electric_power_output (float) – value for IDD Field Generator 1 Rated Electric Power Output Units: W if value is None it will not be checked against the specification and is assumed to be a missing value
• generator_1_availability_schedule_name (str) – value for IDD Field Generator 1 Availability Schedule Name if value is None it will not be checked against the specification and is assumed to be a missing value
• generator_1_rated_thermal_to_electrical_power_ratio (float) – value for IDD Field Generator 1 Rated Thermal to Electrical Power Ratio if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

class pyidf.electric_load_center.ElectricLoadCenterInverterFunctionOfPower

Bases: pyidf.helper.DataObject

Corresponds to IDD object ElectricLoadCenter:Inverter:FunctionOfPower 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.

ancillary_power_consumed_in_standby

field Ancillary Power Consumed In Standby

Units: W

Parameters:value (float) – value for IDD Field Ancillary Power Consumed In Standby Raises:ValueError – if value is not a valid value Returns:the value of ancillary_power_consumed_in_standby or None if not set Return type:float

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule_name or None if not set Return type:str

efficiency_function_of_power_curve_name

field Efficiency Function of Power Curve Name

curve describes efficiency as a function of power

curve is normalized relative to rated power in next field

Parameters:value (str) – value for IDD Field Efficiency Function of Power Curve Name Raises:ValueError – if value is not a valid value Returns:the value of efficiency_function_of_power_curve_name or None if not set Return type:str

maximum_efficiency

field Maximum Efficiency

value <= 1.0

Parameters:value (float) – value for IDD Field Maximum Efficiency Raises:ValueError – if value is not a valid value Returns:the value of maximum_efficiency or None if not set Return type:float

maximum_power_output

field Maximum Power Output

Units: W

Parameters:value (float) – value for IDD Field Maximum Power Output Raises:ValueError – if value is not a valid value Returns:the value of maximum_power_output or None if not set Return type:float

minimum_efficiency

field Minimum Efficiency

value <= 1.0

Parameters:value (float) – value for IDD Field Minimum Efficiency Raises:ValueError – if value is not a valid value Returns:the value of minimum_efficiency or None if not set Return type:float

minimum_power_output

field Minimum Power Output

Units: W

Parameters:value (float) – value for IDD Field Minimum Power Output Raises:ValueError – if value is not a valid value Returns:the value of minimum_power_output or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

radiative_fraction

field Radiative Fraction

Parameters:value (float) – value for IDD Field Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of radiative_fraction or None if not set Return type:float

rated_maximum_continuous_input_power

field Rated Maximum Continuous Input Power

Units: W

Parameters:value (float) – value for IDD Field Rated Maximum Continuous Input Power Raises:ValueError – if value is not a valid value Returns:the value of rated_maximum_continuous_input_power or None if not set Return type:float

zone_name

field Zone Name

Enter name of zone to receive inverter losses as heat

if blank then inverter is assumed to be outdoors

Parameters:value (str) – value for IDD Field Zone Name Raises:ValueError – if value is not a valid value Returns:the value of zone_name or None if not set Return type:str

class pyidf.electric_load_center.ElectricLoadCenterInverterLookUpTable

Bases: pyidf.helper.DataObject

Corresponds to IDD object ElectricLoadCenter:Inverter:LookUpTable 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

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule_name or None if not set Return type:str

efficiency_at_100_power_and_nominal_voltage

field Efficiency at 100% Power and Nominal Voltage

value <= 1.0

Parameters:value (float) – value for IDD Field Efficiency at 100% Power and Nominal Voltage Raises:ValueError – if value is not a valid value Returns:the value of efficiency_at_100_power_and_nominal_voltage or None if not set Return type:float

efficiency_at_10_power_and_nominal_voltage

field Efficiency at 10% Power and Nominal Voltage

value <= 1.0

Parameters:value (float) – value for IDD Field Efficiency at 10% Power and Nominal Voltage Raises:ValueError – if value is not a valid value Returns:the value of efficiency_at_10_power_and_nominal_voltage or None if not set Return type:float

efficiency_at_20_power_and_nominal_voltage

field Efficiency at 20% Power and Nominal Voltage

value <= 1.0

Parameters:value (float) – value for IDD Field Efficiency at 20% Power and Nominal Voltage Raises:ValueError – if value is not a valid value Returns:the value of efficiency_at_20_power_and_nominal_voltage or None if not set Return type:float

efficiency_at_30_power_and_nominal_voltage

field Efficiency at 30% Power and Nominal Voltage

value <= 1.0

Parameters:value (float) – value for IDD Field Efficiency at 30% Power and Nominal Voltage Raises:ValueError – if value is not a valid value Returns:the value of efficiency_at_30_power_and_nominal_voltage or None if not set Return type:float

efficiency_at_50_power_and_nominal_voltage

field Efficiency at 50% Power and Nominal Voltage

value <= 1.0

Parameters:value (float) – value for IDD Field Efficiency at 50% Power and Nominal Voltage Raises:ValueError – if value is not a valid value Returns:the value of efficiency_at_50_power_and_nominal_voltage or None if not set Return type:float

efficiency_at_75_power_and_nominal_voltage

field Efficiency at 75% Power and Nominal Voltage

value <= 1.0

Parameters:value (float) – value for IDD Field Efficiency at 75% Power and Nominal Voltage Raises:ValueError – if value is not a valid value Returns:the value of efficiency_at_75_power_and_nominal_voltage or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

night_tare_loss_power

field Night Tare Loss Power

Units: W

Parameters:value (float) – value for IDD Field Night Tare Loss Power Raises:ValueError – if value is not a valid value Returns:the value of night_tare_loss_power or None if not set Return type:float

nominal_voltage_input

field Nominal Voltage Input

Units: V

Parameters:value (float) – value for IDD Field Nominal Voltage Input Raises:ValueError – if value is not a valid value Returns:the value of nominal_voltage_input or None if not set Return type:float

radiative_fraction

field Radiative Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of radiative_fraction or None if not set Return type:float

rated_maximum_continuous_output_power

field Rated Maximum Continuous Output Power

Units: W

Parameters:value (float) – value for IDD Field Rated Maximum Continuous Output Power Raises:ValueError – if value is not a valid value Returns:the value of rated_maximum_continuous_output_power or None if not set Return type:float

zone_name

field Zone Name

Enter name of zone to receive inverter losses as heat

if blank then inverter is assumed to be outdoors

Parameters:value (str) – value for IDD Field Zone Name Raises:ValueError – if value is not a valid value Returns:the value of zone_name or None if not set Return type:str

class pyidf.electric_load_center.ElectricLoadCenterInverterSimple

Bases: pyidf.helper.DataObject

Corresponds to IDD object ElectricLoadCenter:Inverter:Simple 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.

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule_name or None if not set Return type:str

inverter_efficiency

field Inverter Efficiency

value <= 1.0

Parameters:value (float) – value for IDD Field Inverter Efficiency Raises:ValueError – if value is not a valid value Returns:the value of inverter_efficiency or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

radiative_fraction

field Radiative Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of radiative_fraction or None if not set Return type:float

zone_name

field Zone Name

enter name of zone to receive inverter losses as heat

if blank then inverter is assumed to be outdoors

Parameters:value (str) – value for IDD Field Zone Name Raises:ValueError – if value is not a valid value Returns:the value of zone_name or None if not set Return type:str

class pyidf.electric_load_center.ElectricLoadCenterStorageBattery

Bases: pyidf.helper.DataObject

Corresponds to IDD object ElectricLoadCenter:Storage:Battery 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.

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule_name or None if not set Return type:str

battery_life_calculation

field Battery Life Calculation

Default value: No

Parameters:value (str) – value for IDD Field Battery Life Calculation Raises:ValueError – if value is not a valid value Returns:the value of battery_life_calculation or None if not set Return type:str

battery_life_curve_name

field Battery Life Curve Name

Determines the number of cycles to failure in relation to cycle range.

Only required when battery life calculation is activated.

Parameters:value (str) – value for IDD Field Battery Life Curve Name Raises:ValueError – if value is not a valid value Returns:the value of battery_life_curve_name or None if not set Return type:str

change_rate_from_bound_charge_to_available_charge

field Change Rate from Bound Charge to Available Charge

A model parameter usually derived from test data by curve fitting.

Units: 1/hr

Parameters:value (float) – value for IDD Field Change Rate from Bound Charge to Available Charge Raises:ValueError – if value is not a valid value Returns:the value of change_rate_from_bound_charge_to_available_charge or None if not set Return type:float

fraction_of_available_charge_capacity

field Fraction of Available Charge Capacity

A model parameter usually derived from test data by curve fitting.

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Available Charge Capacity Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_available_charge_capacity or None if not set Return type:float

fully_charged_module_open_circuit_voltage

field Fully Charged Module Open Circuit Voltage

The voltage is for each battery module.

Units: V

Parameters:value (float) – value for IDD Field Fully Charged Module Open Circuit Voltage Raises:ValueError – if value is not a valid value Returns:the value of fully_charged_module_open_circuit_voltage or None if not set Return type:float

fully_discharged_module_open_circuit_voltage

field Fully Discharged Module Open Circuit Voltage

The voltage is for each battery module.

Units: V

Parameters:value (float) – value for IDD Field Fully Discharged Module Open Circuit Voltage Raises:ValueError – if value is not a valid value Returns:the value of fully_discharged_module_open_circuit_voltage or None if not set Return type:float

initial_fractional_state_of_charge

field Initial Fractional State of Charge

The state of charge is evaluated based on the

maximum capacity defined in the next field.

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Initial Fractional State of Charge Raises:ValueError – if value is not a valid value Returns:the value of initial_fractional_state_of_charge or None if not set Return type:float

maximum_module_capacity

field Maximum Module Capacity

The capacity is for each module.

A model parameter from manufacturer’s data or test data.

Units: Ah

Parameters:value (float) – value for IDD Field Maximum Module Capacity Raises:ValueError – if value is not a valid value Returns:the value of maximum_module_capacity or None if not set Return type:float

maximum_module_discharging_current

field Maximum Module Discharging Current

The constraint on discharging current is for each battery module.

Units: A

Parameters:value (float) – value for IDD Field Maximum Module Discharging Current Raises:ValueError – if value is not a valid value Returns:the value of maximum_module_discharging_current or None if not set Return type:float

module_charge_rate_limit

field Module Charge Rate Limit

units 1/hr

Charge rate limit is the division between charging current the remaining capacity.

The constraint on charging current is for each module.

Default value: 1.0

Parameters:value (float) – value for IDD Field Module Charge Rate Limit Raises:ValueError – if value is not a valid value Returns:the value of module_charge_rate_limit or None if not set Return type:float

module_cutoff_voltage

field Module Cut-off Voltage

The voltage constraint is for each battery module.

Units: V

Parameters:value (float) – value for IDD Field Module Cut-off Voltage Raises:ValueError – if value is not a valid value Returns:the value of module_cutoff_voltage or None if not set Return type:float

module_internal_electrical_resistance

field Module Internal Electrical Resistance

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.

Units: ohms

Parameters:value (float) – value for IDD Field Module Internal Electrical Resistance Raises:ValueError – if value is not a valid value Returns:the value of module_internal_electrical_resistance or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

number_of_battery_modules_in_parallel

field Number of Battery Modules in Parallel

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.

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Battery Modules in Parallel Raises:ValueError – if value is not a valid value Returns:the value of number_of_battery_modules_in_parallel or None if not set Return type:int

number_of_battery_modules_in_series

field Number of Battery Modules in Series

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.

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Battery Modules in Series Raises:ValueError – if value is not a valid value Returns:the value of number_of_battery_modules_in_series or None if not set Return type:int

number_of_cycle_bins

field Number of Cycle Bins

Only required when battery life calculation is activated

Default value: 10

value >= 5

Parameters:value (int) – value for IDD Field Number of Cycle Bins Raises:ValueError – if value is not a valid value Returns:the value of number_of_cycle_bins or None if not set Return type:int

radiative_fraction

field Radiative Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of radiative_fraction or None if not set Return type:float

voltage_change_curve_name_for_charging

field Voltage Change Curve Name for Charging

Determines how the open circuit voltage change with state of charge relative to the fully discharged state.

Parameters:value (str) – value for IDD Field Voltage Change Curve Name for Charging Raises:ValueError – if value is not a valid value Returns:the value of voltage_change_curve_name_for_charging or None if not set Return type:str

voltage_change_curve_name_for_discharging

field Voltage Change Curve Name for Discharging

Determines how the open circuit voltage change with state of charge relative to the fully charged state.

Parameters:value (str) – value for IDD Field Voltage Change Curve Name for Discharging Raises:ValueError – if value is not a valid value Returns:the value of voltage_change_curve_name_for_discharging or None if not set Return type:str

zone_name

field Zone Name

Enter name of zone to receive electrical storage losses as heat

if blank then electrical storage losses are dissipated to outdoors

Parameters:value (str) – value for IDD Field Zone Name Raises:ValueError – if value is not a valid value Returns:the value of zone_name or None if not set Return type:str

class pyidf.electric_load_center.ElectricLoadCenterStorageSimple

Bases: pyidf.helper.DataObject

Corresponds to IDD object ElectricLoadCenter:Storage:Simple 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.

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule_name or None if not set Return type:str

initial_state_of_charge

field Initial State of Charge

Units: J

Parameters:value (float) – value for IDD Field Initial State of Charge Raises:ValueError – if value is not a valid value Returns:the value of initial_state_of_charge or None if not set Return type:float

maximum_power_for_charging

field Maximum Power for Charging

Units: W

Parameters:value (float) – value for IDD Field Maximum Power for Charging Raises:ValueError – if value is not a valid value Returns:the value of maximum_power_for_charging or None if not set Return type:float

maximum_power_for_discharging

field Maximum Power for Discharging

Units: W

Parameters:value (float) – value for IDD Field Maximum Power for Discharging Raises:ValueError – if value is not a valid value Returns:the value of maximum_power_for_discharging or None if not set Return type:float

maximum_storage_capacity

field Maximum Storage Capacity

Units: J

Parameters:value (float) – value for IDD Field Maximum Storage Capacity Raises:ValueError – if value is not a valid value Returns:the value of maximum_storage_capacity or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

nominal_discharging_energetic_efficiency

field Nominal Discharging Energetic Efficiency

value <= 1.0

Parameters:value (float) – value for IDD Field Nominal Discharging Energetic Efficiency Raises:ValueError – if value is not a valid value Returns:the value of nominal_discharging_energetic_efficiency or None if not set Return type:float

nominal_energetic_efficiency_for_charging

field Nominal Energetic Efficiency for Charging

value <= 1.0

Parameters:value (float) – value for IDD Field Nominal Energetic Efficiency for Charging Raises:ValueError – if value is not a valid value Returns:the value of nominal_energetic_efficiency_for_charging or None if not set Return type:float

radiative_fraction_for_zone_heat_gains

field Radiative Fraction for Zone Heat Gains

value <= 1.0

Parameters:value (float) – value for IDD Field Radiative Fraction for Zone Heat Gains Raises:ValueError – if value is not a valid value Returns:the value of radiative_fraction_for_zone_heat_gains or None if not set Return type:float

zone_name

field Zone Name

Enter name of zone to receive storage losses as heat

if blank then storage is assumed to be outdoors

Parameters:value (str) – value for IDD Field Zone Name Raises:ValueError – if value is not a valid value Returns:the value of zone_name or None if not set Return type:str

class pyidf.electric_load_center.ElectricLoadCenterTransformer

Bases: pyidf.helper.DataObject

Corresponds to IDD object ElectricLoadCenter:Transformer a list of meters that can be reported are available after a run on the meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

add_extensible(meter_1_name=None)

Add values for extensible fields

Parameters:meter_1_name (str) – value for IDD Field Meter 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule_name or None if not set Return type:str

conductor_material

field Conductor Material

Winding material used by the transformer.

Default value: Aluminum

Parameters:value (str) – value for IDD Field Conductor Material Raises:ValueError – if value is not a valid value Returns:the value of conductor_material or None if not set Return type:str

consider_transformer_loss_for_utility_cost

field Consider Transformer Loss for Utility Cost

Only required when the transformer is used for power in from the utility grid

Default value: Yes

Parameters:value (str) – value for IDD Field Consider Transformer Loss for Utility Cost Raises:ValueError – if value is not a valid value Returns:the value of consider_transformer_loss_for_utility_cost or None if not set Return type:str

extensibles

Get list of all extensibles

fraction_of_eddy_current_losses

field Fraction of Eddy Current Losses

Default value: 0.1

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Eddy Current Losses Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_eddy_current_losses or None if not set Return type:float

full_load_temperature_rise

field Full Load Temperature Rise

Units: C

Default value: 150.0

value >= 50.0

value <= 180.0

Parameters:value (float) – value for IDD Field Full Load Temperature Rise Raises:ValueError – if value is not a valid value Returns:the value of full_load_temperature_rise or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

nameplate_efficiency

field Nameplate Efficiency

Only required when NominalEfficiency is the performance input method

Default value: 0.98

value <= 1.0

Parameters:value (float) – value for IDD Field Nameplate Efficiency Raises:ValueError – if value is not a valid value Returns:the value of nameplate_efficiency or None if not set Return type:float

per_unit_load_for_maximum_efficiency

field Per Unit Load for Maximum Efficiency

Percentage of the rate capacity at which the maximum efficiency is obtained

Only required when NominalEfficiency is the performance input method

value <= 1.0

Parameters:value (float) – value for IDD Field Per Unit Load for Maximum Efficiency Raises:ValueError – if value is not a valid value Returns:the value of per_unit_load_for_maximum_efficiency or None if not set Return type:float

per_unit_load_for_nameplate_efficiency

field Per Unit Load for Nameplate Efficiency

Percentage of the rated capacity at which the nameplate efficiency is defined

Only required when NominalEfficiency is the performance input method

Default value: 0.35

value <= 1.0

Parameters:value (float) – value for IDD Field Per Unit Load for Nameplate Efficiency Raises:ValueError – if value is not a valid value Returns:the value of per_unit_load_for_nameplate_efficiency or None if not set Return type:float

performance_input_method

field Performance Input Method

User can define transformer performance by specifying

load and no load losses at rated conditions or

nameplate efficiency and maximum efficiency

Default value: RatedLosses

Parameters:value (str) – value for IDD Field Performance Input Method Raises:ValueError – if value is not a valid value Returns:the value of performance_input_method or None if not set Return type:str

phase

field Phase

Must be single or three phase transformer.

NOT used in the current model.

Default value: 3

Parameters:value (int) – value for IDD Field Phase Raises:ValueError – if value is not a valid value Returns:the value of phase or None if not set Return type:int

radiative_fraction

field Radiative Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of radiative_fraction or None if not set Return type:float

rated_capacity

field Rated Capacity

the unit is VA, instead of kVA as usually shown on transformer nameplates.

Units: VA

Parameters:value (float) – value for IDD Field Rated Capacity Raises:ValueError – if value is not a valid value Returns:the value of rated_capacity or None if not set Return type:float

rated_load_loss

field Rated Load Loss

Only required when RatedLosses is the performance input method

Units: W

Parameters:value (float) – value for IDD Field Rated Load Loss Raises:ValueError – if value is not a valid value Returns:the value of rated_load_loss or None if not set Return type:float

rated_no_load_loss

field Rated No Load Loss

Only required when RatedLosses is the performance input method

Units: W

Parameters:value (float) – value for IDD Field Rated No Load Loss Raises:ValueError – if value is not a valid value Returns:the value of rated_no_load_loss or None if not set Return type:float

reference_temperature_for_nameplate_efficiency

field Reference Temperature for Nameplate Efficiency

Conductor operating temperature at which the nameplate efficiency is defined

Only required when NominalEfficiency is the performance input method

Units: C

Default value: 75.0

value >= 20.0

value <= 150.0

Parameters:value (float) – value for IDD Field Reference Temperature for Nameplate Efficiency Raises:ValueError – if value is not a valid value Returns:the value of reference_temperature_for_nameplate_efficiency or None if not set Return type:float

transformer_usage

field Transformer Usage

A transformer can be used to transfer electric energy from utility grid to

building (PowerInFromGrid)or from building on-site generation to

the grid (PowerOutFromOnsiteGeneration)

Default value: PowerInFromGrid

Parameters:value (str) – value for IDD Field Transformer Usage Raises:ValueError – if value is not a valid value Returns:the value of transformer_usage or None if not set Return type:str

zone_name

field Zone Name

Enter name of zone to receive transformer losses as heat

if blank then transformer losses are dissipated to outdoors

Parameters:value (str) – value for IDD Field Zone Name Raises:ValueError – if value is not a valid value Returns:the value of zone_name or None if not set Return type:str

class pyidf.electric_load_center.GeneratorCombustionTurbine

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:CombustionTurbine 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.

coefficient_1_of_ufactor_times_area_curve

field Coefficient 1 of U-Factor Times Area Curve

curve = C1 * Rated Power Output**C2

Parameters:value (float) – value for IDD Field Coefficient 1 of U-Factor Times Area Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_ufactor_times_area_curve or None if not set Return type:float

coefficient_2_of_ufactor_times_area_curve

field Coefficient 2 of U-Factor Times Area Curve

curve = C1 * Rated Power Output**C2

typical value .9

value <= 2.0

Parameters:value (float) – value for IDD Field Coefficient 2 of U-Factor Times Area Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_ufactor_times_area_curve or None if not set Return type:float

design_air_inlet_temperature

field Design Air Inlet Temperature

Units: C

Parameters:value (float) – value for IDD Field Design Air Inlet Temperature Raises:ValueError – if value is not a valid value Returns:the value of design_air_inlet_temperature or None if not set Return type:float

design_heat_recovery_water_flow_rate

field Design Heat Recovery Water Flow Rate

if non-zero, then inlet, outlet nodes must be entered.

Units: m3/s

IP-Units: gal/min

Parameters:value (float) – value for IDD Field Design Heat Recovery Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of design_heat_recovery_water_flow_rate or None if not set Return type:float

design_minimum_exhaust_temperature

field Design Minimum Exhaust Temperature

Units: C

Parameters:value (float) – value for IDD Field Design Minimum Exhaust Temperature Raises:ValueError – if value is not a valid value Returns:the value of design_minimum_exhaust_temperature or None if not set Return type:float

electric_circuit_node_name

field Electric Circuit Node Name

Parameters:value (str) – value for IDD Field Electric Circuit Node Name Raises:ValueError – if value is not a valid value Returns:the value of electric_circuit_node_name or None if not set Return type:str

exhaust_flow_curve_name

field Exhaust Flow Curve Name

curve = a + b*AT + c*AT**2

AT = Ambient Delta T

Parameters:value (str) – value for IDD Field Exhaust Flow Curve Name Raises:ValueError – if value is not a valid value Returns:the value of exhaust_flow_curve_name or None if not set Return type:str

fuel_higher_heating_value

field Fuel Higher Heating Value

Units: kJ/kg

Parameters:value (float) – value for IDD Field Fuel Higher Heating Value Raises:ValueError – if value is not a valid value Returns:the value of fuel_higher_heating_value or None if not set Return type:float

fuel_type

field Fuel Type

Default value: NaturalGas

Parameters:value (str) – value for IDD Field Fuel Type Raises:ValueError – if value is not a valid value Returns:the value of fuel_type or None if not set Return type:str

heat_recovery_inlet_node_name

field Heat Recovery Inlet Node Name

Parameters:value (str) – value for IDD Field Heat Recovery Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_inlet_node_name or None if not set Return type:str

heat_recovery_lube_energy_curve_name

field Heat Recovery Lube Energy Curve Name

curve = a + b*PLR + c*PLR**2

PLR = Ratio of Generator Load to Rated Power Output

Parameters:value (str) – value for IDD Field Heat Recovery Lube Energy Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_lube_energy_curve_name or None if not set Return type:str

heat_recovery_maximum_temperature

field Heat Recovery Maximum Temperature

Units: C

Default value: 80.0

value <= 100.0

Parameters:value (float) – value for IDD Field Heat Recovery Maximum Temperature Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_maximum_temperature or None if not set Return type:float

heat_recovery_outlet_node_name

field Heat Recovery Outlet Node Name

Parameters:value (str) – value for IDD Field Heat Recovery Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_outlet_node_name or None if not set Return type:str

maximum_exhaust_flow_per_unit_of_power_output

field Maximum Exhaust Flow per Unit of Power Output

Units: (Kg/s)/W

Parameters:value (float) – value for IDD Field Maximum Exhaust Flow per Unit of Power Output Raises:ValueError – if value is not a valid value Returns:the value of maximum_exhaust_flow_per_unit_of_power_output or None if not set Return type:float

maximum_part_load_ratio

field Maximum Part Load Ratio

value <= 1.0

Parameters:value (float) – value for IDD Field Maximum Part Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of maximum_part_load_ratio or None if not set Return type:float

minimum_part_load_ratio

field Minimum Part Load Ratio

value <= 1.0

Parameters:value (float) – value for IDD Field Minimum Part Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_part_load_ratio or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

optimum_part_load_ratio

field Optimum Part Load Ratio

Parameters:value (float) – value for IDD Field Optimum Part Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of optimum_part_load_ratio or None if not set Return type:float

outdoor_air_inlet_node_name

field Outdoor Air Inlet Node Name

Enter the name of an outdoor air node

Parameters:value (str) – value for IDD Field Outdoor Air Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_inlet_node_name or None if not set Return type:str

part_load_based_exhaust_temperature_curve_name

field Part Load Based Exhaust Temperature Curve Name

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

Parameters:value (str) – value for IDD Field Part Load Based Exhaust Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of part_load_based_exhaust_temperature_curve_name or None if not set Return type:str

part_load_based_fuel_input_curve_name

field Part Load Based Fuel Input Curve Name

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

Parameters:value (str) – value for IDD Field Part Load Based Fuel Input Curve Name Raises:ValueError – if value is not a valid value Returns:the value of part_load_based_fuel_input_curve_name or None if not set Return type:str

rated_power_output

field Rated Power Output

Units: W

Parameters:value (float) – value for IDD Field Rated Power Output Raises:ValueError – if value is not a valid value Returns:the value of rated_power_output or None if not set Return type:float

temperature_based_exhaust_temperature_curve_name

field Temperature Based Exhaust Temperature Curve Name

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

Parameters:value (str) – value for IDD Field Temperature Based Exhaust Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of temperature_based_exhaust_temperature_curve_name or None if not set Return type:str

temperature_based_fuel_input_curve_name

field Temperature Based Fuel Input Curve Name

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

Parameters:value (str) – value for IDD Field Temperature Based Fuel Input Curve Name Raises:ValueError – if value is not a valid value Returns:the value of temperature_based_fuel_input_curve_name or None if not set Return type:str

class pyidf.electric_load_center.GeneratorFuelCell

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:FuelCell This generator model is the FC model from IEA Annex 42

air_supply_name

field Air Supply Name

Enter the name of a Generator:FuelCell:AirSupply object.

Parameters:value (str) – value for IDD Field Air Supply Name Raises:ValueError – if value is not a valid value Returns:the value of air_supply_name or None if not set Return type:str

auxiliary_heater_name

field Auxiliary Heater Name

Enter the name of a Generator:FuelCell:AuxiliaryHeater object.

Parameters:value (str) – value for IDD Field Auxiliary Heater Name Raises:ValueError – if value is not a valid value Returns:the value of auxiliary_heater_name or None if not set Return type:str

electrical_storage_name

field Electrical Storage Name

Enter the name of a Generator:FuelCell:ElectricalStorage object.

Parameters:value (str) – value for IDD Field Electrical Storage Name Raises:ValueError – if value is not a valid value Returns:the value of electrical_storage_name or None if not set Return type:str

fuel_supply_name

field Fuel Supply Name

Enter the name of a Generator:FuelSupply object.

Parameters:value (str) – value for IDD Field Fuel Supply Name Raises:ValueError – if value is not a valid value Returns:the value of fuel_supply_name or None if not set Return type:str

heat_exchanger_name

field Heat Exchanger Name

Enter the name of a Generator:FuelCell:ExhaustGasToWaterHeatExchanger object.

Parameters:value (str) – value for IDD Field Heat Exchanger Name Raises:ValueError – if value is not a valid value Returns:the value of heat_exchanger_name or None if not set Return type:str

inverter_name

field Inverter Name

Enter the name of a Generator:FuelCell:Inverter object.

Parameters:value (str) – value for IDD Field Inverter Name Raises:ValueError – if value is not a valid value Returns:the value of inverter_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

power_module_name

field Power Module Name

Enter the name of a Generator:FuelCell:PowerModule object.

Parameters:value (str) – value for IDD Field Power Module Name Raises:ValueError – if value is not a valid value Returns:the value of power_module_name or None if not set Return type:str

stack_cooler_name

field Stack Cooler Name

Enter the name of a Generator:FuelCell:StackCooler object.

optional, used for PEMFC

Parameters:value (str) – value for IDD Field Stack Cooler Name Raises:ValueError – if value is not a valid value Returns:the value of stack_cooler_name or None if not set Return type:str

water_supply_name

field Water Supply Name

Enter the name of a Generator:FuelCell:WaterSupply object.

Parameters:value (str) – value for IDD Field Water Supply Name Raises:ValueError – if value is not a valid value Returns:the value of water_supply_name or None if not set Return type:str

class pyidf.electric_load_center.GeneratorFuelCellAirSupply

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:FuelCell:AirSupply Used to define details of the air supply subsystem for a fuel cell power generator.

add_extensible(constituent_1_name=None, molar_fraction_1=None)

Add values for extensible fields

Parameters:

• constituent_1_name (str) – value for IDD Field Constituent 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• molar_fraction_1 (float) – value for IDD Field Molar Fraction 1 value <= 1.0 if value is None it will not be checked against the specification and is assumed to be a missing value

air_inlet_node_name

field Air Inlet Node Name

Parameters:value (str) – value for IDD Field Air Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of air_inlet_node_name or None if not set Return type:str

air_intake_heat_recovery_mode

field Air Intake Heat Recovery Mode

Parameters:value (str) – value for IDD Field Air Intake Heat Recovery Mode Raises:ValueError – if value is not a valid value Returns:the value of air_intake_heat_recovery_mode or None if not set Return type:str

air_rate_air_temperature_coefficient

field Air Rate Air Temperature Coefficient

Parameters:value (float) – value for IDD Field Air Rate Air Temperature Coefficient Raises:ValueError – if value is not a valid value Returns:the value of air_rate_air_temperature_coefficient or None if not set Return type:float

air_rate_function_of_electric_power_curve_name

field Air Rate Function of Electric Power Curve Name

Parameters:value (str) – value for IDD Field Air Rate Function of Electric Power Curve Name Raises:ValueError – if value is not a valid value Returns:the value of air_rate_function_of_electric_power_curve_name or None if not set Return type:str

air_rate_function_of_fuel_rate_curve_name

field Air Rate Function of Fuel Rate Curve Name

Parameters:value (str) – value for IDD Field Air Rate Function of Fuel Rate Curve Name Raises:ValueError – if value is not a valid value Returns:the value of air_rate_function_of_fuel_rate_curve_name or None if not set Return type:str

air_supply_constituent_mode

field Air Supply Constituent Mode

Parameters:value (str) – value for IDD Field Air Supply Constituent Mode Raises:ValueError – if value is not a valid value Returns:the value of air_supply_constituent_mode or None if not set Return type:str

air_supply_rate_calculation_mode

field Air Supply Rate Calculation Mode

Parameters:value (str) – value for IDD Field Air Supply Rate Calculation Mode Raises:ValueError – if value is not a valid value Returns:the value of air_supply_rate_calculation_mode or None if not set Return type:str

blower_heat_loss_factor

field Blower Heat Loss Factor

value <= 1.0

Parameters:value (float) – value for IDD Field Blower Heat Loss Factor Raises:ValueError – if value is not a valid value Returns:the value of blower_heat_loss_factor or None if not set Return type:float

blower_power_curve_name

field Blower Power Curve Name

Parameters:value (str) – value for IDD Field Blower Power Curve Name Raises:ValueError – if value is not a valid value Returns:the value of blower_power_curve_name or None if not set Return type:str

extensibles

Get list of all extensibles

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

number_of_userdefined_constituents

field Number of UserDefined Constituents

value <= 5.0

Parameters:value (float) – value for IDD Field Number of UserDefined Constituents Raises:ValueError – if value is not a valid value Returns:the value of number_of_userdefined_constituents or None if not set Return type:float

stoichiometric_ratio

field Stoichiometric Ratio

This is the excess air “stoics”

the value entered is incremented by 1 in the model.

Parameters:value (float) – value for IDD Field Stoichiometric Ratio Raises:ValueError – if value is not a valid value Returns:the value of stoichiometric_ratio or None if not set Return type:float

class pyidf.electric_load_center.GeneratorFuelCellAuxiliaryHeater

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:FuelCell:AuxiliaryHeater 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).

ancillary_power_constant_term

field Ancillary Power Constant Term

Parameters:value (float) – value for IDD Field Ancillary Power Constant Term Raises:ValueError – if value is not a valid value Returns:the value of ancillary_power_constant_term or None if not set Return type:float

ancillary_power_linear_term

field Ancillary Power Linear Term

Parameters:value (float) – value for IDD Field Ancillary Power Linear Term Raises:ValueError – if value is not a valid value Returns:the value of ancillary_power_linear_term or None if not set Return type:float

excess_air_ratio

field Excess Air Ratio

Parameters:value (float) – value for IDD Field Excess Air Ratio Raises:ValueError – if value is not a valid value Returns:the value of excess_air_ratio or None if not set Return type:float

heating_capacity_units

field Heating Capacity Units

Parameters:value (str) – value for IDD Field Heating Capacity Units Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_units or None if not set Return type:str

maximum_heating_capacity_in_kmol_per_second

field Maximum Heating Capacity in Kmol per Second

Units: kmol/s

Parameters:value (float) – value for IDD Field Maximum Heating Capacity in Kmol per Second Raises:ValueError – if value is not a valid value Returns:the value of maximum_heating_capacity_in_kmol_per_second or None if not set Return type:float

maximum_heating_capacity_in_watts

field Maximum Heating Capacity in Watts

Units: W

Parameters:value (float) – value for IDD Field Maximum Heating Capacity in Watts Raises:ValueError – if value is not a valid value Returns:the value of maximum_heating_capacity_in_watts or None if not set Return type:float

minimum_heating_capacity_in_kmol_per_second

field Minimum Heating Capacity in Kmol per Second

Units: kmol/s

Parameters:value (float) – value for IDD Field Minimum Heating Capacity in Kmol per Second Raises:ValueError – if value is not a valid value Returns:the value of minimum_heating_capacity_in_kmol_per_second or None if not set Return type:float

minimum_heating_capacity_in_watts

field Minimum Heating Capacity in Watts

Units: W

Parameters:value (float) – value for IDD Field Minimum Heating Capacity in Watts Raises:ValueError – if value is not a valid value Returns:the value of minimum_heating_capacity_in_watts or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

skin_loss_destination

field Skin Loss Destination

Parameters:value (str) – value for IDD Field Skin Loss Destination Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_destination or None if not set Return type:str

skin_loss_ufactor_times_area_value

field Skin Loss U-Factor Times Area Value

Units: W/K

Parameters:value (float) – value for IDD Field Skin Loss U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_ufactor_times_area_value or None if not set Return type:float

zone_name_to_receive_skin_losses

field Zone Name to Receive Skin Losses

Parameters:value (str) – value for IDD Field Zone Name to Receive Skin Losses Raises:ValueError – if value is not a valid value Returns:the value of zone_name_to_receive_skin_losses or None if not set Return type:str

class pyidf.electric_load_center.GeneratorFuelCellElectricalStorage

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:FuelCell:ElectricalStorage 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.

choice_of_model

field Choice of Model

Parameters:value (str) – value for IDD Field Choice of Model Raises:ValueError – if value is not a valid value Returns:the value of choice_of_model or None if not set Return type:str

initial_charge_state

field Initial Charge State

Units: J

Parameters:value (float) – value for IDD Field Initial Charge State Raises:ValueError – if value is not a valid value Returns:the value of initial_charge_state or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

nominal_charging_energetic_efficiency

field Nominal Charging Energetic Efficiency

value <= 1.0

Parameters:value (float) – value for IDD Field Nominal Charging Energetic Efficiency Raises:ValueError – if value is not a valid value Returns:the value of nominal_charging_energetic_efficiency or None if not set Return type:float

nominal_discharging_energetic_efficiency

field Nominal Discharging Energetic Efficiency

value <= 1.0

Parameters:value (float) – value for IDD Field Nominal Discharging Energetic Efficiency Raises:ValueError – if value is not a valid value Returns:the value of nominal_discharging_energetic_efficiency or None if not set Return type:float

simple_maximum_capacity

field Simple Maximum Capacity

Units: J

Parameters:value (float) – value for IDD Field Simple Maximum Capacity Raises:ValueError – if value is not a valid value Returns:the value of simple_maximum_capacity or None if not set Return type:float

simple_maximum_power_draw

field Simple Maximum Power Draw

Units: W

Parameters:value (float) – value for IDD Field Simple Maximum Power Draw Raises:ValueError – if value is not a valid value Returns:the value of simple_maximum_power_draw or None if not set Return type:float

simple_maximum_power_store

field Simple Maximum Power Store

Units: W

Parameters:value (float) – value for IDD Field Simple Maximum Power Store Raises:ValueError – if value is not a valid value Returns:the value of simple_maximum_power_store or None if not set Return type:float

class pyidf.electric_load_center.GeneratorFuelCellExhaustGasToWaterHeatExchanger

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:FuelCell:ExhaustGasToWaterHeatExchanger Describes the exhaust gas heat exchanger subsystem of a fuel cell power generator used to recovery thermal energy

exhaust_outlet_air_node_name

field Exhaust Outlet Air Node Name

Parameters:value (str) – value for IDD Field Exhaust Outlet Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of exhaust_outlet_air_node_name or None if not set Return type:str

heat_exchanger_calculation_method

field Heat Exchanger Calculation Method

Parameters:value (str) – value for IDD Field Heat Exchanger Calculation Method Raises:ValueError – if value is not a valid value Returns:the value of heat_exchanger_calculation_method or None if not set Return type:str

heat_recovery_water_inlet_node_name

field Heat Recovery Water Inlet Node Name

Parameters:value (str) – value for IDD Field Heat Recovery Water Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_water_inlet_node_name or None if not set Return type:str

heat_recovery_water_maximum_flow_rate

field Heat Recovery Water Maximum Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Heat Recovery Water Maximum Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_water_maximum_flow_rate or None if not set Return type:float

heat_recovery_water_outlet_node_name

field Heat Recovery Water Outlet Node Name

Parameters:value (str) – value for IDD Field Heat Recovery Water Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_water_outlet_node_name or None if not set Return type:str

method_1_heat_exchanger_effectiveness

field Method 1 Heat Exchanger Effectiveness

Parameters:value (float) – value for IDD Field Method 1 Heat Exchanger Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of method_1_heat_exchanger_effectiveness or None if not set Return type:float

method_2_parameter_hxs0

field Method 2 Parameter hxs0

Parameters:value (float) – value for IDD Field Method 2 Parameter hxs0 Raises:ValueError – if value is not a valid value Returns:the value of method_2_parameter_hxs0 or None if not set Return type:float

method_2_parameter_hxs1

field Method 2 Parameter hxs1

Parameters:value (float) – value for IDD Field Method 2 Parameter hxs1 Raises:ValueError – if value is not a valid value Returns:the value of method_2_parameter_hxs1 or None if not set Return type:float

method_2_parameter_hxs2

field Method 2 Parameter hxs2

Parameters:value (float) – value for IDD Field Method 2 Parameter hxs2 Raises:ValueError – if value is not a valid value Returns:the value of method_2_parameter_hxs2 or None if not set Return type:float

method_2_parameter_hxs3

field Method 2 Parameter hxs3

Parameters:value (float) – value for IDD Field Method 2 Parameter hxs3 Raises:ValueError – if value is not a valid value Returns:the value of method_2_parameter_hxs3 or None if not set Return type:float

method_2_parameter_hxs4

field Method 2 Parameter hxs4

Parameters:value (float) – value for IDD Field Method 2 Parameter hxs4 Raises:ValueError – if value is not a valid value Returns:the value of method_2_parameter_hxs4 or None if not set Return type:float

method_3_f_adjustment_factor

field Method 3 F Adjustment Factor

Parameters:value (float) – value for IDD Field Method 3 F Adjustment Factor Raises:ValueError – if value is not a valid value Returns:the value of method_3_f_adjustment_factor or None if not set Return type:float

method_3_gas_area

field Method 3 Gas Area

Units: m2

Parameters:value (float) – value for IDD Field Method 3 Gas Area Raises:ValueError – if value is not a valid value Returns:the value of method_3_gas_area or None if not set Return type:float

method_3_h0_water_coefficient

field Method 3 h0 Water Coefficient

Parameters:value (float) – value for IDD Field Method 3 h0 Water Coefficient Raises:ValueError – if value is not a valid value Returns:the value of method_3_h0_water_coefficient or None if not set Return type:float

method_3_h0gas_coefficient

field Method 3 h0Gas Coefficient

Parameters:value (float) – value for IDD Field Method 3 h0Gas Coefficient Raises:ValueError – if value is not a valid value Returns:the value of method_3_h0gas_coefficient or None if not set Return type:float

method_3_m_coefficient

field Method 3 m Coefficient

Parameters:value (float) – value for IDD Field Method 3 m Coefficient Raises:ValueError – if value is not a valid value Returns:the value of method_3_m_coefficient or None if not set Return type:float

method_3_n_coefficient

field Method 3 n Coefficient

Parameters:value (float) – value for IDD Field Method 3 n Coefficient Raises:ValueError – if value is not a valid value Returns:the value of method_3_n_coefficient or None if not set Return type:float

method_3_n_dot_water_ref_coefficient

field Method 3 N dot Water ref Coefficient

Parameters:value (float) – value for IDD Field Method 3 N dot Water ref Coefficient Raises:ValueError – if value is not a valid value Returns:the value of method_3_n_dot_water_ref_coefficient or None if not set Return type:float

method_3_ndotgasref_coefficient

field Method 3 NdotGasRef Coefficient

Parameters:value (float) – value for IDD Field Method 3 NdotGasRef Coefficient Raises:ValueError – if value is not a valid value Returns:the value of method_3_ndotgasref_coefficient or None if not set Return type:float

method_3_water_area

field Method 3 Water Area

Units: m2

Parameters:value (float) – value for IDD Field Method 3 Water Area Raises:ValueError – if value is not a valid value Returns:the value of method_3_water_area or None if not set Return type:float

method_4_condensation_threshold

field Method 4 Condensation Threshold

Units: C

Parameters:value (float) – value for IDD Field Method 4 Condensation Threshold Raises:ValueError – if value is not a valid value Returns:the value of method_4_condensation_threshold or None if not set Return type:float

method_4_hxl1_coefficient

field Method 4 hxl1 Coefficient

Parameters:value (float) – value for IDD Field Method 4 hxl1 Coefficient Raises:ValueError – if value is not a valid value Returns:the value of method_4_hxl1_coefficient or None if not set Return type:float

method_4_hxl2_coefficient

field Method 4 hxl2 Coefficient

Parameters:value (float) – value for IDD Field Method 4 hxl2 Coefficient Raises:ValueError – if value is not a valid value Returns:the value of method_4_hxl2_coefficient or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

class pyidf.electric_load_center.GeneratorFuelCellInverter

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:FuelCell:Inverter 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).

efficiency_function_of_dc_power_curve_name

field Efficiency Function of DC Power Curve Name

Parameters:value (str) – value for IDD Field Efficiency Function of DC Power Curve Name Raises:ValueError – if value is not a valid value Returns:the value of efficiency_function_of_dc_power_curve_name or None if not set Return type:str

inverter_efficiency

field Inverter Efficiency

value <= 1.0

Parameters:value (float) – value for IDD Field Inverter Efficiency Raises:ValueError – if value is not a valid value Returns:the value of inverter_efficiency or None if not set Return type:float

inverter_efficiency_calculation_mode

field Inverter Efficiency Calculation Mode

Parameters:value (str) – value for IDD Field Inverter Efficiency Calculation Mode Raises:ValueError – if value is not a valid value Returns:the value of inverter_efficiency_calculation_mode or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

class pyidf.electric_load_center.GeneratorFuelCellPowerModule

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:FuelCell:PowerModule 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.

accumulated_run_time_degradation_coefficient

field Accumulated Run Time Degradation Coefficient

this is L in SOFC model specification

Parameters:value (float) – value for IDD Field Accumulated Run Time Degradation Coefficient Raises:ValueError – if value is not a valid value Returns:the value of accumulated_run_time_degradation_coefficient or None if not set Return type:float

ancillary_electricity_constant_term

field Ancillary Electricity Constant Term

Parameters:value (float) – value for IDD Field Ancillary Electricity Constant Term Raises:ValueError – if value is not a valid value Returns:the value of ancillary_electricity_constant_term or None if not set Return type:float

ancillary_electricity_linear_term

field Ancillary Electricity Linear Term

Parameters:value (float) – value for IDD Field Ancillary Electricity Linear Term Raises:ValueError – if value is not a valid value Returns:the value of ancillary_electricity_linear_term or None if not set Return type:float

constant_skin_loss_rate

field Constant Skin Loss Rate

Units: W

Parameters:value (float) – value for IDD Field Constant Skin Loss Rate Raises:ValueError – if value is not a valid value Returns:the value of constant_skin_loss_rate or None if not set Return type:float

cycling_performance_degradation_coefficient

field Cycling Performance Degradation Coefficient

this is D in SOFC model specification

Parameters:value (float) – value for IDD Field Cycling Performance Degradation Coefficient Raises:ValueError – if value is not a valid value Returns:the value of cycling_performance_degradation_coefficient or None if not set Return type:float

dilution_air_flow_rate

field Dilution Air Flow Rate

Units: kmol/s

Parameters:value (float) – value for IDD Field Dilution Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of dilution_air_flow_rate or None if not set Return type:float

dilution_inlet_air_node_name

field Dilution Inlet Air Node Name

Parameters:value (str) – value for IDD Field Dilution Inlet Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of dilution_inlet_air_node_name or None if not set Return type:str

dilution_outlet_air_node_name

field Dilution Outlet Air Node Name

Parameters:value (str) – value for IDD Field Dilution Outlet Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of dilution_outlet_air_node_name or None if not set Return type:str

efficiency_curve_mode

field Efficiency Curve Mode

Parameters:value (str) – value for IDD Field Efficiency Curve Mode Raises:ValueError – if value is not a valid value Returns:the value of efficiency_curve_mode or None if not set Return type:str

efficiency_curve_name

field Efficiency Curve Name

Parameters:value (str) – value for IDD Field Efficiency Curve Name Raises:ValueError – if value is not a valid value Returns:the value of efficiency_curve_name or None if not set Return type:str

maximum_operating_point

field Maximum Operating Point

Units: W

Parameters:value (float) – value for IDD Field Maximum Operating Point Raises:ValueError – if value is not a valid value Returns:the value of maximum_operating_point or None if not set Return type:float

minimum_operating_point

field Minimum Operating Point

Units: W

Parameters:value (float) – value for IDD Field Minimum Operating Point Raises:ValueError – if value is not a valid value Returns:the value of minimum_operating_point or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

nominal_efficiency

field Nominal Efficiency

This field is not used.

Parameters:value (float) – value for IDD Field Nominal Efficiency Raises:ValueError – if value is not a valid value Returns:the value of nominal_efficiency or None if not set Return type:float

nominal_electrical_power

field Nominal Electrical Power

This field is not used

Units: W

Parameters:value (float) – value for IDD Field Nominal Electrical Power Raises:ValueError – if value is not a valid value Returns:the value of nominal_electrical_power or None if not set Return type:float

number_of_run_hours_at_beginning_of_simulation

field Number of Run Hours at Beginning of Simulation

Units: hr

Parameters:value (float) – value for IDD Field Number of Run Hours at Beginning of Simulation Raises:ValueError – if value is not a valid value Returns:the value of number_of_run_hours_at_beginning_of_simulation or None if not set Return type:float

number_of_stops_at_start_of_simulation

field Number of Stops at Start of Simulation

this is Nstops in SOFC model specification

Parameters:value (float) – value for IDD Field Number of Stops at Start of Simulation Raises:ValueError – if value is not a valid value Returns:the value of number_of_stops_at_start_of_simulation or None if not set Return type:float

power_down_transient_limit

field Power Down Transient Limit

Maximum rate of change in electrical output [power decreasing]

Enter positive value for rate of change

Units: W/s

Parameters:value (float) – value for IDD Field Power Down Transient Limit Raises:ValueError – if value is not a valid value Returns:the value of power_down_transient_limit or None if not set Return type:float

power_up_transient_limit

field Power Up Transient Limit

Maximum rate of change in electrical output [power increasing]

Units: W/s

Parameters:value (float) – value for IDD Field Power Up Transient Limit Raises:ValueError – if value is not a valid value Returns:the value of power_up_transient_limit or None if not set Return type:float

run_time_degradation_initiation_time_threshold

field Run Time Degradation Initiation Time Threshold

Units: hr

Parameters:value (float) – value for IDD Field Run Time Degradation Initiation Time Threshold Raises:ValueError – if value is not a valid value Returns:the value of run_time_degradation_initiation_time_threshold or None if not set Return type:float

shut_down_electricity_consumption

field Shut Down Electricity Consumption

Units: J

Parameters:value (float) – value for IDD Field Shut Down Electricity Consumption Raises:ValueError – if value is not a valid value Returns:the value of shut_down_electricity_consumption or None if not set Return type:float

shut_down_fuel

field Shut Down Fuel

Units: kmol

Parameters:value (float) – value for IDD Field Shut Down Fuel Raises:ValueError – if value is not a valid value Returns:the value of shut_down_fuel or None if not set Return type:float

shut_down_time

field Shut Down Time

Units: s

Parameters:value (float) – value for IDD Field Shut Down Time Raises:ValueError – if value is not a valid value Returns:the value of shut_down_time or None if not set Return type:float

skin_loss_calculation_mode

field Skin Loss Calculation Mode

Parameters:value (str) – value for IDD Field Skin Loss Calculation Mode Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_calculation_mode or None if not set Return type:str

skin_loss_quadratic_curve_name

field Skin Loss Quadratic Curve Name

curve is function of fuel use rate

Parameters:value (str) – value for IDD Field Skin Loss Quadratic Curve Name Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_quadratic_curve_name or None if not set Return type:str

skin_loss_radiative_fraction

field Skin Loss Radiative Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Skin Loss Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_radiative_fraction or None if not set Return type:float

skin_loss_ufactor_times_area_term

field Skin Loss U-Factor Times Area Term

Units: W/K

Parameters:value (float) – value for IDD Field Skin Loss U-Factor Times Area Term Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_ufactor_times_area_term or None if not set Return type:float

stack_heat_loss_to_dilution_air

field Stack Heat loss to Dilution Air

Units: W

Parameters:value (float) – value for IDD Field Stack Heat loss to Dilution Air Raises:ValueError – if value is not a valid value Returns:the value of stack_heat_loss_to_dilution_air or None if not set Return type:float

start_up_electricity_consumption

field Start Up Electricity Consumption

Units: J

Parameters:value (float) – value for IDD Field Start Up Electricity Consumption Raises:ValueError – if value is not a valid value Returns:the value of start_up_electricity_consumption or None if not set Return type:float

start_up_electricity_produced

field Start Up Electricity Produced

Units: J

Parameters:value (float) – value for IDD Field Start Up Electricity Produced Raises:ValueError – if value is not a valid value Returns:the value of start_up_electricity_produced or None if not set Return type:float

start_up_fuel

field Start Up Fuel

Units: kmol

Parameters:value (float) – value for IDD Field Start Up Fuel Raises:ValueError – if value is not a valid value Returns:the value of start_up_fuel or None if not set Return type:float

start_up_time

field Start Up Time

Time from start up to normal operation

Units: s

Parameters:value (float) – value for IDD Field Start Up Time Raises:ValueError – if value is not a valid value Returns:the value of start_up_time or None if not set Return type:float

zone_name

field Zone Name

Parameters:value (str) – value for IDD Field Zone Name Raises:ValueError – if value is not a valid value Returns:the value of zone_name or None if not set Return type:str

class pyidf.electric_load_center.GeneratorFuelCellStackCooler

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:FuelCell:StackCooler This object is optional and is used to define details needed to model the stack cooler on PEMFC.

actual_stack_temperature

field Actual Stack Temperature

Units: C

Parameters:value (float) – value for IDD Field Actual Stack Temperature Raises:ValueError – if value is not a valid value Returns:the value of actual_stack_temperature or None if not set Return type:float

coefficient_r0

field Coefficient r0

Parameters:value (float) – value for IDD Field Coefficient r0 Raises:ValueError – if value is not a valid value Returns:the value of coefficient_r0 or None if not set Return type:float

coefficient_r1

field Coefficient r1

Parameters:value (float) – value for IDD Field Coefficient r1 Raises:ValueError – if value is not a valid value Returns:the value of coefficient_r1 or None if not set Return type:float

coefficient_r2

field Coefficient r2

Parameters:value (float) – value for IDD Field Coefficient r2 Raises:ValueError – if value is not a valid value Returns:the value of coefficient_r2 or None if not set Return type:float

coefficient_r3

field Coefficient r3

Parameters:value (float) – value for IDD Field Coefficient r3 Raises:ValueError – if value is not a valid value Returns:the value of coefficient_r3 or None if not set Return type:float

fscogen_adjustment_factor

field Fs-cogen Adjustment Factor

Parameters:value (float) – value for IDD Field Fs-cogen Adjustment Factor Raises:ValueError – if value is not a valid value Returns:the value of fscogen_adjustment_factor or None if not set Return type:float

heat_recovery_water_inlet_node_name

field Heat Recovery Water Inlet Node Name

Parameters:value (str) – value for IDD Field Heat Recovery Water Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_water_inlet_node_name or None if not set Return type:str

heat_recovery_water_outlet_node_name

field Heat Recovery Water Outlet Node Name

Parameters:value (str) – value for IDD Field Heat Recovery Water Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_water_outlet_node_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

nominal_stack_temperature

field Nominal Stack Temperature

Units: C

Parameters:value (float) – value for IDD Field Nominal Stack Temperature Raises:ValueError – if value is not a valid value Returns:the value of nominal_stack_temperature or None if not set Return type:float

stack_air_cooler_fan_coefficient_f0

field Stack Air Cooler Fan Coefficient f0

Parameters:value (float) – value for IDD Field Stack Air Cooler Fan Coefficient f0 Raises:ValueError – if value is not a valid value Returns:the value of stack_air_cooler_fan_coefficient_f0 or None if not set Return type:float

stack_air_cooler_fan_coefficient_f1

field Stack Air Cooler Fan Coefficient f1

Parameters:value (float) – value for IDD Field Stack Air Cooler Fan Coefficient f1 Raises:ValueError – if value is not a valid value Returns:the value of stack_air_cooler_fan_coefficient_f1 or None if not set Return type:float

stack_air_cooler_fan_coefficient_f2

field Stack Air Cooler Fan Coefficient f2

Parameters:value (float) – value for IDD Field Stack Air Cooler Fan Coefficient f2 Raises:ValueError – if value is not a valid value Returns:the value of stack_air_cooler_fan_coefficient_f2 or None if not set Return type:float

stack_cogeneration_exchanger_area

field Stack Cogeneration Exchanger Area

Units: m2

Parameters:value (float) – value for IDD Field Stack Cogeneration Exchanger Area Raises:ValueError – if value is not a valid value Returns:the value of stack_cogeneration_exchanger_area or None if not set Return type:float

stack_cogeneration_exchanger_nominal_flow_rate

field Stack Cogeneration Exchanger Nominal Flow Rate

Units: kg/s

Parameters:value (float) – value for IDD Field Stack Cogeneration Exchanger Nominal Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of stack_cogeneration_exchanger_nominal_flow_rate or None if not set Return type:float

stack_cogeneration_exchanger_nominal_heat_transfer_coefficient

field Stack Cogeneration Exchanger Nominal Heat Transfer Coefficient

Units: W/m2-K

Parameters:value (float) – value for IDD Field Stack Cogeneration Exchanger Nominal Heat Transfer Coefficient Raises:ValueError – if value is not a valid value Returns:the value of stack_cogeneration_exchanger_nominal_heat_transfer_coefficient or None if not set Return type:float

stack_cogeneration_exchanger_nominal_heat_transfer_coefficient_exponent

field Stack Cogeneration Exchanger Nominal Heat Transfer Coefficient Exponent

Parameters:value (float) – value for IDD Field Stack Cogeneration Exchanger Nominal Heat Transfer Coefficient Exponent Raises:ValueError – if value is not a valid value Returns:the value of stack_cogeneration_exchanger_nominal_heat_transfer_coefficient_exponent or None if not set Return type:float

stack_coolant_flow_rate

field Stack Coolant Flow Rate

Units: kg/s

Parameters:value (float) – value for IDD Field Stack Coolant Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of stack_coolant_flow_rate or None if not set Return type:float

stack_cooler_pump_heat_loss_fraction

field Stack Cooler Pump Heat Loss Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Stack Cooler Pump Heat Loss Fraction Raises:ValueError – if value is not a valid value Returns:the value of stack_cooler_pump_heat_loss_fraction or None if not set Return type:float

stack_cooler_pump_power

field Stack Cooler Pump Power

Units: W

Parameters:value (float) – value for IDD Field Stack Cooler Pump Power Raises:ValueError – if value is not a valid value Returns:the value of stack_cooler_pump_power or None if not set Return type:float

stack_cooler_ufactor_times_area_value

field Stack Cooler U-Factor Times Area Value

Units: W/K

Parameters:value (float) – value for IDD Field Stack Cooler U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of stack_cooler_ufactor_times_area_value or None if not set Return type:float

class pyidf.electric_load_center.GeneratorFuelCellWaterSupply

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:FuelCell:WaterSupply 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.

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

pump_heat_loss_factor

field Pump Heat Loss Factor

Parameters:value (float) – value for IDD Field Pump Heat Loss Factor Raises:ValueError – if value is not a valid value Returns:the value of pump_heat_loss_factor or None if not set Return type:float

reformer_water_flow_rate_function_of_fuel_rate_curve_name

field Reformer Water Flow Rate Function of Fuel Rate Curve Name

Parameters:value (str) – value for IDD Field Reformer Water Flow Rate Function of Fuel Rate Curve Name Raises:ValueError – if value is not a valid value Returns:the value of reformer_water_flow_rate_function_of_fuel_rate_curve_name or None if not set Return type:str

reformer_water_pump_power_function_of_fuel_rate_curve_name

field Reformer Water Pump Power Function of Fuel Rate Curve Name

Parameters:value (str) – value for IDD Field Reformer Water Pump Power Function of Fuel Rate Curve Name Raises:ValueError – if value is not a valid value Returns:the value of reformer_water_pump_power_function_of_fuel_rate_curve_name or None if not set Return type:str

water_temperature_modeling_mode

field Water Temperature Modeling Mode

Parameters:value (str) – value for IDD Field Water Temperature Modeling Mode Raises:ValueError – if value is not a valid value Returns:the value of water_temperature_modeling_mode or None if not set Return type:str

water_temperature_reference_node_name

field Water Temperature Reference Node Name

Parameters:value (str) – value for IDD Field Water Temperature Reference Node Name Raises:ValueError – if value is not a valid value Returns:the value of water_temperature_reference_node_name or None if not set Return type:str

water_temperature_schedule_name

field Water Temperature Schedule Name

Parameters:value (str) – value for IDD Field Water Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of water_temperature_schedule_name or None if not set Return type:str

class pyidf.electric_load_center.GeneratorFuelSupply

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:FuelSupply Used only with Generator:FuelCell and Generator:MicroCHP

compressor_heat_loss_factor

field Compressor Heat Loss Factor

value <= 1.0

Parameters:value (float) – value for IDD Field Compressor Heat Loss Factor Raises:ValueError – if value is not a valid value Returns:the value of compressor_heat_loss_factor or None if not set Return type:float

compressor_power_multiplier_function_of_fuel_rate_curve_name

field Compressor Power Multiplier Function of Fuel Rate Curve Name

Parameters:value (str) – value for IDD Field Compressor Power Multiplier Function of Fuel Rate Curve Name Raises:ValueError – if value is not a valid value Returns:the value of compressor_power_multiplier_function_of_fuel_rate_curve_name or None if not set Return type:str

constituent_10_molar_fraction

field Constituent 10 Molar Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Constituent 10 Molar Fraction Raises:ValueError – if value is not a valid value Returns:the value of constituent_10_molar_fraction or None if not set Return type:float

constituent_10_name

field Constituent 10 Name

Parameters:value (str) – value for IDD Field Constituent 10 Name Raises:ValueError – if value is not a valid value Returns:the value of constituent_10_name or None if not set Return type:str

constituent_11_molar_fraction

field Constituent 11 Molar Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Constituent 11 Molar Fraction Raises:ValueError – if value is not a valid value Returns:the value of constituent_11_molar_fraction or None if not set Return type:float

constituent_11_name

field Constituent 11 Name

Parameters:value (str) – value for IDD Field Constituent 11 Name Raises:ValueError – if value is not a valid value Returns:the value of constituent_11_name or None if not set Return type:str

constituent_12_molar_fraction

field Constituent 12 Molar Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Constituent 12 Molar Fraction Raises:ValueError – if value is not a valid value Returns:the value of constituent_12_molar_fraction or None if not set Return type:float

constituent_12_name

field Constituent 12 Name

Parameters:value (str) – value for IDD Field Constituent 12 Name Raises:ValueError – if value is not a valid value Returns:the value of constituent_12_name or None if not set Return type:str

constituent_1_molar_fraction

field Constituent 1 Molar Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Constituent 1 Molar Fraction Raises:ValueError – if value is not a valid value Returns:the value of constituent_1_molar_fraction or None if not set Return type:float

constituent_1_name

field Constituent 1 Name

Parameters:value (str) – value for IDD Field Constituent 1 Name Raises:ValueError – if value is not a valid value Returns:the value of constituent_1_name or None if not set Return type:str

constituent_2_molar_fraction

field Constituent 2 Molar Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Constituent 2 Molar Fraction Raises:ValueError – if value is not a valid value Returns:the value of constituent_2_molar_fraction or None if not set Return type:float

constituent_2_name

field Constituent 2 Name

Parameters:value (str) – value for IDD Field Constituent 2 Name Raises:ValueError – if value is not a valid value Returns:the value of constituent_2_name or None if not set Return type:str

constituent_3_molar_fraction

field Constituent 3 Molar Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Constituent 3 Molar Fraction Raises:ValueError – if value is not a valid value Returns:the value of constituent_3_molar_fraction or None if not set Return type:float

constituent_3_name

field Constituent 3 Name

Parameters:value (str) – value for IDD Field Constituent 3 Name Raises:ValueError – if value is not a valid value Returns:the value of constituent_3_name or None if not set Return type:str

constituent_4_molar_fraction

field Constituent 4 Molar Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Constituent 4 Molar Fraction Raises:ValueError – if value is not a valid value Returns:the value of constituent_4_molar_fraction or None if not set Return type:float

constituent_4_name

field Constituent 4 Name

Parameters:value (str) – value for IDD Field Constituent 4 Name Raises:ValueError – if value is not a valid value Returns:the value of constituent_4_name or None if not set Return type:str

constituent_5_molar_fraction

field Constituent 5 Molar Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Constituent 5 Molar Fraction Raises:ValueError – if value is not a valid value Returns:the value of constituent_5_molar_fraction or None if not set Return type:float

constituent_5_name

field Constituent 5 Name

Parameters:value (str) – value for IDD Field Constituent 5 Name Raises:ValueError – if value is not a valid value Returns:the value of constituent_5_name or None if not set Return type:str

constituent_6_molar_fraction

field Constituent 6 Molar Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Constituent 6 Molar Fraction Raises:ValueError – if value is not a valid value Returns:the value of constituent_6_molar_fraction or None if not set Return type:float

constituent_6_name

field Constituent 6 Name

Parameters:value (str) – value for IDD Field Constituent 6 Name Raises:ValueError – if value is not a valid value Returns:the value of constituent_6_name or None if not set Return type:str

constituent_7_molar_fraction

field Constituent 7 Molar Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Constituent 7 Molar Fraction Raises:ValueError – if value is not a valid value Returns:the value of constituent_7_molar_fraction or None if not set Return type:float

constituent_7_name

field Constituent 7 Name

Parameters:value (str) – value for IDD Field Constituent 7 Name Raises:ValueError – if value is not a valid value Returns:the value of constituent_7_name or None if not set Return type:str

constituent_8_molar_fraction

field Constituent 8 Molar Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Constituent 8 Molar Fraction Raises:ValueError – if value is not a valid value Returns:the value of constituent_8_molar_fraction or None if not set Return type:float

constituent_8_name

field Constituent 8 Name

Parameters:value (str) – value for IDD Field Constituent 8 Name Raises:ValueError – if value is not a valid value Returns:the value of constituent_8_name or None if not set Return type:str

constituent_9_molar_fraction

field Constituent 9 Molar Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Constituent 9 Molar Fraction Raises:ValueError – if value is not a valid value Returns:the value of constituent_9_molar_fraction or None if not set Return type:float

constituent_9_name

field Constituent 9 Name

Parameters:value (str) – value for IDD Field Constituent 9 Name Raises:ValueError – if value is not a valid value Returns:the value of constituent_9_name or None if not set Return type:str

fuel_temperature_modeling_mode

field Fuel Temperature Modeling Mode

Parameters:value (str) – value for IDD Field Fuel Temperature Modeling Mode Raises:ValueError – if value is not a valid value Returns:the value of fuel_temperature_modeling_mode or None if not set Return type:str

fuel_temperature_reference_node_name

field Fuel Temperature Reference Node Name

Parameters:value (str) – value for IDD Field Fuel Temperature Reference Node Name Raises:ValueError – if value is not a valid value Returns:the value of fuel_temperature_reference_node_name or None if not set Return type:str

fuel_temperature_schedule_name

field Fuel Temperature Schedule Name

Parameters:value (str) – value for IDD Field Fuel Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of fuel_temperature_schedule_name or None if not set Return type:str

fuel_type

field Fuel Type

Parameters:value (str) – value for IDD Field Fuel Type Raises:ValueError – if value is not a valid value Returns:the value of fuel_type or None if not set Return type:str

liquid_generic_fuel_co2_emission_factor

field Liquid Generic Fuel CO2 Emission Factor

Parameters:value (float) – value for IDD Field Liquid Generic Fuel CO2 Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of liquid_generic_fuel_co2_emission_factor or None if not set Return type:float

liquid_generic_fuel_higher_heating_value

field Liquid Generic Fuel Higher Heating Value

Units: kJ/kg

Parameters:value (float) – value for IDD Field Liquid Generic Fuel Higher Heating Value Raises:ValueError – if value is not a valid value Returns:the value of liquid_generic_fuel_higher_heating_value or None if not set Return type:float

liquid_generic_fuel_lower_heating_value

field Liquid Generic Fuel Lower Heating Value

Units: kJ/kg

Parameters:value (float) – value for IDD Field Liquid Generic Fuel Lower Heating Value Raises:ValueError – if value is not a valid value Returns:the value of liquid_generic_fuel_lower_heating_value or None if not set Return type:float

liquid_generic_fuel_molecular_weight

field Liquid Generic Fuel Molecular Weight

Units: g/mol

Parameters:value (float) – value for IDD Field Liquid Generic Fuel Molecular Weight Raises:ValueError – if value is not a valid value Returns:the value of liquid_generic_fuel_molecular_weight or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

number_of_constituents_in_gaseous_constituent_fuel_supply

field Number of Constituents in Gaseous Constituent Fuel Supply

value <= 12.0

Parameters:value (float) – value for IDD Field Number of Constituents in Gaseous Constituent Fuel Supply Raises:ValueError – if value is not a valid value Returns:the value of number_of_constituents_in_gaseous_constituent_fuel_supply or None if not set Return type:float

class pyidf.electric_load_center.GeneratorInternalCombustionEngine

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:InternalCombustionEngine 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.

coefficient_1_of_ufactor_times_area_curve

field Coefficient 1 of U-Factor Times Area Curve

curve = C1 * Generator Rated Power Output**C2

Parameters:value (float) – value for IDD Field Coefficient 1 of U-Factor Times Area Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_ufactor_times_area_curve or None if not set Return type:float

coefficient_2_of_ufactor_times_area_curve

field Coefficient 2 of U-Factor Times Area Curve

curve = C1 * Generator Rated Power Output**C2

typical value .9

value <= 2.0

Parameters:value (float) – value for IDD Field Coefficient 2 of U-Factor Times Area Curve Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_ufactor_times_area_curve or None if not set Return type:float

design_heat_recovery_water_flow_rate

field Design Heat Recovery Water Flow Rate

if non-zero, then inlet, outlet nodes must be entered.

Units: m3/s

IP-Units: gal/min

Parameters:value (float) – value for IDD Field Design Heat Recovery Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of design_heat_recovery_water_flow_rate or None if not set Return type:float

design_minimum_exhaust_temperature

field Design Minimum Exhaust Temperature

Units: C

Parameters:value (float) – value for IDD Field Design Minimum Exhaust Temperature Raises:ValueError – if value is not a valid value Returns:the value of design_minimum_exhaust_temperature or None if not set Return type:float

electric_circuit_node_name

field Electric Circuit Node Name

Parameters:value (str) – value for IDD Field Electric Circuit Node Name Raises:ValueError – if value is not a valid value Returns:the value of electric_circuit_node_name or None if not set Return type:str

exhaust_temperature_curve_name

field Exhaust Temperature Curve Name

curve = a + b*PLR + c*PLR**2

PLR = Ratio of Generator Load to Rated Power Output

Parameters:value (str) – value for IDD Field Exhaust Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of exhaust_temperature_curve_name or None if not set Return type:str

fuel_higher_heating_value

field Fuel Higher Heating Value

Units: kJ/kg

Parameters:value (float) – value for IDD Field Fuel Higher Heating Value Raises:ValueError – if value is not a valid value Returns:the value of fuel_higher_heating_value or None if not set Return type:float

fuel_type

field Fuel Type

Default value: Diesel

Parameters:value (str) – value for IDD Field Fuel Type Raises:ValueError – if value is not a valid value Returns:the value of fuel_type or None if not set Return type:str

heat_recovery_inlet_node_name

field Heat Recovery Inlet Node Name

Parameters:value (str) – value for IDD Field Heat Recovery Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_inlet_node_name or None if not set Return type:str

heat_recovery_maximum_temperature

field Heat Recovery Maximum Temperature

Units: C

Default value: 80.0

value <= 100.0

Parameters:value (float) – value for IDD Field Heat Recovery Maximum Temperature Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_maximum_temperature or None if not set Return type:float

heat_recovery_outlet_node_name

field Heat Recovery Outlet Node Name

Parameters:value (str) – value for IDD Field Heat Recovery Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_outlet_node_name or None if not set Return type:str

jacket_heat_recovery_curve_name

field Jacket Heat Recovery Curve Name

curve = a + b*PLR + c*PLR**2

PLR = Ratio of Generator Load to Rated Power Output

Parameters:value (str) – value for IDD Field Jacket Heat Recovery Curve Name Raises:ValueError – if value is not a valid value Returns:the value of jacket_heat_recovery_curve_name or None if not set Return type:str

lube_heat_recovery_curve_name

field Lube Heat Recovery Curve Name

curve = a + b*PLR + c*PLR**2

PLR = Ratio of Generator Load to Rated Power Output

Parameters:value (str) – value for IDD Field Lube Heat Recovery Curve Name Raises:ValueError – if value is not a valid value Returns:the value of lube_heat_recovery_curve_name or None if not set Return type:str

maximum_exhaust_flow_per_unit_of_power_output

field Maximum Exhaust Flow per Unit of Power Output

Units: (kg/s)/W

Parameters:value (float) – value for IDD Field Maximum Exhaust Flow per Unit of Power Output Raises:ValueError – if value is not a valid value Returns:the value of maximum_exhaust_flow_per_unit_of_power_output or None if not set Return type:float

maximum_part_load_ratio

field Maximum Part Load Ratio

value <= 1.0

Parameters:value (float) – value for IDD Field Maximum Part Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of maximum_part_load_ratio or None if not set Return type:float

minimum_part_load_ratio

field Minimum Part Load Ratio

value <= 1.0

Parameters:value (float) – value for IDD Field Minimum Part Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_part_load_ratio or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

optimum_part_load_ratio

field Optimum Part Load Ratio

Parameters:value (float) – value for IDD Field Optimum Part Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of optimum_part_load_ratio or None if not set Return type:float

rated_power_output

field Rated Power Output

Units: W

Parameters:value (float) – value for IDD Field Rated Power Output Raises:ValueError – if value is not a valid value Returns:the value of rated_power_output or None if not set Return type:float

shaft_power_curve_name

field Shaft Power Curve Name

curve = a + b*PLR + c*PLR**2

PLR = Ratio of Generator Load to Rated Power Output

Parameters:value (str) – value for IDD Field Shaft Power Curve Name Raises:ValueError – if value is not a valid value Returns:the value of shaft_power_curve_name or None if not set Return type:str

total_exhaust_energy_curve_name

field Total Exhaust Energy Curve Name

curve = a + b*PLR + c*PLR**2

PLR = Ratio of Generator Load to Rated Power Output

Parameters:value (str) – value for IDD Field Total Exhaust Energy Curve Name Raises:ValueError – if value is not a valid value Returns:the value of total_exhaust_energy_curve_name or None if not set Return type:str

class pyidf.electric_load_center.GeneratorMicroChp

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:MicroCHP 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.

air_inlet_node_name

field Air Inlet Node Name

Parameters:value (str) – value for IDD Field Air Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of air_inlet_node_name or None if not set Return type:str

air_outlet_node_name

field Air Outlet Node Name

Parameters:value (str) – value for IDD Field Air Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of air_outlet_node_name or None if not set Return type:str

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule_name or None if not set Return type:str

cooling_water_inlet_node_name

field Cooling Water Inlet Node Name

Parameters:value (str) – value for IDD Field Cooling Water Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_water_inlet_node_name or None if not set Return type:str

cooling_water_outlet_node_name

field Cooling Water Outlet Node Name

Parameters:value (str) – value for IDD Field Cooling Water Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_water_outlet_node_name or None if not set Return type:str

generator_fuel_supply_name

field Generator Fuel Supply Name

Enter the name of a Generator:FuelSupply object.

Parameters:value (str) – value for IDD Field Generator Fuel Supply Name Raises:ValueError – if value is not a valid value Returns:the value of generator_fuel_supply_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

performance_parameters_name

field Performance Parameters Name

Enter the name of a Generator:MicroCHP:NonNormalizedParameters object.

Parameters:value (str) – value for IDD Field Performance Parameters Name Raises:ValueError – if value is not a valid value Returns:the value of performance_parameters_name or None if not set Return type:str

zone_name

field Zone Name

Parameters:value (str) – value for IDD Field Zone Name Raises:ValueError – if value is not a valid value Returns:the value of zone_name or None if not set Return type:str

class pyidf.electric_load_center.GeneratorMicroChpNonNormalizedParameters

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:MicroCHP:NonNormalizedParameters This object is referenced by a Generator:MicroCHP object and provides the non-normalized parameters for the MicroCHP generator model.

aggregated_thermal_mass_of_energy_conversion_portion_of_generator

field Aggregated Thermal Mass of Energy Conversion Portion of Generator

Units: W/K

Parameters:value (float) – value for IDD Field Aggregated Thermal Mass of Energy Conversion Portion of Generator Raises:ValueError – if value is not a valid value Returns:the value of aggregated_thermal_mass_of_energy_conversion_portion_of_generator or None if not set Return type:float

aggregated_thermal_mass_of_heat_recovery_portion_of_generator

field Aggregated Thermal Mass of Heat Recovery Portion of Generator

Units: W/K

Parameters:value (float) – value for IDD Field Aggregated Thermal Mass of Heat Recovery Portion of Generator Raises:ValueError – if value is not a valid value Returns:the value of aggregated_thermal_mass_of_heat_recovery_portion_of_generator or None if not set Return type:float

air_flow_rate_curve_name

field Air Flow Rate Curve Name

Parameters:value (str) – value for IDD Field Air Flow Rate Curve Name Raises:ValueError – if value is not a valid value Returns:the value of air_flow_rate_curve_name or None if not set Return type:str

cool_down_delay_time

field Cool Down Delay Time

Units: s

Parameters:value (float) – value for IDD Field Cool Down Delay Time Raises:ValueError – if value is not a valid value Returns:the value of cool_down_delay_time or None if not set Return type:float

cool_down_power

field Cool Down Power

Units: W

Parameters:value (float) – value for IDD Field Cool Down Power Raises:ValueError – if value is not a valid value Returns:the value of cool_down_power or None if not set Return type:float

cooling_water_flow_rate_curve_name

field Cooling Water Flow Rate Curve Name

Parameters:value (str) – value for IDD Field Cooling Water Flow Rate Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_water_flow_rate_curve_name or None if not set Return type:str

cooling_water_flow_rate_mode

field Cooling Water Flow Rate Mode

Parameters:value (str) – value for IDD Field Cooling Water Flow Rate Mode Raises:ValueError – if value is not a valid value Returns:the value of cooling_water_flow_rate_mode or None if not set Return type:str

electrical_efficiency_curve_name

field Electrical Efficiency Curve Name

TriQuadratic

Parameters:value (str) – value for IDD Field Electrical Efficiency Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electrical_efficiency_curve_name or None if not set Return type:str

heat_exchanger_ufactor_times_area_value

field Heat Exchanger U-Factor Times Area Value

Units: W/K

Parameters:value (float) – value for IDD Field Heat Exchanger U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of heat_exchanger_ufactor_times_area_value or None if not set Return type:float

maximum_cooling_water_temperature

field Maximum Cooling Water Temperature

Units: C

Parameters:value (float) – value for IDD Field Maximum Cooling Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_cooling_water_temperature or None if not set Return type:float

maximum_electric_power

field Maximum Electric Power

Units: W

Parameters:value (float) – value for IDD Field Maximum Electric Power Raises:ValueError – if value is not a valid value Returns:the value of maximum_electric_power or None if not set Return type:float

maximum_fuel_flow_rate_of_change

field Maximum Fuel Flow Rate of Change

Units: kg/s2

Parameters:value (float) – value for IDD Field Maximum Fuel Flow Rate of Change Raises:ValueError – if value is not a valid value Returns:the value of maximum_fuel_flow_rate_of_change or None if not set Return type:float

maximum_net_electrical_power_rate_of_change

field Maximum Net Electrical Power Rate of Change

Units: W/s

Parameters:value (float) – value for IDD Field Maximum Net Electrical Power Rate of Change Raises:ValueError – if value is not a valid value Returns:the value of maximum_net_electrical_power_rate_of_change or None if not set Return type:float

minimum_cooling_water_flow_rate

field Minimum Cooling Water Flow Rate

Units: kg/s

Parameters:value (float) – value for IDD Field Minimum Cooling Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of minimum_cooling_water_flow_rate or None if not set Return type:float

minimum_electric_power

field Minimum Electric Power

Units: W

Parameters:value (float) – value for IDD Field Minimum Electric Power Raises:ValueError – if value is not a valid value Returns:the value of minimum_electric_power or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

nominal_engine_operating_temperature

field Nominal Engine Operating Temperature

Units: C

Parameters:value (float) – value for IDD Field Nominal Engine Operating Temperature Raises:ValueError – if value is not a valid value Returns:the value of nominal_engine_operating_temperature or None if not set Return type:float

restart_mode

field Restart Mode

Parameters:value (str) – value for IDD Field Restart Mode Raises:ValueError – if value is not a valid value Returns:the value of restart_mode or None if not set Return type:str

skin_loss_radiative_fraction

field Skin Loss Radiative Fraction

Parameters:value (float) – value for IDD Field Skin Loss Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_radiative_fraction or None if not set Return type:float

skin_loss_ufactor_times_area_value

field Skin Loss U-Factor Times Area Value

Units: W/K

Parameters:value (float) – value for IDD Field Skin Loss U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_ufactor_times_area_value or None if not set Return type:float

standby_power

field Standby Power

Units: W

Parameters:value (float) – value for IDD Field Standby Power Raises:ValueError – if value is not a valid value Returns:the value of standby_power or None if not set Return type:float

thermal_efficiency_curve_name

field Thermal Efficiency Curve Name

TriQuadratic

Parameters:value (str) – value for IDD Field Thermal Efficiency Curve Name Raises:ValueError – if value is not a valid value Returns:the value of thermal_efficiency_curve_name or None if not set Return type:str

warm_up_delay_time

field Warm Up Delay Time

Units: s

Parameters:value (float) – value for IDD Field Warm Up Delay Time Raises:ValueError – if value is not a valid value Returns:the value of warm_up_delay_time or None if not set Return type:float

warm_up_fuel_flow_rate_coefficient

field Warm Up Fuel Flow Rate Coefficient

Parameters:value (float) – value for IDD Field Warm Up Fuel Flow Rate Coefficient Raises:ValueError – if value is not a valid value Returns:the value of warm_up_fuel_flow_rate_coefficient or None if not set Return type:float

warm_up_fuel_flow_rate_limit_ratio

field Warm Up Fuel Flow Rate Limit Ratio

Parameters:value (float) – value for IDD Field Warm Up Fuel Flow Rate Limit Ratio Raises:ValueError – if value is not a valid value Returns:the value of warm_up_fuel_flow_rate_limit_ratio or None if not set Return type:float

warm_up_mode

field Warm Up Mode

Stirling engines use Nominal Engine Temperature

Internal combustion engines use Time Delay

Parameters:value (str) – value for IDD Field Warm Up Mode Raises:ValueError – if value is not a valid value Returns:the value of warm_up_mode or None if not set Return type:str

warm_up_power_coefficient

field Warm Up Power Coefficient

Parameters:value (float) – value for IDD Field Warm Up Power Coefficient Raises:ValueError – if value is not a valid value Returns:the value of warm_up_power_coefficient or None if not set Return type:float

class pyidf.electric_load_center.GeneratorMicroTurbine

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:MicroTurbine 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.

ancillary_power

field Ancillary Power

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.

Units: W

Parameters:value (float) – value for IDD Field Ancillary Power Raises:ValueError – if value is not a valid value Returns:the value of ancillary_power or None if not set Return type:float

ancillary_power_function_of_fuel_input_curve_name

field Ancillary Power Function of Fuel Input Curve Name

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.

Parameters:value (str) – value for IDD Field Ancillary Power Function of Fuel Input Curve Name Raises:ValueError – if value is not a valid value Returns:the value of ancillary_power_function_of_fuel_input_curve_name or None if not set Return type:str

combustion_air_inlet_node_name

field Combustion Air Inlet Node Name

Must be an outdoor air node.

Parameters:value (str) – value for IDD Field Combustion Air Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of combustion_air_inlet_node_name or None if not set Return type:str

combustion_air_outlet_node_name

field Combustion Air Outlet Node Name

Parameters:value (str) – value for IDD Field Combustion Air Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of combustion_air_outlet_node_name or None if not set Return type:str

electrical_efficiency_function_of_part_load_ratio_curve_name

field Electrical Efficiency Function of Part Load Ratio Curve Name

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

Parameters:value (str) – value for IDD Field Electrical Efficiency Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electrical_efficiency_function_of_part_load_ratio_curve_name or None if not set Return type:str

electrical_efficiency_function_of_temperature_curve_name

field Electrical Efficiency Function of Temperature Curve Name

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)

Parameters:value (str) – value for IDD Field Electrical Efficiency Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electrical_efficiency_function_of_temperature_curve_name or None if not set Return type:str

electrical_power_function_of_temperature_and_elevation_curve_name

field Electrical Power Function of Temperature and Elevation Curve Name

curve = a + b*T + c*T**2 + d*Elev + e*Elev**2 + f*T*Elev

T = combustion air inlet temperature (C)

Elev = elevation (m)

Parameters:value (str) – value for IDD Field Electrical Power Function of Temperature and Elevation Curve Name Raises:ValueError – if value is not a valid value Returns:the value of electrical_power_function_of_temperature_and_elevation_curve_name or None if not set Return type:str

exhaust_air_flow_rate_function_of_part_load_ratio_curve_name

field Exhaust Air Flow Rate Function of Part Load Ratio Curve Name

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.

Parameters:value (str) – value for IDD Field Exhaust Air Flow Rate Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of exhaust_air_flow_rate_function_of_part_load_ratio_curve_name or None if not set Return type:str

exhaust_air_flow_rate_function_of_temperature_curve_name

field Exhaust Air Flow Rate Function of Temperature Curve Name

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.

Parameters:value (str) – value for IDD Field Exhaust Air Flow Rate Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of exhaust_air_flow_rate_function_of_temperature_curve_name or None if not set Return type:str

exhaust_air_temperature_function_of_part_load_ratio_curve_name

field Exhaust Air Temperature Function of Part Load Ratio Curve Name

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.

Parameters:value (str) – value for IDD Field Exhaust Air Temperature Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of exhaust_air_temperature_function_of_part_load_ratio_curve_name or None if not set Return type:str

exhaust_air_temperature_function_of_temperature_curve_name

field Exhaust Air Temperature Function of Temperature Curve Name

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.

Parameters:value (str) – value for IDD Field Exhaust Air Temperature Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of exhaust_air_temperature_function_of_temperature_curve_name or None if not set Return type:str

fuel_higher_heating_value

field Fuel Higher Heating Value

Units: kJ/kg

Default value: 50000.0

Parameters:value (float) – value for IDD Field Fuel Higher Heating Value Raises:ValueError – if value is not a valid value Returns:the value of fuel_higher_heating_value or None if not set Return type:float

fuel_lower_heating_value

field Fuel Lower Heating Value

Units: kJ/kg

Default value: 45450.0

Parameters:value (float) – value for IDD Field Fuel Lower Heating Value Raises:ValueError – if value is not a valid value Returns:the value of fuel_lower_heating_value or None if not set Return type:float

fuel_type

field Fuel Type

Default value: NaturalGas

Parameters:value (str) – value for IDD Field Fuel Type Raises:ValueError – if value is not a valid value Returns:the value of fuel_type or None if not set Return type:str

heat_recovery_rate_function_of_inlet_water_temperature_curve_name

field Heat Recovery Rate Function of Inlet Water Temperature Curve Name

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.

Parameters:value (str) – value for IDD Field Heat Recovery Rate Function of Inlet Water Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_rate_function_of_inlet_water_temperature_curve_name or None if not set Return type:str

heat_recovery_rate_function_of_part_load_ratio_curve_name

field Heat Recovery Rate Function of Part Load Ratio Curve Name

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.

Parameters:value (str) – value for IDD Field Heat Recovery Rate Function of Part Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_rate_function_of_part_load_ratio_curve_name or None if not set Return type:str

heat_recovery_rate_function_of_water_flow_rate_curve_name

field Heat Recovery Rate Function of Water Flow Rate Curve Name

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.

Parameters:value (str) – value for IDD Field Heat Recovery Rate Function of Water Flow Rate Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_rate_function_of_water_flow_rate_curve_name or None if not set Return type:str

heat_recovery_water_flow_operating_mode

field Heat Recovery Water Flow Operating Mode

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.

Default value: PlantControl

Parameters:value (str) – value for IDD Field Heat Recovery Water Flow Operating Mode Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_water_flow_operating_mode or None if not set Return type:str

heat_recovery_water_flow_rate_function_of_temperature_and_power_curve_name

field Heat Recovery Water Flow Rate Function of Temperature and Power Curve Name

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.

Parameters:value (str) – value for IDD Field Heat Recovery Water Flow Rate Function of Temperature and Power Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_water_flow_rate_function_of_temperature_and_power_curve_name or None if not set Return type:str

heat_recovery_water_inlet_node_name

field Heat Recovery Water Inlet Node Name

Parameters:value (str) – value for IDD Field Heat Recovery Water Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_water_inlet_node_name or None if not set Return type:str

heat_recovery_water_outlet_node_name

field Heat Recovery Water Outlet Node Name

Parameters:value (str) – value for IDD Field Heat Recovery Water Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_water_outlet_node_name or None if not set Return type:str

maximum_full_load_electrical_power_output

field Maximum Full Load Electrical Power Output

If left blank, Maximum Full Load Electrical Power Output will be set

equal to the Reference Electrical Power Output.

Units: W

Parameters:value (float) – value for IDD Field Maximum Full Load Electrical Power Output Raises:ValueError – if value is not a valid value Returns:the value of maximum_full_load_electrical_power_output or None if not set Return type:float

maximum_heat_recovery_water_flow_rate

field Maximum Heat Recovery Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Maximum Heat Recovery Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of maximum_heat_recovery_water_flow_rate or None if not set Return type:float

maximum_heat_recovery_water_temperature

field Maximum Heat Recovery Water Temperature

Units: C

Parameters:value (float) – value for IDD Field Maximum Heat Recovery Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_heat_recovery_water_temperature or None if not set Return type:float

minimum_full_load_electrical_power_output

field Minimum Full Load Electrical Power Output

Units: W

Parameters:value (float) – value for IDD Field Minimum Full Load Electrical Power Output Raises:ValueError – if value is not a valid value Returns:the value of minimum_full_load_electrical_power_output or None if not set Return type:float

minimum_heat_recovery_water_flow_rate

field Minimum Heat Recovery Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Minimum Heat Recovery Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of minimum_heat_recovery_water_flow_rate or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

nominal_exhaust_air_outlet_temperature

field Nominal Exhaust Air Outlet Temperature

Exhaust air outlet temperature at reference conditions.

Parameters:value (float) – value for IDD Field Nominal Exhaust Air Outlet Temperature Raises:ValueError – if value is not a valid value Returns:the value of nominal_exhaust_air_outlet_temperature or None if not set Return type:float

reference_combustion_air_inlet_humidity_ratio

field Reference Combustion Air Inlet Humidity Ratio

Units: kgWater/kgDryAir

Default value: 0.00638

Parameters:value (float) – value for IDD Field Reference Combustion Air Inlet Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of reference_combustion_air_inlet_humidity_ratio or None if not set Return type:float

reference_combustion_air_inlet_temperature

field Reference Combustion Air Inlet Temperature

Units: C

Default value: 15.0

Parameters:value (float) – value for IDD Field Reference Combustion Air Inlet Temperature Raises:ValueError – if value is not a valid value Returns:the value of reference_combustion_air_inlet_temperature or None if not set Return type:float

reference_electrical_efficiency_using_lower_heating_value

field Reference Electrical Efficiency Using Lower Heating Value

Electric power output divided by fuel energy input (LHV basis)

at reference conditions.

value <= 1.0

Parameters:value (float) – value for IDD Field Reference Electrical Efficiency Using Lower Heating Value Raises:ValueError – if value is not a valid value Returns:the value of reference_electrical_efficiency_using_lower_heating_value or None if not set Return type:float

reference_electrical_power_output

field Reference Electrical Power Output

Units: W

Parameters:value (float) – value for IDD Field Reference Electrical Power Output Raises:ValueError – if value is not a valid value Returns:the value of reference_electrical_power_output or None if not set Return type:float

reference_elevation

field Reference Elevation

Units: m

value >= -300.0

Parameters:value (float) – value for IDD Field Reference Elevation Raises:ValueError – if value is not a valid value Returns:the value of reference_elevation or None if not set Return type:float

reference_exhaust_air_mass_flow_rate

field Reference Exhaust Air Mass Flow Rate

Units: kg/s

Parameters:value (float) – value for IDD Field Reference Exhaust Air Mass Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of reference_exhaust_air_mass_flow_rate or None if not set Return type:float

reference_heat_recovery_water_flow_rate

field Reference Heat Recovery Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Reference Heat Recovery Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of reference_heat_recovery_water_flow_rate or None if not set Return type:float

reference_inlet_water_temperature

field Reference Inlet Water Temperature

Units: C

Parameters:value (float) – value for IDD Field Reference Inlet Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of reference_inlet_water_temperature or None if not set Return type:float

reference_thermal_efficiency_using_lower_heat_value

field Reference Thermal Efficiency Using Lower Heat Value

Reference thermal efficiency (heat recovery to water) based on the

Lower Heating Value (LHV) of the fuel.

value <= 1.0

Parameters:value (float) – value for IDD Field Reference Thermal Efficiency Using Lower Heat Value Raises:ValueError – if value is not a valid value Returns:the value of reference_thermal_efficiency_using_lower_heat_value or None if not set Return type:float

standby_power

field Standby Power

Electric power consumed when the generator is available but not being called

by the Electric Load Center.

Units: W

Parameters:value (float) – value for IDD Field Standby Power Raises:ValueError – if value is not a valid value Returns:the value of standby_power or None if not set Return type:float

thermal_efficiency_function_of_temperature_and_elevation_curve_name

field Thermal Efficiency Function of Temperature and Elevation Curve Name

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.

Parameters:value (str) – value for IDD Field Thermal Efficiency Function of Temperature and Elevation Curve Name Raises:ValueError – if value is not a valid value Returns:the value of thermal_efficiency_function_of_temperature_and_elevation_curve_name or None if not set Return type:str

class pyidf.electric_load_center.GeneratorPhotovoltaic

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:Photovoltaic 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.

heat_transfer_integration_mode

field Heat Transfer Integration Mode

Default value: Decoupled

Parameters:value (str) – value for IDD Field Heat Transfer Integration Mode Raises:ValueError – if value is not a valid value Returns:the value of heat_transfer_integration_mode or None if not set Return type:str

module_performance_name

field Module Performance Name

PV array modeling details

Parameters:value (str) – value for IDD Field Module Performance Name Raises:ValueError – if value is not a valid value Returns:the value of module_performance_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

number_of_modules_in_series

field Number of Modules in Series

Number of PV modules wired in series for each string.

Units: dimensionless

Default value: 1.0

value >= 1.0

Parameters:value (float) – value for IDD Field Number of Modules in Series Raises:ValueError – if value is not a valid value Returns:the value of number_of_modules_in_series or None if not set Return type:float

number_of_series_strings_in_parallel

field Number of Series Strings in Parallel

number of series-wired strings of PV modules that are in parallel

Units: dimensionless

Default value: 1.0

value >= 1.0

Parameters:value (float) – value for IDD Field Number of Series Strings in Parallel Raises:ValueError – if value is not a valid value Returns:the value of number_of_series_strings_in_parallel or None if not set Return type:float

photovoltaic_performance_object_type

field Photovoltaic Performance Object Type

Parameters:value (str) – value for IDD Field Photovoltaic Performance Object Type Raises:ValueError – if value is not a valid value Returns:the value of photovoltaic_performance_object_type or None if not set Return type:str

surface_name

field Surface Name

Parameters:value (str) – value for IDD Field Surface Name Raises:ValueError – if value is not a valid value Returns:the value of surface_name or None if not set Return type:str

class pyidf.electric_load_center.GeneratorWindTurbine

Bases: pyidf.helper.DataObject

Corresponds to IDD object Generator:WindTurbine Wind turbine generator.

annual_local_average_wind_speed

field Annual Local Average Wind Speed

Units: m/s

Parameters:value (float) – value for IDD Field Annual Local Average Wind Speed Raises:ValueError – if value is not a valid value Returns:the value of annual_local_average_wind_speed or None if not set Return type:float

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule_name or None if not set Return type:str

blade_chord_area

field Blade Chord Area

Units: m2

Parameters:value (float) – value for IDD Field Blade Chord Area Raises:ValueError – if value is not a valid value Returns:the value of blade_chord_area or None if not set Return type:float

blade_drag_coefficient

field Blade Drag Coefficient

This field is only for Vertical Axis Wind Turbine..

The user must input this field if the rotor type is Vertical Axis Wind Turbine.

Default value: 0.9

Parameters:value (float) – value for IDD Field Blade Drag Coefficient Raises:ValueError – if value is not a valid value Returns:the value of blade_drag_coefficient or None if not set Return type:float

blade_lift_coefficient

field Blade Lift Coefficient

This field is only for Vertical Axis Wind Turbine..

The user must input this field if the rotor type is Vertical Axis Wind Turbine.

Default value: 0.05

Parameters:value (float) – value for IDD Field Blade Lift Coefficient Raises:ValueError – if value is not a valid value Returns:the value of blade_lift_coefficient or None if not set Return type:float

cut_in_wind_speed

field Cut In Wind Speed

Units: m/s

Parameters:value (float) – value for IDD Field Cut In Wind Speed Raises:ValueError – if value is not a valid value Returns:the value of cut_in_wind_speed or None if not set Return type:float

cut_out_wind_speed

field Cut Out Wind Speed

Units: m/s

Parameters:value (float) – value for IDD Field Cut Out Wind Speed Raises:ValueError – if value is not a valid value Returns:the value of cut_out_wind_speed or None if not set Return type:float

fraction_system_efficiency

field Fraction system Efficiency

Default value: 0.835

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction system Efficiency Raises:ValueError – if value is not a valid value Returns:the value of fraction_system_efficiency or None if not set Return type:float

height_for_local_average_wind_speed

field Height for Local Average Wind Speed

Units: m

Default value: 50.0

Parameters:value (float) – value for IDD Field Height for Local Average Wind Speed Raises:ValueError – if value is not a valid value Returns:the value of height_for_local_average_wind_speed or None if not set Return type:float

maximum_power_coefficient

field Maximum Power Coefficient

This field should be input if the rotor type is Horizontal Axis Wind Turbine

Default value: 0.25

value <= 0.59

Parameters:value (float) – value for IDD Field Maximum Power Coefficient Raises:ValueError – if value is not a valid value Returns:the value of maximum_power_coefficient or None if not set Return type:float

maximum_tip_speed_ratio

field Maximum Tip Speed Ratio

Default value: 5.0

value <= 12.0

Parameters:value (float) – value for IDD Field Maximum Tip Speed Ratio Raises:ValueError – if value is not a valid value Returns:the value of maximum_tip_speed_ratio or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

number_of_blades

field Number of Blades

Default value: 3.0

value >= 2.0

Parameters:value (float) – value for IDD Field Number of Blades Raises:ValueError – if value is not a valid value Returns:the value of number_of_blades or None if not set Return type:float

overall_height

field Overall Height

This field is the height of the hub for the Horizontal Axis Wind Turbines and

of the pole for the Vertical Axis Wind Turbines.

Units: m

Parameters:value (float) – value for IDD Field Overall Height Raises:ValueError – if value is not a valid value Returns:the value of overall_height or None if not set Return type:float

power_coefficient_c1

field Power Coefficient C1

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.

Default value: 0.5176

Parameters:value (float) – value for IDD Field Power Coefficient C1 Raises:ValueError – if value is not a valid value Returns:the value of power_coefficient_c1 or None if not set Return type:float

power_coefficient_c2

field Power Coefficient C2

Default value: 116.0

Parameters:value (float) – value for IDD Field Power Coefficient C2 Raises:ValueError – if value is not a valid value Returns:the value of power_coefficient_c2 or None if not set Return type:float

power_coefficient_c3

field Power Coefficient C3

Default value: 0.4

Parameters:value (float) – value for IDD Field Power Coefficient C3 Raises:ValueError – if value is not a valid value Returns:the value of power_coefficient_c3 or None if not set Return type:float

power_coefficient_c4

field Power Coefficient C4

Parameters:value (float) – value for IDD Field Power Coefficient C4 Raises:ValueError – if value is not a valid value Returns:the value of power_coefficient_c4 or None if not set Return type:float

power_coefficient_c5

field Power Coefficient C5

Default value: 5.0

Parameters:value (float) – value for IDD Field Power Coefficient C5 Raises:ValueError – if value is not a valid value Returns:the value of power_coefficient_c5 or None if not set Return type:float

power_coefficient_c6

field Power Coefficient C6

Default value: 21.0

Parameters:value (float) – value for IDD Field Power Coefficient C6 Raises:ValueError – if value is not a valid value Returns:the value of power_coefficient_c6 or None if not set Return type:float

power_control

field Power Control

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

Default value: VariableSpeedVariablePitch

Parameters:value (str) – value for IDD Field Power Control Raises:ValueError – if value is not a valid value Returns:the value of power_control or None if not set Return type:str

rated_power

field Rated Power

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.

Units: W

Parameters:value (float) – value for IDD Field Rated Power Raises:ValueError – if value is not a valid value Returns:the value of rated_power or None if not set Return type:float

rated_rotor_speed

field Rated Rotor Speed

Units: rev/min

Parameters:value (float) – value for IDD Field Rated Rotor Speed Raises:ValueError – if value is not a valid value Returns:the value of rated_rotor_speed or None if not set Return type:float

rated_wind_speed

field Rated Wind Speed

Units: m/s

Parameters:value (float) – value for IDD Field Rated Wind Speed Raises:ValueError – if value is not a valid value Returns:the value of rated_wind_speed or None if not set Return type:float

rotor_diameter

field Rotor Diameter

This field is the diameter of the perpendicular circle of the Vertical Axis Wind Turbine system

from the upright pole on the ground.

Units: m

Parameters:value (float) – value for IDD Field Rotor Diameter Raises:ValueError – if value is not a valid value Returns:the value of rotor_diameter or None if not set Return type:float

rotor_type

field Rotor Type

allowed values are: Horizontal Axis Wind Turbine or Vertical Axis Wind Turbine

Default value: HorizontalAxisWindTurbine

Parameters:value (str) – value for IDD Field Rotor Type Raises:ValueError – if value is not a valid value Returns:the value of rotor_type or None if not set Return type:str

class pyidf.electric_load_center.PhotovoltaicPerformanceEquivalentOneDiode

Bases: pyidf.helper.DataObject

Corresponds to IDD object PhotovoltaicPerformance:EquivalentOne-Diode 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.

active_area

field Active Area

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.

Units: m2

Default value: 0.89

value >= 0.1

Parameters:value (float) – value for IDD Field Active Area Raises:ValueError – if value is not a valid value Returns:the value of active_area or None if not set Return type:float

cell_type

field Cell type

Parameters:value (str) – value for IDD Field Cell type Raises:ValueError – if value is not a valid value Returns:the value of cell_type or None if not set Return type:str

module_current_at_maximum_power

field Module Current at Maximum Power

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.

Units: A

Default value: 5.9

Parameters:value (float) – value for IDD Field Module Current at Maximum Power Raises:ValueError – if value is not a valid value Returns:the value of module_current_at_maximum_power or None if not set Return type:float

module_heat_loss_coefficient

field Module Heat Loss Coefficient

Units: W/m2-K

Default value: 30.0

Parameters:value (float) – value for IDD Field Module Heat Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of module_heat_loss_coefficient or None if not set Return type:float

module_voltage_at_maximum_power

field Module Voltage at Maximum Power

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.

Units: V

Default value: 17.0

Parameters:value (float) – value for IDD Field Module Voltage at Maximum Power Raises:ValueError – if value is not a valid value Returns:the value of module_voltage_at_maximum_power or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

nominal_operating_cell_temperature_test_ambient_temperature

field Nominal Operating Cell Temperature Test Ambient Temperature

Units: C

Default value: 20.0

Parameters:value (float) – value for IDD Field Nominal Operating Cell Temperature Test Ambient Temperature Raises:ValueError – if value is not a valid value Returns:the value of nominal_operating_cell_temperature_test_ambient_temperature or None if not set Return type:float

nominal_operating_cell_temperature_test_cell_temperature

field Nominal Operating Cell Temperature Test Cell Temperature

Units: C

Default value: 40.0

Parameters:value (float) – value for IDD Field Nominal Operating Cell Temperature Test Cell Temperature Raises:ValueError – if value is not a valid value Returns:the value of nominal_operating_cell_temperature_test_cell_temperature or None if not set Return type:float

nominal_operating_cell_temperature_test_insolation

field Nominal Operating Cell Temperature Test Insolation

Units: W/m2

Default value: 800.0

Parameters:value (float) – value for IDD Field Nominal Operating Cell Temperature Test Insolation Raises:ValueError – if value is not a valid value Returns:the value of nominal_operating_cell_temperature_test_insolation or None if not set Return type:float

number_of_cells_in_series

field Number of Cells in Series

Units: dimensionless

Default value: 36

Parameters:value (int) – value for IDD Field Number of Cells in Series Raises:ValueError – if value is not a valid value Returns:the value of number_of_cells_in_series or None if not set Return type:int

open_circuit_voltage

field Open Circuit Voltage

Units: V

Default value: 21.6

Parameters:value (float) – value for IDD Field Open Circuit Voltage Raises:ValueError – if value is not a valid value Returns:the value of open_circuit_voltage or None if not set Return type:float

reference_insolation

field Reference Insolation

Units: W/m2

Default value: 1000.0

Parameters:value (float) – value for IDD Field Reference Insolation Raises:ValueError – if value is not a valid value Returns:the value of reference_insolation or None if not set Return type:float

reference_temperature

field Reference Temperature

Units: C

Default value: 25.0

Parameters:value (float) – value for IDD Field Reference Temperature Raises:ValueError – if value is not a valid value Returns:the value of reference_temperature or None if not set Return type:float

semiconductor_bandgap

field Semiconductor Bandgap

Units: eV

Default value: 1.12

Parameters:value (float) – value for IDD Field Semiconductor Bandgap Raises:ValueError – if value is not a valid value Returns:the value of semiconductor_bandgap or None if not set Return type:float

short_circuit_current

field Short Circuit Current

Units: A

Default value: 6.5

Parameters:value (float) – value for IDD Field Short Circuit Current Raises:ValueError – if value is not a valid value Returns:the value of short_circuit_current or None if not set Return type:float

shunt_resistance

field Shunt Resistance

Units: ohms

Default value: 1000000.0

Parameters:value (float) – value for IDD Field Shunt Resistance Raises:ValueError – if value is not a valid value Returns:the value of shunt_resistance or None if not set Return type:float

temperature_coefficient_of_open_circuit_voltage

field Temperature Coefficient of Open Circuit Voltage

Units: V/K

Default value: -0.079

Parameters:value (float) – value for IDD Field Temperature Coefficient of Open Circuit Voltage Raises:ValueError – if value is not a valid value Returns:the value of temperature_coefficient_of_open_circuit_voltage or None if not set Return type:float

temperature_coefficient_of_short_circuit_current

field Temperature Coefficient of Short Circuit Current

Units: A/K

Default value: 0.02

Parameters:value (float) – value for IDD Field Temperature Coefficient of Short Circuit Current Raises:ValueError – if value is not a valid value Returns:the value of temperature_coefficient_of_short_circuit_current or None if not set Return type:float

total_heat_capacity

field Total Heat Capacity

Units: J/m2-K

Default value: 50000.0

Parameters:value (float) – value for IDD Field Total Heat Capacity Raises:ValueError – if value is not a valid value Returns:the value of total_heat_capacity or None if not set Return type:float

transmittance_absorptance_product

field Transmittance Absorptance Product

Units: dimensionless

Default value: 0.95

value <= 1.0

Parameters:value (float) – value for IDD Field Transmittance Absorptance Product Raises:ValueError – if value is not a valid value Returns:the value of transmittance_absorptance_product or None if not set Return type:float

class pyidf.electric_load_center.PhotovoltaicPerformanceSandia

Bases: pyidf.helper.DataObject

Corresponds to IDD object PhotovoltaicPerformance:Sandia Describes performance input data needed for specific makes and models of production PV panels using the empirical coefficients assembled by Sandia National Laboratory.

active_area

field Active Area

(m2, single module)

Units: m2

Default value: 1.0

Parameters:value (float) – value for IDD Field Active Area Raises:ValueError – if value is not a valid value Returns:the value of active_area or None if not set Return type:float

current_at_maximum_power_point

field Current at Maximum Power Point

(Amps)

Units: A

Parameters:value (float) – value for IDD Field Current at Maximum Power Point Raises:ValueError – if value is not a valid value Returns:the value of current_at_maximum_power_point or None if not set Return type:float

diode_factor

field Diode Factor

Units: dimensionless

Parameters:value (float) – value for IDD Field Diode Factor Raises:ValueError – if value is not a valid value Returns:the value of diode_factor or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

number_of_cells_in_parallel

field Number of Cells in Parallel

Units: dimensionless

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Cells in Parallel Raises:ValueError – if value is not a valid value Returns:the value of number_of_cells_in_parallel or None if not set Return type:int

number_of_cells_in_series

field Number of Cells in Series

Units: dimensionless

Default value: 1

value >= 1

Parameters:value (int) – value for IDD Field Number of Cells in Series Raises:ValueError – if value is not a valid value Returns:the value of number_of_cells_in_series or None if not set Return type:int

open_circuit_voltage

field Open Circuit Voltage

(Volts)

Units: V

Parameters:value (float) – value for IDD Field Open Circuit Voltage Raises:ValueError – if value is not a valid value Returns:the value of open_circuit_voltage or None if not set Return type:float

sandia_database_parameter_a

field Sandia Database Parameter a

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter a Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_a or None if not set Return type:float

sandia_database_parameter_a0

field Sandia Database Parameter a0

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter a0 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_a0 or None if not set Return type:float

sandia_database_parameter_a1

field Sandia Database Parameter a1

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter a1 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_a1 or None if not set Return type:float

sandia_database_parameter_a2

field Sandia Database Parameter a2

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter a2 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_a2 or None if not set Return type:float

sandia_database_parameter_a3

field Sandia Database Parameter a3

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter a3 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_a3 or None if not set Return type:float

sandia_database_parameter_a4

field Sandia Database Parameter a4

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter a4 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_a4 or None if not set Return type:float

sandia_database_parameter_aimp

field Sandia Database Parameter aImp

(1/degC)

Units: 1/K

Parameters:value (float) – value for IDD Field Sandia Database Parameter aImp Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_aimp or None if not set Return type:float

sandia_database_parameter_aisc

field Sandia Database Parameter aIsc

(1/degC)

Units: 1/K

Parameters:value (float) – value for IDD Field Sandia Database Parameter aIsc Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_aisc or None if not set Return type:float

sandia_database_parameter_b

field Sandia Database Parameter b

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter b Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_b or None if not set Return type:float

sandia_database_parameter_b0

field Sandia Database Parameter b0

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter b0 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_b0 or None if not set Return type:float

sandia_database_parameter_b1

field Sandia Database Parameter b1

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter b1 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_b1 or None if not set Return type:float

sandia_database_parameter_b2

field Sandia Database Parameter b2

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter b2 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_b2 or None if not set Return type:float

sandia_database_parameter_b3

field Sandia Database Parameter b3

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter b3 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_b3 or None if not set Return type:float

sandia_database_parameter_b4

field Sandia Database Parameter b4

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter b4 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_b4 or None if not set Return type:float

sandia_database_parameter_b5

field Sandia Database Parameter b5

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter b5 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_b5 or None if not set Return type:float

sandia_database_parameter_bvmp0

field Sandia Database Parameter BVmp0

(Volts/degC)

Units: V/K

Parameters:value (float) – value for IDD Field Sandia Database Parameter BVmp0 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_bvmp0 or None if not set Return type:float

sandia_database_parameter_bvoc0

field Sandia Database Parameter BVoc0

(Volts/degC)

Units: V/K

Parameters:value (float) – value for IDD Field Sandia Database Parameter BVoc0 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_bvoc0 or None if not set Return type:float

sandia_database_parameter_c0

field Sandia Database Parameter c0

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter c0 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_c0 or None if not set Return type:float

sandia_database_parameter_c1

field Sandia Database Parameter c1

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter c1 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_c1 or None if not set Return type:float

sandia_database_parameter_c2

field Sandia Database Parameter c2

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter c2 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_c2 or None if not set Return type:float

sandia_database_parameter_c3

field Sandia Database Parameter c3

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter c3 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_c3 or None if not set Return type:float

sandia_database_parameter_c4

field Sandia Database Parameter c4

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter c4 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_c4 or None if not set Return type:float

sandia_database_parameter_c5

field Sandia Database Parameter c5

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter c5 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_c5 or None if not set Return type:float

sandia_database_parameter_c6

field Sandia Database Parameter c6

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter c6 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_c6 or None if not set Return type:float

sandia_database_parameter_c7

field Sandia Database Parameter c7

(non-dimensional)

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter c7 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_c7 or None if not set Return type:float

sandia_database_parameter_deltatc

field Sandia Database Parameter Delta(Tc)

(deg C)

Units: deltaC

Parameters:value (float) – value for IDD Field Sandia Database Parameter Delta(Tc) Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_deltatc or None if not set Return type:float

sandia_database_parameter_fd

field Sandia Database Parameter fd

Units: dimensionless

Parameters:value (float) – value for IDD Field Sandia Database Parameter fd Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_fd or None if not set Return type:float

sandia_database_parameter_ix0

field Sandia Database Parameter Ix0

(Amps)

Parameters:value (float) – value for IDD Field Sandia Database Parameter Ix0 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_ix0 or None if not set Return type:float

sandia_database_parameter_ixx0

field Sandia Database Parameter Ixx0

(Amps)

Parameters:value (float) – value for IDD Field Sandia Database Parameter Ixx0 Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_ixx0 or None if not set Return type:float

sandia_database_parameter_mbvmp

field Sandia Database Parameter mBVmp

(Volts/degC)

Units: V/K

Parameters:value (float) – value for IDD Field Sandia Database Parameter mBVmp Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_mbvmp or None if not set Return type:float

sandia_database_parameter_mbvoc

field Sandia Database Parameter mBVoc

(Volts/degC)

Units: V/K

Parameters:value (float) – value for IDD Field Sandia Database Parameter mBVoc Raises:ValueError – if value is not a valid value Returns:the value of sandia_database_parameter_mbvoc or None if not set Return type:float

short_circuit_current

field Short Circuit Current

(Amps)

Units: A

Parameters:value (float) – value for IDD Field Short Circuit Current Raises:ValueError – if value is not a valid value Returns:the value of short_circuit_current or None if not set Return type:float

voltage_at_maximum_power_point

field Voltage at Maximum Power Point

(Volts)

Units: V

Parameters:value (float) – value for IDD Field Voltage at Maximum Power Point Raises:ValueError – if value is not a valid value Returns:the value of voltage_at_maximum_power_point or None if not set Return type:float

class pyidf.electric_load_center.PhotovoltaicPerformanceSimple

Bases: pyidf.helper.DataObject

Corresponds to IDD object PhotovoltaicPerformance:Simple 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.

conversion_efficiency_input_mode

field Conversion Efficiency Input Mode

Parameters:value (str) – value for IDD Field Conversion Efficiency Input Mode Raises:ValueError – if value is not a valid value Returns:the value of conversion_efficiency_input_mode or None if not set Return type:str

efficiency_schedule_name

field Efficiency Schedule Name

Parameters:value (str) – value for IDD Field Efficiency Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of efficiency_schedule_name or None if not set Return type:str

fraction_of_surface_area_with_active_solar_cells

field Fraction of Surface Area with Active Solar Cells

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Surface Area with Active Solar Cells Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_surface_area_with_active_solar_cells or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

value_for_cell_efficiency_if_fixed

field Value for Cell Efficiency if Fixed

Efficiency = (power generated [W])/(incident solar[W])

value <= 1.0

Parameters:value (float) – value for IDD Field Value for Cell Efficiency if Fixed Raises:ValueError – if value is not a valid value Returns:the value of value_for_cell_efficiency_if_fixed or None if not set Return type:float