OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Static Public Member Functions | Related Functions | List of all members
openstudio::model::CoilCoolingDXSingleSpeed Class Reference

#include <CoilCoolingDXSingleSpeed.hpp>

+ Inheritance diagram for openstudio::model::CoilCoolingDXSingleSpeed:

Public Member Functions

std::vector< std::string > condenserTypeValues () const
 
Constructor and Destructors
 CoilCoolingDXSingleSpeed (const Model &model, Schedule &availabilitySchedule, const Curve &coolingCurveFofTemp, const Curve &coolingCurveFofFlow, const Curve &energyInputRatioFofTemp, const Curve &energyInputRatioFofFlow, const Curve &partLoadFraction)
 Constructs a new CoilCoolingDXSingleSpeed object and places it inside the model. More...
 
 CoilCoolingDXSingleSpeed (const Model &model)
 
virtual ~CoilCoolingDXSingleSpeed ()
 
Getters
Schedule availabilitySchedule () const
 Returns the Schedule referred to by the AvailabilitySchedule field. More...
 
boost::optional< double > ratedCOP () const
 Returns the value of the RatedCOP field. More...
 
boost::optional< double > ratedEvaporatorFanPowerPerVolumeFlowRate () const
 Returns the value of the RatedEvaporatorFanPowerPerVolumeFlowRate field. More...
 
Curve totalCoolingCapacityFunctionOfTemperatureCurve () const
 Returns the CurveBiquadratic referred to by the TotalCoolingCapacityFunctionOfTemperatureCurveName field. More...
 
Curve totalCoolingCapacityFunctionOfFlowFractionCurve () const
 Returns the CurveQuadratic referred to by the TotalCoolingCapacityFunctionOfFlowFractionCurveName field. More...
 
Curve energyInputRatioFunctionOfTemperatureCurve () const
 Returns the CurveBiquadratic referred to by the EnergyInputRatioFunctionOfTemperatureCurveName field. More...
 
Curve energyInputRatioFunctionOfFlowFractionCurve () const
 Returns the CurveQuadratic referred to by the EnergyInputRatioFunctionOfFlowFractionCurveName field. More...
 
Curve partLoadFractionCorrelationCurve () const
 Returns the CurveQuadratic referred to by the PartLoadFractionCorrelationCurveName field. More...
 
boost::optional< double > nominalTimeForCondensateRemovalToBegin () const
 Returns the value of the NominalTimeForCondensateRemovalToBegin field. More...
 
boost::optional< double > ratioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity () const
 Returns the value of the RatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity field. More...
 
boost::optional< double > maximumCyclingRate ()
 Returns the value of the MaximumCyclingRate field. More...
 
boost::optional< double > latentCapacityTimeConstant () const
 Returns the value of the latentCapacityTimeConstant field. More...
 
OptionalString condenserAirInletNodeName () const
 
std::string condenserType () const
 Returns the value of the CondenserType field. More...
 
boost::optional< double > evaporativeCondenserEffectiveness () const
 Returns the value of the EvaporativeCondenserEffectiveness field. More...
 
boost::optional< double > evaporativeCondenserAirFlowRate () const
 Returns the value of the EvaporativeCondenserAirFlowRate field. More...
 
boost::optional< double > evaporativeCondenserPumpRatedPowerConsumption () const
 Returns the value of the EvaporativeCondenserPumpRatedPowerConsumption field. More...
 
boost::optional< double > crankcaseHeaterCapacity () const
 Returns the value of the crankcaseHeaterCapacity field. More...
 
boost::optional< double > maximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation () const
 Returns the value of the MaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation field. More...
 
boost::optional< double > basinHeaterCapacity () const
 Returns the value of the BasinHeaterCapacity field. More...
 
boost::optional< double > basinHeaterSetpointTemperature () const
 Returns the value of the BasinHeaterSetpointTemperature field. More...
 
boost::optional< SchedulebasinHeaterOperatingSchedule () const
 Returns the Schedule referred to by the BasinHeaterOperatingSchedule field. More...
 
Schedule getAvailabilitySchedule () const
 
boost::optional< double > getRatedCOP () const
 
boost::optional< double > getRatedEvaporatorFanPowerPerVolumeFlowRate () const
 
Curve getTotalCoolingCapacityFunctionOfTemperatureCurve () const
 
Curve getTotalCoolingCapacityFunctionOfFlowFractionCurve () const
 
Curve getEnergyInputRatioFunctionOfTemperatureCurve () const
 
Curve getEnergyInputRatioFunctionOfFlowFractionCurve () const
 
Curve getPartLoadFractionCorrelationCurve () const
 
boost::optional< double > getNominalTimeForCondensateRemovalToBegin () const
 
boost::optional< double > getRatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity () const
 
boost::optional< double > getMaximumCyclingRate ()
 
boost::optional< double > getLatentCapacityTimeConstant () const
 
OptionalString getCondenserAirInletNodeName () const
 
std::string getCondenserType () const
 
boost::optional< double > getEvaporativeCondenserEffectiveness () const
 
boost::optional< double > getEvaporativeCondenserAirFlowRate () const
 
boost::optional< double > getEvaporativeCondenserPumpRatedPowerConsumption () const
 
boost::optional< double > getCrankcaseHeaterCapacity () const
 
boost::optional< double > getMaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation () const
 
boost::optional< double > getBasinHeaterCapacity () const
 
boost::optional< double > getBasinHeaterSetpointTemperature () const
 
boost::optional< SchedulegetBasinHeaterOperatingSchedule () const
 
Setters
bool setAvailabilitySchedule (Schedule &schedule)
 Sets the Schedule referred to by the AvailabilitySchedule field. More...
 
bool setRatedCOP (boost::optional< double > value)
 Sets the value of the RatedCOP field. More...
 
bool setRatedCOP (double value)
 
bool setRatedEvaporatorFanPowerPerVolumeFlowRate (boost::optional< double > value)
 Sets the value of the RatedEvaporatorFanPowerPerVolumeFlowRate field. More...
 
bool setRatedEvaporatorFanPowerPerVolumeFlowRate (double value)
 
bool setTotalCoolingCapacityFunctionOfTemperatureCurve (const Curve &curve)
 Sets the CurveBiquadratic referred to by the TotalCoolingCapacityFunctionOfTemperatureCurveName field. More...
 
bool setTotalCoolingCapacityFunctionOfFlowFractionCurve (const Curve &curve)
 Sets the CurveQuadratic referred to by the TotalCoolingCapacityFunctionOfFlowFractionCurnveName field. More...
 
bool setEnergyInputRatioFunctionOfTemperatureCurve (const Curve &curve)
 Sets the CurveBiquadratic referred to by the EnergyInputRatioFunctionOfTemperatureCurveName field. More...
 
bool setEnergyInputRatioFunctionOfFlowFractionCurve (const Curve &curve)
 Sets the CurveQuadratic referred to by the EnergyInputRatioFunctionOfFlowFractionCurveName field. More...
 
bool setPartLoadFractionCorrelationCurve (const Curve &curve)
 Sets the CurveQuadratic referred to by the PartLoadFractionCorrelationCurveName field. More...
 
bool setNominalTimeForCondensateRemovalToBegin (boost::optional< double > value)
 Sets the value of the NominalTimeForCondensateRemovalToBegin field. More...
 
bool setNominalTimeForCondensateRemovalToBegin (double value)
 
bool setRatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity (boost::optional< double > value)
 Sets the value of the RatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity field. More...
 
bool setRatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity (double value)
 
bool setMaximumCyclingRate (boost::optional< double > value)
 Sets the value of the MaximumCyclingRate field. More...
 
bool setMaximumCyclingRate (double value)
 
bool setLatentCapacityTimeConstant (boost::optional< double > value)
 Sets the value of the latentCapacityTimeConstant field. More...
 
bool setLatentCapacityTimeConstant (double value)
 
bool setCondenserAirInletNodeName (const boost::optional< std::string > &)
 
bool setCondenserType (const std::string &value)
 Sets the value of the CondenserType field. More...
 
bool setEvaporativeCondenserEffectiveness (boost::optional< double > value)
 Sets the value of the EvaporativeCondenserEffectiveness field. More...
 
bool setEvaporativeCondenserEffectiveness (double value)
 
bool setEvaporativeCondenserAirFlowRate (boost::optional< double > value)
 Sets the value of the EvaporativeCondenserAirFlowRate field. More...
 
bool setEvaporativeCondenserAirFlowRate (double value)
 
bool setEvaporativeCondenserPumpRatedPowerConsumption (boost::optional< double > value)
 Sets the value of the EvaporativeCondenserPumpRatedPowerConsumption field. More...
 
bool setEvaporativeCondenserPumpRatedPowerConsumption (double value)
 
bool setCrankcaseHeaterCapacity (boost::optional< double > value)
 Sets the value of the crankcaseHeaterCapacity field. More...
 
bool setCrankcaseHeaterCapacity (double value)
 
bool setMaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation (boost::optional< double > value)
 Sets the value of the MaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation field. More...
 
bool setMaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation (double value)
 
bool setBasinHeaterCapacity (boost::optional< double > value)
 Sets the value of the BasinHeaterCapacity field. More...
 
bool setBasinHeaterCapacity (double value)
 
bool setBasinHeaterSetpointTemperature (boost::optional< double > value)
 Sets the value of the BasinHeaterSetpointTemperature field. More...
 
bool setBasinHeaterSetpointTemperature (double value)
 
bool setBasinHeaterOperatingSchedule (Schedule &schedule)
 Sets the Schedule referred to by the BasinHeaterOperatingSchedule field. More...
 
void resetBasinHeaterOperatingSchedule ()
 
boost::optional< double > ratedTotalCoolingCapacity () const
 
OSOptionalQuantity getRatedTotalCoolingCapacity (bool returnIP=false) const
 
bool isRatedTotalCoolingCapacityAutosized () const
 
bool setRatedTotalCoolingCapacity (double ratedTotalCoolingCapacity)
 
bool setRatedTotalCoolingCapacity (const Quantity &ratedTotalCoolingCapacity)
 
void autosizeRatedTotalCoolingCapacity ()
 
boost::optional< double > ratedSensibleHeatRatio () const
 
OSOptionalQuantity getRatedSensibleHeatRatio (bool returnIP=false) const
 
bool isRatedSensibleHeatRatioAutosized () const
 
bool setRatedSensibleHeatRatio (double ratedSensibleHeatRatio)
 
bool setRatedSensibleHeatRatio (const Quantity &ratedSensibleHeatRatio)
 
void autosizeRatedSensibleHeatRatio ()
 
boost::optional< double > ratedAirFlowRate () const
 
OSOptionalQuantity getRatedAirFlowRate (bool returnIP=false) const
 
bool isRatedAirFlowRateAutosized () const
 
bool setRatedAirFlowRate (double ratedAirFlowRate)
 
bool setRatedAirFlowRate (const Quantity &ratedAirFlowRate)
 
void autosizeRatedAirFlowRate ()
 
AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct (double length, double diameter)
 Returns an equivalent duct object, creating a new one if an object is not already attached. More...
 
boost::optional
< AirflowNetworkEquivalentDuct
airflowNetworkEquivalentDuct () const
 Returns the attached equivalent duct object if there is one. More...
 
boost::optional< double > autosizedRatedAirFlowRate () const
 
boost::optional< double > autosizedRatedTotalCoolingCapacity () const
 
boost::optional< double > autosizedRatedSensibleHeatRatio () const
 
boost::optional< double > autosizedEvaporativeCondenserAirFlowRate () const
 
boost::optional< double > autosizedEvaporativeCondenserPumpRatedPowerConsumption () const
 
- Public Member Functions inherited from openstudio::model::StraightComponent
bool addToNode (Node &node)
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More...
 
ModelObject clone (Model model) const
 
void disconnect ()
 
boost::optional< ModelObjectinletModelObject () const
 Returns the optional ModelObject connected to the inlet port. More...
 
unsigned inletPort () const
 Returns the inlet port. More...
 
boost::optional< ModelObjectoutletModelObject () const
 Returns the optional ModelObject connected to the outlet port. More...
 
unsigned outletPort () const
 Returns the outlet port. More...
 
std::vector
< openstudio::IdfObject
remove ()
 
bool removeFromLoop ()
 
 StraightComponent (IddObjectType type, const Model &model)
 
virtual ~StraightComponent ()
 
- Public Member Functions inherited from openstudio::model::HVACComponent
bool addToNode (Node &node)
 Adds this object to a new system node and returns a boolean indicating if the addition was successful. More...
 
bool addToSplitter (Splitter &splitter)
 Adds this object to a splitter by creating a new branch. More...
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that the HVAC component is attached to. More...
 
boost::optional
< AirLoopHVACOutdoorAirSystem
airLoopHVACOutdoorAirSystem () const
 Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to. More...
 
void applySizingValues ()
 
void autosize ()
 Returns the optional ModelObject connected to this object's port. More...
 
boost::optional< HVACComponentcontainingHVACComponent () const
 EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components. More...
 
boost::optional
< StraightComponent
containingStraightComponent () const
 
boost::optional
< ZoneHVACComponent
containingZoneHVACComponent () const
 Returns any ZoneHVACComponent that contains this HVACComponent. More...
 
void disconnect ()
 Removes all connections to other HVACComponent objects. More...
 
bool isRemovable () const
 Indicates if the HVACComponent can be removed from the model. More...
 
boost::optional< Looploop () const
 Returns the optional Loop object that the HVAC component is attached to. More...
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is attached to. More...
 
std::vector< IdfObjectremove ()
 Removes the HVACComponent from the model only if isRemovable() return true. More...
 
virtual ~HVACComponent ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectTypeallowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
virtual ~ParentObject ()
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()
 
ModelObject clone () const
 Creates a deep copy of this object, placing it in this object's model(). More...
 
ModelObject clone (Model model) const
 Creates a deep copy of this object, placing it in model. More...
 
Component createComponent () const
 Method for creating sharable Model snippets. More...
 
Model model () const
 Returns the Model that contains this object. More...
 
boost::optional< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () const
 Get the resources directly used by this ModelObject. More...
 
template<typename T >
std::vector< T > getModelObjectSources () const
 Get all objects of type T that point to this object. More...
 
template<typename T >
std::vector< T > getModelObjectSources (IddObjectType iddObjectType) const
 Get all objects of type T that point to this object. More...
 
template<typename T >
boost::optional< T > getModelObjectTarget (unsigned index) const
 Get the object of type T pointed to by this object from field index. More...
 
template<typename T >
std::vector< T > getModelObjectTargets () const
 Get all objects of type T to which this object points. More...
 
const std::vector< std::string > & outputVariableNames () const
 Get all output variables names that could be associated with this object. More...
 
std::vector< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data. More...
 
boost::optional
< openstudio::TimeSeries
getData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object. More...
 
std::vector< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object. More...
 
std::vector< IdfObjectremoveLifeCycleCosts ()
 Removes all LifeCycleCosts that refer to this object. More...
 
IddObjectType iddObjectType () const
 This is a virtual function that will tell you the type of iddObject you are dealing with. More...
 
AdditionalProperties additionalProperties () const
 Returns this object's additional properties, constructing a new object if necessary. More...
 
bool hasAdditionalProperties () const
 Returns true if this object has additional properties. More...
 
std::vector< IdfObjectremoveAdditionalProperties ()
 Removes all additional properties that refer to this object. More...
 
bool setParent (ParentObject &newParent)
 set the parent, child may have to call non-const methods on the parent More...
 
bool operator< (const ModelObject &right) const
 
bool operator== (const ModelObject &other) const
 equality test More...
 
bool operator!= (const ModelObject &other) const
 inequality test More...
 
std::vector< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
 
boost::optional< double > getAutosizedValue (std::string valueName, std::string unitString) const
 Gets the autosized component value from the sql file. More...
 
virtual std::vector
< EMSActuatorNames
emsActuatorNames () const
 Return the names of the available ems actuators. More...
 
virtual std::vector< std::string > emsInternalVariableNames () const
 Return the names of the available ems internal variables. More...
 
boost::optional< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool isSource () const
 
bool isTarget () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
virtual ~WorkspaceObject ()
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector
< std::string > > 
clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< intgetInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
boost::optional< QUrl > getURL (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level, bool checkNames=false) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
std::ostream & print (std::ostream &os) const
 
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
 
std::ostream & printName (std::ostream &os, bool hasFields=true) const
 
IdfExtensibleGroup pushExtensibleGroup ()
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=false) const
 
virtual ~IdfObject ()
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< CoilCoolingDXSingleSpeed
CoilCoolingDXSingleSpeedVector
 
typedef boost::optional
< CoilCoolingDXSingleSpeed
OptionalCoilCoolingDXSingleSpeed
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
OptionalWorkspaceObject
 
typedef std::vector
< WorkspaceObject
WorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
IdfObject
IdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- Protected Types inherited from openstudio::model::HVACComponent
typedef detail::HVACComponent_Impl ImplType
 
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- Protected Types inherited from openstudio::WorkspaceObject
typedef
detail::WorkspaceObject_Impl 
ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
 
- Protected Member Functions inherited from openstudio::model::HVACComponent
virtual std::vector< ModelObjectchildren () const
 
 HVACComponent (IddObjectType type, const Model &model)
 
 HVACComponent (std::shared_ptr< ImplType > impl)
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ModelObject
 ModelObject (IddObjectType type, const Model &model, bool fastName=false)
 
 ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)
 

Detailed Description

CoilCoolingDXSingleSpeed is an interface to the IDD object named "OS:Coil:Cooling:DX:SingleSpeed".

The purpose of this class is to simplify the construction and manipulation OS:Coil:Cooling:DX:SingleSpeed objects in energyplus.

Constructor & Destructor Documentation

openstudio::model::CoilCoolingDXSingleSpeed::CoilCoolingDXSingleSpeed ( const Model model,
Schedule availabilitySchedule,
const Curve coolingCurveFofTemp,
const Curve coolingCurveFofFlow,
const Curve energyInputRatioFofTemp,
const Curve energyInputRatioFofFlow,
const Curve partLoadFraction 
)
explicit

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

The object is fully initialized with all companion objects.

Parameters
modelthe Model that this coil will live in
availabilitySchedulethe schedule that goes into field:Availability Schedule Name
coolingCurveFofTempcurve for field: Total Cooling Capacity Function of Temperature Curve Name
coolingCurveFofFlowcurve for field: Total Cooling Capacity Function of Flow Fraction Curve Name
energyInputRatioFofTempcurve for field: Energy Input Ratio Function of Temperature Curve Name
energyInputRatioFofFlowcurve for field: Energy Input Ratio Function of Flow Fraction Curve Name
partLoadFractioncurve for field: Part Load Fraction Correlation Curve Name
openstudio::model::CoilCoolingDXSingleSpeed::CoilCoolingDXSingleSpeed ( const Model model)
explicit
virtual openstudio::model::CoilCoolingDXSingleSpeed::~CoilCoolingDXSingleSpeed ( )
inlinevirtual

Member Function Documentation

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

Returns the attached equivalent duct object if there is one.

boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::autosizedEvaporativeCondenserAirFlowRate ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::autosizedEvaporativeCondenserPumpRatedPowerConsumption ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::autosizedRatedAirFlowRate ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::autosizedRatedSensibleHeatRatio ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::autosizedRatedTotalCoolingCapacity ( ) const
void openstudio::model::CoilCoolingDXSingleSpeed::autosizeRatedAirFlowRate ( )
void openstudio::model::CoilCoolingDXSingleSpeed::autosizeRatedSensibleHeatRatio ( )
void openstudio::model::CoilCoolingDXSingleSpeed::autosizeRatedTotalCoolingCapacity ( )
Schedule openstudio::model::CoilCoolingDXSingleSpeed::availabilitySchedule ( ) const

Returns the Schedule referred to by the AvailabilitySchedule field.

boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::basinHeaterCapacity ( ) const

Returns the value of the BasinHeaterCapacity field.

boost::optional<Schedule> openstudio::model::CoilCoolingDXSingleSpeed::basinHeaterOperatingSchedule ( ) const

Returns the Schedule referred to by the BasinHeaterOperatingSchedule field.

boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::basinHeaterSetpointTemperature ( ) const

Returns the value of the BasinHeaterSetpointTemperature field.

OptionalString openstudio::model::CoilCoolingDXSingleSpeed::condenserAirInletNodeName ( ) const
std::string openstudio::model::CoilCoolingDXSingleSpeed::condenserType ( ) const

Returns the value of the CondenserType field.

std::vector<std::string> openstudio::model::CoilCoolingDXSingleSpeed::condenserTypeValues ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::crankcaseHeaterCapacity ( ) const

Returns the value of the crankcaseHeaterCapacity field.

Curve openstudio::model::CoilCoolingDXSingleSpeed::energyInputRatioFunctionOfFlowFractionCurve ( ) const

Returns the CurveQuadratic referred to by the EnergyInputRatioFunctionOfFlowFractionCurveName field.

Curve openstudio::model::CoilCoolingDXSingleSpeed::energyInputRatioFunctionOfTemperatureCurve ( ) const

Returns the CurveBiquadratic referred to by the EnergyInputRatioFunctionOfTemperatureCurveName field.

boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::evaporativeCondenserAirFlowRate ( ) const

Returns the value of the EvaporativeCondenserAirFlowRate field.

optional == false means "autosize"

boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::evaporativeCondenserEffectiveness ( ) const

Returns the value of the EvaporativeCondenserEffectiveness field.

boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::evaporativeCondenserPumpRatedPowerConsumption ( ) const

Returns the value of the EvaporativeCondenserPumpRatedPowerConsumption field.

optional == false means "autosize"

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

Returns an equivalent duct object, creating a new one if an object is not already attached.

Schedule openstudio::model::CoilCoolingDXSingleSpeed::getAvailabilitySchedule ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getBasinHeaterCapacity ( ) const
boost::optional<Schedule> openstudio::model::CoilCoolingDXSingleSpeed::getBasinHeaterOperatingSchedule ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getBasinHeaterSetpointTemperature ( ) const
OptionalString openstudio::model::CoilCoolingDXSingleSpeed::getCondenserAirInletNodeName ( ) const
std::string openstudio::model::CoilCoolingDXSingleSpeed::getCondenserType ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getCrankcaseHeaterCapacity ( ) const
Curve openstudio::model::CoilCoolingDXSingleSpeed::getEnergyInputRatioFunctionOfFlowFractionCurve ( ) const
Curve openstudio::model::CoilCoolingDXSingleSpeed::getEnergyInputRatioFunctionOfTemperatureCurve ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getEvaporativeCondenserAirFlowRate ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getEvaporativeCondenserEffectiveness ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getEvaporativeCondenserPumpRatedPowerConsumption ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getLatentCapacityTimeConstant ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getMaximumCyclingRate ( )
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getMaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getNominalTimeForCondensateRemovalToBegin ( ) const
Curve openstudio::model::CoilCoolingDXSingleSpeed::getPartLoadFractionCorrelationCurve ( ) const
OSOptionalQuantity openstudio::model::CoilCoolingDXSingleSpeed::getRatedAirFlowRate ( bool  returnIP = false) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getRatedCOP ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getRatedEvaporatorFanPowerPerVolumeFlowRate ( ) const
OSOptionalQuantity openstudio::model::CoilCoolingDXSingleSpeed::getRatedSensibleHeatRatio ( bool  returnIP = false) const
OSOptionalQuantity openstudio::model::CoilCoolingDXSingleSpeed::getRatedTotalCoolingCapacity ( bool  returnIP = false) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::getRatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity ( ) const
Curve openstudio::model::CoilCoolingDXSingleSpeed::getTotalCoolingCapacityFunctionOfFlowFractionCurve ( ) const
Curve openstudio::model::CoilCoolingDXSingleSpeed::getTotalCoolingCapacityFunctionOfTemperatureCurve ( ) const
static IddObjectType openstudio::model::CoilCoolingDXSingleSpeed::iddObjectType ( )
static
bool openstudio::model::CoilCoolingDXSingleSpeed::isRatedAirFlowRateAutosized ( ) const
bool openstudio::model::CoilCoolingDXSingleSpeed::isRatedSensibleHeatRatioAutosized ( ) const
bool openstudio::model::CoilCoolingDXSingleSpeed::isRatedTotalCoolingCapacityAutosized ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::latentCapacityTimeConstant ( ) const

Returns the value of the latentCapacityTimeConstant field.

boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::maximumCyclingRate ( )

Returns the value of the MaximumCyclingRate field.

boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::maximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation ( ) const

Returns the value of the MaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation field.

boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::nominalTimeForCondensateRemovalToBegin ( ) const

Returns the value of the NominalTimeForCondensateRemovalToBegin field.

Curve openstudio::model::CoilCoolingDXSingleSpeed::partLoadFractionCorrelationCurve ( ) const

Returns the CurveQuadratic referred to by the PartLoadFractionCorrelationCurveName field.

boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::ratedAirFlowRate ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::ratedCOP ( ) const

Returns the value of the RatedCOP field.

boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::ratedEvaporatorFanPowerPerVolumeFlowRate ( ) const

Returns the value of the RatedEvaporatorFanPowerPerVolumeFlowRate field.

boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::ratedSensibleHeatRatio ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::ratedTotalCoolingCapacity ( ) const
boost::optional<double> openstudio::model::CoilCoolingDXSingleSpeed::ratioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity ( ) const

Returns the value of the RatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity field.

void openstudio::model::CoilCoolingDXSingleSpeed::resetBasinHeaterOperatingSchedule ( )
bool openstudio::model::CoilCoolingDXSingleSpeed::setAvailabilitySchedule ( Schedule schedule)

Sets the Schedule referred to by the AvailabilitySchedule field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setBasinHeaterCapacity ( boost::optional< double >  value)

Sets the value of the BasinHeaterCapacity field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setBasinHeaterCapacity ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setBasinHeaterOperatingSchedule ( Schedule schedule)

Sets the Schedule referred to by the BasinHeaterOperatingSchedule field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setBasinHeaterSetpointTemperature ( boost::optional< double >  value)

Sets the value of the BasinHeaterSetpointTemperature field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setBasinHeaterSetpointTemperature ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setCondenserAirInletNodeName ( const boost::optional< std::string > &  )
bool openstudio::model::CoilCoolingDXSingleSpeed::setCondenserType ( const std::string &  value)

Sets the value of the CondenserType field.

Options are AirCooled and EvaporativelyCooled.

bool openstudio::model::CoilCoolingDXSingleSpeed::setCrankcaseHeaterCapacity ( boost::optional< double >  value)

Sets the value of the crankcaseHeaterCapacity field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setCrankcaseHeaterCapacity ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setEnergyInputRatioFunctionOfFlowFractionCurve ( const Curve curve)

Sets the CurveQuadratic referred to by the EnergyInputRatioFunctionOfFlowFractionCurveName field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setEnergyInputRatioFunctionOfTemperatureCurve ( const Curve curve)

Sets the CurveBiquadratic referred to by the EnergyInputRatioFunctionOfTemperatureCurveName field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setEvaporativeCondenserAirFlowRate ( boost::optional< double >  value)

Sets the value of the EvaporativeCondenserAirFlowRate field.

if value==false then set field to "autosize"

bool openstudio::model::CoilCoolingDXSingleSpeed::setEvaporativeCondenserAirFlowRate ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setEvaporativeCondenserEffectiveness ( boost::optional< double >  value)

Sets the value of the EvaporativeCondenserEffectiveness field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setEvaporativeCondenserEffectiveness ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setEvaporativeCondenserPumpRatedPowerConsumption ( boost::optional< double >  value)

Sets the value of the EvaporativeCondenserPumpRatedPowerConsumption field.

if value==false then set field to "autosize"

bool openstudio::model::CoilCoolingDXSingleSpeed::setEvaporativeCondenserPumpRatedPowerConsumption ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setLatentCapacityTimeConstant ( boost::optional< double >  value)

Sets the value of the latentCapacityTimeConstant field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setLatentCapacityTimeConstant ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setMaximumCyclingRate ( boost::optional< double >  value)

Sets the value of the MaximumCyclingRate field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setMaximumCyclingRate ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setMaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation ( boost::optional< double >  value)

Sets the value of the MaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setMaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setNominalTimeForCondensateRemovalToBegin ( boost::optional< double >  value)

Sets the value of the NominalTimeForCondensateRemovalToBegin field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setNominalTimeForCondensateRemovalToBegin ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setPartLoadFractionCorrelationCurve ( const Curve curve)

Sets the CurveQuadratic referred to by the PartLoadFractionCorrelationCurveName field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setRatedAirFlowRate ( double  ratedAirFlowRate)
bool openstudio::model::CoilCoolingDXSingleSpeed::setRatedAirFlowRate ( const Quantity ratedAirFlowRate)
bool openstudio::model::CoilCoolingDXSingleSpeed::setRatedCOP ( boost::optional< double >  value)

Sets the value of the RatedCOP field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setRatedCOP ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setRatedEvaporatorFanPowerPerVolumeFlowRate ( boost::optional< double >  value)

Sets the value of the RatedEvaporatorFanPowerPerVolumeFlowRate field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setRatedEvaporatorFanPowerPerVolumeFlowRate ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setRatedSensibleHeatRatio ( double  ratedSensibleHeatRatio)
bool openstudio::model::CoilCoolingDXSingleSpeed::setRatedSensibleHeatRatio ( const Quantity ratedSensibleHeatRatio)
bool openstudio::model::CoilCoolingDXSingleSpeed::setRatedTotalCoolingCapacity ( double  ratedTotalCoolingCapacity)
bool openstudio::model::CoilCoolingDXSingleSpeed::setRatedTotalCoolingCapacity ( const Quantity ratedTotalCoolingCapacity)
bool openstudio::model::CoilCoolingDXSingleSpeed::setRatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity ( boost::optional< double >  value)

Sets the value of the RatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setRatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity ( double  value)
bool openstudio::model::CoilCoolingDXSingleSpeed::setTotalCoolingCapacityFunctionOfFlowFractionCurve ( const Curve curve)

Sets the CurveQuadratic referred to by the TotalCoolingCapacityFunctionOfFlowFractionCurnveName field.

bool openstudio::model::CoilCoolingDXSingleSpeed::setTotalCoolingCapacityFunctionOfTemperatureCurve ( const Curve curve)

Sets the CurveBiquadratic referred to by the TotalCoolingCapacityFunctionOfTemperatureCurveName field.

Curve openstudio::model::CoilCoolingDXSingleSpeed::totalCoolingCapacityFunctionOfFlowFractionCurve ( ) const

Returns the CurveQuadratic referred to by the TotalCoolingCapacityFunctionOfFlowFractionCurveName field.

Curve openstudio::model::CoilCoolingDXSingleSpeed::totalCoolingCapacityFunctionOfTemperatureCurve ( ) const

Returns the CurveBiquadratic referred to by the TotalCoolingCapacityFunctionOfTemperatureCurveName field.

Friends And Related Function Documentation