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

#include <CoilHeatingWater.hpp>

+ Inheritance diagram for openstudio::model::CoilHeatingWater:

Public Member Functions

Constructors and Destructors
 CoilHeatingWater (const Model &model, Schedule &availableSchedule)
 
 CoilHeatingWater (const Model &model)
 
virtual ~CoilHeatingWater ()
 
Getters and Setters
Schedule availabilitySchedule () const
 Returns the schedule referred to by the Availability Schedule Name field. More...
 
Schedule availableSchedule () const
 
bool setAvailabilitySchedule (Schedule &schedule)
 Sets the schedule referred to by the Availability Schedule Name field. More...
 
bool setAvailableSchedule (Schedule &schedule)
 
boost::optional< double > uFactorTimesAreaValue ()
 Returns the value of the UFactorTimesAreaValue field. More...
 
bool setUFactorTimesAreaValue (double value)
 Sets the value of the UFactorTimesAreaValue field. More...
 
bool isUFactorTimesAreaValueAutosized ()
 Returns true if the UFactorTimesAreaValue field is set to autosize. More...
 
void autosizeUFactorTimesAreaValue ()
 Sets the UFactorTimesAreaValue field to autosize. More...
 
boost::optional< double > maximumWaterFlowRate ()
 Returns the value of the MaximumWaterFlowRate field. More...
 
bool setMaximumWaterFlowRate (double value)
 Sets the value of the MaximumWaterFlowRate field. More...
 
bool isMaximumWaterFlowRateAutosized ()
 Returns true if the MaximumWaterFlowRate field is set to autosize. More...
 
void autosizeMaximumWaterFlowRate ()
 Sets the MaximumWaterFlowRate field to autosize. More...
 
std::string performanceInputMethod ()
 Returns the value of the PerformanceInputMethod field. More...
 
bool setPerformanceInputMethod (std::string value)
 Sets the value of the PerformanceInputMethod field. More...
 
boost::optional< double > ratedCapacity ()
 Returns the value of the RatedCapacity field. More...
 
bool setRatedCapacity (double value)
 Sets the value of the RatedCapacity field. More...
 
bool isRatedCapacityAutosized ()
 Returns true if the RatedCapacity field is set to autosize. More...
 
void autosizeRatedCapacity ()
 Sets the RatedCapacity field to autosize. More...
 
double ratedInletWaterTemperature ()
 Returns the value of RatedInletWaterTemperature field. More...
 
bool setRatedInletWaterTemperature (double value)
 Sets the value of RatedInletWaterTemperature field. More...
 
double ratedInletAirTemperature ()
 Returns the value of RatedInletWaterTemperature field. More...
 
bool setRatedInletAirTemperature (double value)
 Sets the value of RatedInletWaterTemperature field. More...
 
double ratedOutletWaterTemperature ()
 Returns the value of RatedOutletWaterTemperature field. More...
 
bool setRatedOutletWaterTemperature (double value)
 Sets the value of RatedOutletWaterTemperature field. More...
 
double ratedOutletAirTemperature ()
 Returns the value of RatedOutletAirTemperature field. More...
 
bool setRatedOutletAirTemperature (double value)
 Sets the value of RatedOutletAirTemperature field. More...
 
double ratedRatioForAirAndWaterConvection ()
 Returns the value of RatedRatioForAirAndWaterConvection field. More...
 
bool setRatedRatioForAirAndWaterConvection (double value)
 Sets the value of RatedRatioForAirAndWaterConvection field. More...
 
boost::optional
< ControllerWaterCoil
controllerWaterCoil ()
 Returns the optional ControllerWaterCoil associated with this coil. More...
 
boost::optional< double > autosizedUFactorTimesAreaValue () const
 
boost::optional< double > autosizedMaximumWaterFlowRate () const
 
boost::optional< double > autosizedRatedCapacity () const
 
Other
AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct (double length, double diameter)
 Creates a new equivalent duct object if an object is not already attached. More...
 
boost::optional
< AirflowNetworkEquivalentDuct
airflowNetworkEquivalentDuct () const
 Returns the attached equivalent duct object, if any. More...
 
- Public Member Functions inherited from openstudio::model::WaterToAirComponent
virtual bool addToNode (Node &node)
 
virtual bool addToSplitter (Splitter &splitter)
 
virtual boost::optional
< ModelObject
airInletModelObject () const
 Returns the optional ModelObject connected to the air inlet port. More...
 
virtual unsigned airInletPort () const
 Returns the air inlet port. More...
 
virtual boost::optional
< AirLoopHVAC
airLoopHVAC () const
 
virtual boost::optional
< ModelObject
airOutletModelObject () const
 Returns the optional ModelObject connected to the air outlet port. More...
 
virtual unsigned airOutletPort () const
 Returns the air outlet port. More...
 
virtual ModelObject clone (Model model) const
 
void disconnectAirSide ()
 
void disconnectWaterSide ()
 
virtual boost::optional
< PlantLoop
plantLoop () const
 
virtual std::vector
< openstudio::IdfObject > 
remove ()
 
bool removeFromAirLoopHVAC ()
 Removes the component from the airLoopHVAC if one is attached. More...
 
bool removeFromPlantLoop ()
 Removes the component from the plantLoop if one is attached. More...
 
virtual boost::optional
< ModelObject
waterInletModelObject () const
 Returns the optional ModelObject connected to the water inlet port. More...
 
virtual unsigned waterInletPort () const
 Returns the water inlet port. More...
 
virtual boost::optional
< ModelObject
waterOutletModelObject () const
 Returns the optional ModelObject connected to the water outlet port. More...
 
virtual unsigned waterOutletPort () const
 Returns the water outlet port. More...
 
virtual ~WaterToAirComponent ()
 
- 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< IdfObject > remove ()
 Removes the HVACComponent from the model only if isRemovable() return true. More...
 
virtual ~HVACComponent ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () 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< IdfObject > removeLifeCycleCosts ()
 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< IdfObject > removeAdditionalProperties ()
 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
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 

Additional Inherited Members

- 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 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)
 

Detailed Description

CoilHeatingWater is a WaterToAirComponent that wraps the IDD object named "OS:Coil:Heating:Water".

Polymorphic behavior:

  1. bool addToNode(Node& node);
    • inherited from HVACComponent
    • Adds this coil to node. If the coil is not allowed at the given node returns false. If controllerWaterCoil is associated with this coil, then the controller's sensor node will be set to the air outlet node.

Constructor & Destructor Documentation

openstudio::model::CoilHeatingWater::CoilHeatingWater ( const Model model,
Schedule availableSchedule 
)
openstudio::model::CoilHeatingWater::CoilHeatingWater ( const Model model)
virtual openstudio::model::CoilHeatingWater::~CoilHeatingWater ( )
inlinevirtual

Member Function Documentation

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

Returns the attached equivalent duct object, if any.

boost::optional<double> openstudio::model::CoilHeatingWater::autosizedMaximumWaterFlowRate ( ) const
boost::optional<double> openstudio::model::CoilHeatingWater::autosizedRatedCapacity ( ) const
boost::optional<double> openstudio::model::CoilHeatingWater::autosizedUFactorTimesAreaValue ( ) const
void openstudio::model::CoilHeatingWater::autosizeMaximumWaterFlowRate ( )

Sets the MaximumWaterFlowRate field to autosize.

void openstudio::model::CoilHeatingWater::autosizeRatedCapacity ( )

Sets the RatedCapacity field to autosize.

void openstudio::model::CoilHeatingWater::autosizeUFactorTimesAreaValue ( )

Sets the UFactorTimesAreaValue field to autosize.

Schedule openstudio::model::CoilHeatingWater::availabilitySchedule ( ) const

Returns the schedule referred to by the Availability Schedule Name field.

Schedule openstudio::model::CoilHeatingWater::availableSchedule ( ) const
boost::optional<ControllerWaterCoil> openstudio::model::CoilHeatingWater::controllerWaterCoil ( )

Returns the optional ControllerWaterCoil associated with this coil.

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

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

static IddObjectType openstudio::model::CoilHeatingWater::iddObjectType ( )
static
bool openstudio::model::CoilHeatingWater::isMaximumWaterFlowRateAutosized ( )

Returns true if the MaximumWaterFlowRate field is set to autosize.

bool openstudio::model::CoilHeatingWater::isRatedCapacityAutosized ( )

Returns true if the RatedCapacity field is set to autosize.

bool openstudio::model::CoilHeatingWater::isUFactorTimesAreaValueAutosized ( )

Returns true if the UFactorTimesAreaValue field is set to autosize.

boost::optional<double> openstudio::model::CoilHeatingWater::maximumWaterFlowRate ( )

Returns the value of the MaximumWaterFlowRate field.

std::string openstudio::model::CoilHeatingWater::performanceInputMethod ( )

Returns the value of the PerformanceInputMethod field.

boost::optional<double> openstudio::model::CoilHeatingWater::ratedCapacity ( )

Returns the value of the RatedCapacity field.

double openstudio::model::CoilHeatingWater::ratedInletAirTemperature ( )

Returns the value of RatedInletWaterTemperature field.

double openstudio::model::CoilHeatingWater::ratedInletWaterTemperature ( )

Returns the value of RatedInletWaterTemperature field.

double openstudio::model::CoilHeatingWater::ratedOutletAirTemperature ( )

Returns the value of RatedOutletAirTemperature field.

double openstudio::model::CoilHeatingWater::ratedOutletWaterTemperature ( )

Returns the value of RatedOutletWaterTemperature field.

double openstudio::model::CoilHeatingWater::ratedRatioForAirAndWaterConvection ( )

Returns the value of RatedRatioForAirAndWaterConvection field.

bool openstudio::model::CoilHeatingWater::setAvailabilitySchedule ( Schedule schedule)

Sets the schedule referred to by the Availability Schedule Name field.

bool openstudio::model::CoilHeatingWater::setAvailableSchedule ( Schedule schedule)
bool openstudio::model::CoilHeatingWater::setMaximumWaterFlowRate ( double  value)

Sets the value of the MaximumWaterFlowRate field.

bool openstudio::model::CoilHeatingWater::setPerformanceInputMethod ( std::string  value)

Sets the value of the PerformanceInputMethod field.

Options are UFactorTimesAreaAndDesignWaterFlowRate and NominalCapacity.

bool openstudio::model::CoilHeatingWater::setRatedCapacity ( double  value)

Sets the value of the RatedCapacity field.

bool openstudio::model::CoilHeatingWater::setRatedInletAirTemperature ( double  value)

Sets the value of RatedInletWaterTemperature field.

bool openstudio::model::CoilHeatingWater::setRatedInletWaterTemperature ( double  value)

Sets the value of RatedInletWaterTemperature field.

bool openstudio::model::CoilHeatingWater::setRatedOutletAirTemperature ( double  value)

Sets the value of RatedOutletAirTemperature field.

bool openstudio::model::CoilHeatingWater::setRatedOutletWaterTemperature ( double  value)

Sets the value of RatedOutletWaterTemperature field.

bool openstudio::model::CoilHeatingWater::setRatedRatioForAirAndWaterConvection ( double  value)

Sets the value of RatedRatioForAirAndWaterConvection field.

bool openstudio::model::CoilHeatingWater::setUFactorTimesAreaValue ( double  value)

Sets the value of the UFactorTimesAreaValue field.

boost::optional<double> openstudio::model::CoilHeatingWater::uFactorTimesAreaValue ( )

Returns the value of the UFactorTimesAreaValue field.