OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Pages

#include "CoilHeatingGas.hpp"

Inheritance diagram for openstudio::model::CoilHeatingGas:

Public Member Functions

 CoilHeatingGas (const Model &model, Schedule &schedule)
 CoilHeatingGas (const Model &model)
virtual ~CoilHeatingGas ()

Static Public Member Functions

static IddObjectType iddObjectType ()

Related Functions

typedef std::vector
< CoilHeatingGas
CoilHeatingGasVector
typedef boost::optional
< CoilHeatingGas
OptionalCoilHeatingGas

Getters and Setters

Schedule availabilitySchedule () const
Schedule availableSchedule () const
bool setAvailabilitySchedule (Schedule &schedule)
bool setAvailableSchedule (Schedule &schedule)
std::string fuelType () const
bool setFuelType (const std::string &fuelType)
void resetFuelType ()
double gasBurnerEfficiency () const
bool setGasBurnerEfficiency (double value)
double parasiticElectricLoad () const
bool setParasiticElectricLoad (double value)
double parasiticGasLoad () const
bool setParasiticGasLoad (double value)
boost::optional< double > nominalCapacity () const
bool isNominalCapacityAutosized () const
bool setNominalCapacity (double nominalCapacity)
void resetNominalCapacity ()
void autosizeNominalCapacity ()
boost::optional< CurvepartLoadFractionCorrelationCurve () const
bool setPartLoadFractionCorrelationCurve (const Curve &curve)
void resetPartLoadFractionCorrelationCurve ()
AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct (double length, double diameter)
boost::optional
< AirflowNetworkEquivalentDuct
airflowNetworkEquivalentDuct () const
boost::optional< double > autosizedNominalCapacity () const
static std::vector< std::string > validFuelTypeValues ()

Detailed Description

CoilHeatingGas is an interface to the IDD object named "OS:Coil:Heating:Gas".

The purpose of this class is to simplify the construction and manipulation OS:Coil:Heating:Gas objects in energyplus.

As of EnergyPlus Version 8.6 this object maps to Coil:Heating:Fuel.

Constructor & Destructor Documentation

openstudio::model::CoilHeatingGas::CoilHeatingGas ( const Model model,
Schedule schedule 
)
explicit

Constructs a new CoilHeatingGas object and places it inside the model.

The object is fully initialized with all companion objects.

Sets GasBurnerEffeciency to .8 Sets GasFields to AutoSize Sets ParasiticElectricLoad to 0 Sets ParasiticGasLoad to 0

openstudio::model::CoilHeatingGas::CoilHeatingGas ( const Model model)
explicit
virtual openstudio::model::CoilHeatingGas::~CoilHeatingGas ( )
inlinevirtual

Member Function Documentation

boost::optional<AirflowNetworkEquivalentDuct> openstudio::model::CoilHeatingGas::airflowNetworkEquivalentDuct ( ) const

Returns the attached equivalent duct object, if any.

boost::optional<double> openstudio::model::CoilHeatingGas::autosizedNominalCapacity ( ) const
void openstudio::model::CoilHeatingGas::autosizeNominalCapacity ( )
Schedule openstudio::model::CoilHeatingGas::availabilitySchedule ( ) const

Returns the Schedule referred to by the Availability Schedule field.

Schedule openstudio::model::CoilHeatingGas::availableSchedule ( ) const
std::string openstudio::model::CoilHeatingGas::fuelType ( ) const

Gets the coil fuel type.

double openstudio::model::CoilHeatingGas::gasBurnerEfficiency ( ) const

Returns the value of the GasBurnerEfficiency field.

AirflowNetworkEquivalentDuct openstudio::model::CoilHeatingGas::getAirflowNetworkEquivalentDuct ( double  length,
double  diameter 
)

Creates a new equivalent duct object if an object is not already attached.

static IddObjectType openstudio::model::CoilHeatingGas::iddObjectType ( )
static
bool openstudio::model::CoilHeatingGas::isNominalCapacityAutosized ( ) const
boost::optional<double> openstudio::model::CoilHeatingGas::nominalCapacity ( ) const
double openstudio::model::CoilHeatingGas::parasiticElectricLoad ( ) const

Returns the value of the ParasiticElectricLoad field.

double openstudio::model::CoilHeatingGas::parasiticGasLoad ( ) const

Returns the value of the ParasiticGasLoad field.

boost::optional<Curve> openstudio::model::CoilHeatingGas::partLoadFractionCorrelationCurve ( ) const
void openstudio::model::CoilHeatingGas::resetFuelType ( )

Resets the fuel type to its default.

void openstudio::model::CoilHeatingGas::resetNominalCapacity ( )
void openstudio::model::CoilHeatingGas::resetPartLoadFractionCorrelationCurve ( )
bool openstudio::model::CoilHeatingGas::setAvailabilitySchedule ( Schedule schedule)

Sets the Schedule referred to by the Availability Schedule field.

bool openstudio::model::CoilHeatingGas::setAvailableSchedule ( Schedule schedule)
bool openstudio::model::CoilHeatingGas::setFuelType ( const std::string &  fuelType)

Sets the fuel type.

bool openstudio::model::CoilHeatingGas::setGasBurnerEfficiency ( double  value)

Sets the value of the GasBurnerEfficiency field.

bool openstudio::model::CoilHeatingGas::setNominalCapacity ( double  nominalCapacity)
bool openstudio::model::CoilHeatingGas::setParasiticElectricLoad ( double  value)

Sets the value of the ParasiticElectricLoad field.

bool openstudio::model::CoilHeatingGas::setParasiticGasLoad ( double  value)

Sets the value of the ParasiticGasLoad field.

bool openstudio::model::CoilHeatingGas::setPartLoadFractionCorrelationCurve ( const Curve curve)
static std::vector<std::string> openstudio::model::CoilHeatingGas::validFuelTypeValues ( )
static

Returns a list of valid fuel types.

Friends And Related Function Documentation

typedef std::vector<CoilHeatingGas> CoilHeatingGasVector
related
typedef boost::optional<CoilHeatingGas> OptionalCoilHeatingGas
related