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

#include <ChillerAbsorption.hpp>

+ Inheritance diagram for openstudio::model::ChillerAbsorption:

Public Member Functions

Constructors and Destructors
 ChillerAbsorption (const Model &model)
 
virtual ~ChillerAbsorption ()=default
 
 ChillerAbsorption (const ChillerAbsorption &other)=default
 
 ChillerAbsorption (ChillerAbsorption &&other)=default
 
ChillerAbsorptionoperator= (const ChillerAbsorption &)=default
 
ChillerAbsorptionoperator= (ChillerAbsorption &&)=default
 
Getters
boost::optional< double > nominalCapacity () const
 
bool isNominalCapacityAutosized () const
 
boost::optional< double > nominalPumpingPower () const
 
bool isNominalPumpingPowerAutosized () const
 
double minimumPartLoadRatio () const
 
double maximumPartLoadRatio () const
 
double optimumPartLoadRatio () const
 
double designCondenserInletTemperature () const
 
boost::optional< double > designChilledWaterFlowRate () const
 
bool isDesignChilledWaterFlowRateAutosized () const
 
boost::optional< double > designCondenserWaterFlowRate () const
 
bool isDesignCondenserWaterFlowRateAutosized () const
 
double coefficient1oftheHotWaterorSteamUsePartLoadRatioCurve () const
 
double coefficient2oftheHotWaterorSteamUsePartLoadRatioCurve () const
 
double coefficient3oftheHotWaterorSteamUsePartLoadRatioCurve () const
 
double coefficient1ofthePumpElectricUsePartLoadRatioCurve () const
 
double coefficient2ofthePumpElectricUsePartLoadRatioCurve () const
 
double coefficient3ofthePumpElectricUsePartLoadRatioCurve () const
 
double chilledWaterOutletTemperatureLowerLimit () const
 
std::string chillerFlowMode () const
 
std::string generatorHeatSourceType () const
 
boost::optional< double > designGeneratorFluidFlowRate () const
 
bool isDesignGeneratorFluidFlowRateAutosized () const
 
double degreeofSubcoolinginSteamGenerator () const
 
double sizingFactor () const
 
Setters
bool setNominalCapacity (double nominalCapacity)
 
void autosizeNominalCapacity ()
 
bool setNominalPumpingPower (double nominalPumpingPower)
 
void autosizeNominalPumpingPower ()
 
bool setMinimumPartLoadRatio (double minimumPartLoadRatio)
 
bool setMaximumPartLoadRatio (double maximumPartLoadRatio)
 
bool setOptimumPartLoadRatio (double optimumPartLoadRatio)
 
bool setDesignCondenserInletTemperature (double designCondenserInletTemperature)
 
bool setDesignChilledWaterFlowRate (double designChilledWaterFlowRate)
 
void autosizeDesignChilledWaterFlowRate ()
 
bool setDesignCondenserWaterFlowRate (double designCondenserWaterFlowRate)
 
void autosizeDesignCondenserWaterFlowRate ()
 
bool setCoefficient1oftheHotWaterorSteamUsePartLoadRatioCurve (double coefficient1oftheHotWaterorSteamUsePartLoadRatioCurve)
 
bool setCoefficient2oftheHotWaterorSteamUsePartLoadRatioCurve (double coefficient2oftheHotWaterorSteamUsePartLoadRatioCurve)
 
bool setCoefficient3oftheHotWaterorSteamUsePartLoadRatioCurve (double coefficient3oftheHotWaterorSteamUsePartLoadRatioCurve)
 
bool setCoefficient1ofthePumpElectricUsePartLoadRatioCurve (double coefficient1ofthePumpElectricUsePartLoadRatioCurve)
 
bool setCoefficient2ofthePumpElectricUsePartLoadRatioCurve (double coefficient2ofthePumpElectricUsePartLoadRatioCurve)
 
bool setCoefficient3ofthePumpElectricUsePartLoadRatioCurve (double coefficient3ofthePumpElectricUsePartLoadRatioCurve)
 
bool setChilledWaterOutletTemperatureLowerLimit (double chilledWaterOutletTemperatureLowerLimit)
 
bool setChillerFlowMode (const std::string &chillerFlowMode)
 
bool setGeneratorHeatSourceType (const std::string &generatorHeatSourceType)
 
bool setDesignGeneratorFluidFlowRate (double designGeneratorFluidFlowRate)
 
void autosizeDesignGeneratorFluidFlowRate ()
 
bool setDegreeofSubcoolinginSteamGenerator (double degreeofSubcoolinginSteamGenerator)
 
bool setSizingFactor (double sizingFactor)
 
Other
boost::optional< double > autosizedNominalCapacity () const
 
boost::optional< double > autosizedNominalPumpingPower () const
 
boost::optional< double > autosizedDesignChilledWaterFlowRate () const
 
boost::optional< double > autosizedDesignCondenserWaterFlowRate () const
 
boost::optional< double > autosizedDesignGeneratorFluidFlowRate () const
 
boost::optional< PlantLoopchilledWaterLoop () const
 Convenience Function to return the Chilled Water Loop (chiller on supply) More...
 
boost::optional< PlantLoopcondenserWaterLoop () const
 Convenience Function to return the Condenser Water Loop (chiller on demand side) More...
 
boost::optional< PlantLoopgeneratorLoop () const
 Convenience Function to return the Generator Loop (chiller on the demand side - tertiary) More...
 
- Public Member Functions inherited from openstudio::model::WaterToWaterComponent
virtual bool addToNode (Node &node)
 
virtual bool addToTertiaryNode (Node &node)
 Add this WaterToWaterComponent to a tertiaryPlantLoop by making connections to the tertiary inlet and outlet. More...
 
virtual ModelObject clone (Model model) const
 
virtual boost::optional
< ModelObject
demandInletModelObject () const
 Returns the optional ModelObject connected to the demand inlet port. More...
 
virtual unsigned demandInletPort () const
 Returns the demand inlet port. More...
 
virtual boost::optional
< ModelObject
demandOutletModelObject () const
 Returns the optional ModelObject connected to the demand outlet port. More...
 
virtual unsigned demandOutletPort () const
 Returns the demand outlet port. More...
 
void disconnect ()
 
WaterToWaterComponentoperator= (const WaterToWaterComponent &)=default
 
WaterToWaterComponentoperator= (WaterToWaterComponent &&)=default
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is a supply component on. More...
 
virtual std::vector
< openstudio::IdfObject > 
remove ()
 
bool removeFromPlantLoop ()
 Removes the component from the plantLoop if one is attached. More...
 
bool removeFromSecondaryPlantLoop ()
 Removes the component from the secondaryPlantLoop if one is attached. More...
 
bool removeFromTertiaryPlantLoop ()
 Removes the component from the tertiaryPlantLoop if one is attached. More...
 
boost::optional< PlantLoopsecondaryPlantLoop () const
 Returns the optional PlantLoop object that the HVAC component is a demand component on. More...
 
virtual boost::optional
< ModelObject
supplyInletModelObject () const
 Returns the optional ModelObject connected to the supply inlet port. More...
 
virtual unsigned supplyInletPort () const
 Returns the supply inlet port. More...
 
virtual boost::optional
< ModelObject
supplyOutletModelObject () const
 Returns the optional ModelObject connected to the supply outlet port. More...
 
virtual unsigned supplyOutletPort () const
 Returns the supply outlet port. More...
 
boost::optional< ModelObjecttertiaryInletModelObject () const
 Returns the optional ModelObject connected to the tertiary inlet. More...
 
boost::optional< ModelObjecttertiaryOutletModelObject () const
 Returns the optional ModelObject connected to the tertiary outlet. More...
 
boost::optional< PlantLooptertiaryPlantLoop () const
 Tertiary plant loop applies to a limited number of WaterToWaterComponent types that interact with three plant systems. More...
 
 WaterToWaterComponent (IddObjectType type, const Model &model)
 
 WaterToWaterComponent (const WaterToWaterComponent &other)=default
 
 WaterToWaterComponent (WaterToWaterComponent &&other)=default
 
virtual ~WaterToWaterComponent ()=default
 
- 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...
 
std::vector< AppGFuelType > appGHeatingFuelTypes () const
 
void applySizingValues ()
 
void autosize ()
 Returns the optional ModelObject connected to this object's port. More...
 
ComponentType componentType () const
 
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...
 
std::vector< FuelType > coolingFuelTypes () const
 
void disconnect ()
 Removes all connections to other HVACComponent objects. More...
 
std::vector< FuelType > heatingFuelTypes () const
 
 HVACComponent (const HVACComponent &other)=default
 
 HVACComponent (HVACComponent &&other)=default
 
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...
 
HVACComponentoperator= (const HVACComponent &)=default
 
HVACComponentoperator= (HVACComponent &&)=default
 
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 ()=default
 
- 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...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
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...
 
boost::optional< std::string > cadObjectId () const
 
bool setCADObjectId (const std::string &cadObjectId)
 
boost::optional< std::string > gbXMLId () const
 
bool setGBXMLId (const std::string &gbXMLId)
 
boost::optional< std::string > displayName () const
 
bool setDisplayName (const std::string &displayName)
 
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 (const std::string &valueName, const std::string &units) 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 std::vector< std::string > chillerFlowModeValues ()
 
static std::vector< std::string > generatorHeatSourceTypeValues ()
 
static IddObjectType iddObjectType ()
 

Related Functions

(Note that these are not member functions.)

using ChillerAbsorptionVector = std::vector< ChillerAbsorption >
 
using OptionalChillerAbsorption = boost::optional< ChillerAbsorption >
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::HVACComponent
using ImplType = detail::HVACComponent_Impl
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- 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

ChillerAbsorption is a WaterToWaterComponent that wraps the OpenStudio IDD object 'OS:Chiller:Absorption'.

Constructor & Destructor Documentation

openstudio::model::ChillerAbsorption::ChillerAbsorption ( const Model model)
explicit
virtual openstudio::model::ChillerAbsorption::~ChillerAbsorption ( )
virtualdefault
openstudio::model::ChillerAbsorption::ChillerAbsorption ( const ChillerAbsorption other)
default
openstudio::model::ChillerAbsorption::ChillerAbsorption ( ChillerAbsorption &&  other)
default

Member Function Documentation

boost::optional<double> openstudio::model::ChillerAbsorption::autosizedDesignChilledWaterFlowRate ( ) const
boost::optional<double> openstudio::model::ChillerAbsorption::autosizedDesignCondenserWaterFlowRate ( ) const
boost::optional<double> openstudio::model::ChillerAbsorption::autosizedDesignGeneratorFluidFlowRate ( ) const
void openstudio::model::ChillerAbsorption::autosizeDesignChilledWaterFlowRate ( )
void openstudio::model::ChillerAbsorption::autosizeDesignCondenserWaterFlowRate ( )
void openstudio::model::ChillerAbsorption::autosizeDesignGeneratorFluidFlowRate ( )
boost::optional<double> openstudio::model::ChillerAbsorption::autosizedNominalCapacity ( ) const
boost::optional<double> openstudio::model::ChillerAbsorption::autosizedNominalPumpingPower ( ) const
void openstudio::model::ChillerAbsorption::autosizeNominalCapacity ( )
void openstudio::model::ChillerAbsorption::autosizeNominalPumpingPower ( )
boost::optional<PlantLoop> openstudio::model::ChillerAbsorption::chilledWaterLoop ( ) const

Convenience Function to return the Chilled Water Loop (chiller on supply)

double openstudio::model::ChillerAbsorption::chilledWaterOutletTemperatureLowerLimit ( ) const
std::string openstudio::model::ChillerAbsorption::chillerFlowMode ( ) const
static std::vector<std::string> openstudio::model::ChillerAbsorption::chillerFlowModeValues ( )
static
double openstudio::model::ChillerAbsorption::coefficient1oftheHotWaterorSteamUsePartLoadRatioCurve ( ) const
double openstudio::model::ChillerAbsorption::coefficient1ofthePumpElectricUsePartLoadRatioCurve ( ) const
double openstudio::model::ChillerAbsorption::coefficient2oftheHotWaterorSteamUsePartLoadRatioCurve ( ) const
double openstudio::model::ChillerAbsorption::coefficient2ofthePumpElectricUsePartLoadRatioCurve ( ) const
double openstudio::model::ChillerAbsorption::coefficient3oftheHotWaterorSteamUsePartLoadRatioCurve ( ) const
double openstudio::model::ChillerAbsorption::coefficient3ofthePumpElectricUsePartLoadRatioCurve ( ) const
boost::optional<PlantLoop> openstudio::model::ChillerAbsorption::condenserWaterLoop ( ) const

Convenience Function to return the Condenser Water Loop (chiller on demand side)

double openstudio::model::ChillerAbsorption::degreeofSubcoolinginSteamGenerator ( ) const
boost::optional<double> openstudio::model::ChillerAbsorption::designChilledWaterFlowRate ( ) const
double openstudio::model::ChillerAbsorption::designCondenserInletTemperature ( ) const
boost::optional<double> openstudio::model::ChillerAbsorption::designCondenserWaterFlowRate ( ) const
boost::optional<double> openstudio::model::ChillerAbsorption::designGeneratorFluidFlowRate ( ) const
std::string openstudio::model::ChillerAbsorption::generatorHeatSourceType ( ) const
static std::vector<std::string> openstudio::model::ChillerAbsorption::generatorHeatSourceTypeValues ( )
static
boost::optional<PlantLoop> openstudio::model::ChillerAbsorption::generatorLoop ( ) const

Convenience Function to return the Generator Loop (chiller on the demand side - tertiary)

static IddObjectType openstudio::model::ChillerAbsorption::iddObjectType ( )
static
bool openstudio::model::ChillerAbsorption::isDesignChilledWaterFlowRateAutosized ( ) const
bool openstudio::model::ChillerAbsorption::isDesignCondenserWaterFlowRateAutosized ( ) const
bool openstudio::model::ChillerAbsorption::isDesignGeneratorFluidFlowRateAutosized ( ) const
bool openstudio::model::ChillerAbsorption::isNominalCapacityAutosized ( ) const
bool openstudio::model::ChillerAbsorption::isNominalPumpingPowerAutosized ( ) const
double openstudio::model::ChillerAbsorption::maximumPartLoadRatio ( ) const
double openstudio::model::ChillerAbsorption::minimumPartLoadRatio ( ) const
boost::optional<double> openstudio::model::ChillerAbsorption::nominalCapacity ( ) const
boost::optional<double> openstudio::model::ChillerAbsorption::nominalPumpingPower ( ) const
ChillerAbsorption& openstudio::model::ChillerAbsorption::operator= ( const ChillerAbsorption )
default
ChillerAbsorption& openstudio::model::ChillerAbsorption::operator= ( ChillerAbsorption &&  )
default
double openstudio::model::ChillerAbsorption::optimumPartLoadRatio ( ) const
bool openstudio::model::ChillerAbsorption::setChilledWaterOutletTemperatureLowerLimit ( double  chilledWaterOutletTemperatureLowerLimit)
bool openstudio::model::ChillerAbsorption::setChillerFlowMode ( const std::string &  chillerFlowMode)
bool openstudio::model::ChillerAbsorption::setCoefficient1oftheHotWaterorSteamUsePartLoadRatioCurve ( double  coefficient1oftheHotWaterorSteamUsePartLoadRatioCurve)
bool openstudio::model::ChillerAbsorption::setCoefficient1ofthePumpElectricUsePartLoadRatioCurve ( double  coefficient1ofthePumpElectricUsePartLoadRatioCurve)
bool openstudio::model::ChillerAbsorption::setCoefficient2oftheHotWaterorSteamUsePartLoadRatioCurve ( double  coefficient2oftheHotWaterorSteamUsePartLoadRatioCurve)
bool openstudio::model::ChillerAbsorption::setCoefficient2ofthePumpElectricUsePartLoadRatioCurve ( double  coefficient2ofthePumpElectricUsePartLoadRatioCurve)
bool openstudio::model::ChillerAbsorption::setCoefficient3oftheHotWaterorSteamUsePartLoadRatioCurve ( double  coefficient3oftheHotWaterorSteamUsePartLoadRatioCurve)
bool openstudio::model::ChillerAbsorption::setCoefficient3ofthePumpElectricUsePartLoadRatioCurve ( double  coefficient3ofthePumpElectricUsePartLoadRatioCurve)
bool openstudio::model::ChillerAbsorption::setDegreeofSubcoolinginSteamGenerator ( double  degreeofSubcoolinginSteamGenerator)
bool openstudio::model::ChillerAbsorption::setDesignChilledWaterFlowRate ( double  designChilledWaterFlowRate)
bool openstudio::model::ChillerAbsorption::setDesignCondenserInletTemperature ( double  designCondenserInletTemperature)
bool openstudio::model::ChillerAbsorption::setDesignCondenserWaterFlowRate ( double  designCondenserWaterFlowRate)
bool openstudio::model::ChillerAbsorption::setDesignGeneratorFluidFlowRate ( double  designGeneratorFluidFlowRate)
bool openstudio::model::ChillerAbsorption::setGeneratorHeatSourceType ( const std::string &  generatorHeatSourceType)
bool openstudio::model::ChillerAbsorption::setMaximumPartLoadRatio ( double  maximumPartLoadRatio)
bool openstudio::model::ChillerAbsorption::setMinimumPartLoadRatio ( double  minimumPartLoadRatio)
bool openstudio::model::ChillerAbsorption::setNominalCapacity ( double  nominalCapacity)
bool openstudio::model::ChillerAbsorption::setNominalPumpingPower ( double  nominalPumpingPower)
bool openstudio::model::ChillerAbsorption::setOptimumPartLoadRatio ( double  optimumPartLoadRatio)
bool openstudio::model::ChillerAbsorption::setSizingFactor ( double  sizingFactor)
double openstudio::model::ChillerAbsorption::sizingFactor ( ) const

Friends And Related Function Documentation

using ChillerAbsorptionVector = std::vector<ChillerAbsorption>
related
using OptionalChillerAbsorption = boost::optional<ChillerAbsorption>
related