#include <HeatExchangerFluidToFluid.hpp>
Public Member Functions | |
Constructors and Destructors | |
HeatExchangerFluidToFluid (const Model &model) | |
virtual | ~HeatExchangerFluidToFluid ()=default |
HeatExchangerFluidToFluid (const HeatExchangerFluidToFluid &other)=default | |
HeatExchangerFluidToFluid (HeatExchangerFluidToFluid &&other)=default | |
HeatExchangerFluidToFluid & | operator= (const HeatExchangerFluidToFluid &)=default |
HeatExchangerFluidToFluid & | operator= (HeatExchangerFluidToFluid &&)=default |
Getters | |
boost::optional< Schedule > | availabilitySchedule () const |
boost::optional< double > | loopDemandSideDesignFlowRate () const |
bool | isLoopDemandSideDesignFlowRateAutosized () const |
boost::optional< double > | loopSupplySideDesignFlowRate () const |
bool | isLoopSupplySideDesignFlowRateAutosized () const |
std::string | heatExchangeModelType () const |
bool | isHeatExchangeModelTypeDefaulted () const |
boost::optional< double > | heatExchangerUFactorTimesAreaValue () const |
bool | isHeatExchangerUFactorTimesAreaValueAutosized () const |
std::string | controlType () const |
bool | isControlTypeDefaulted () const |
double | minimumTemperatureDifferencetoActivateHeatExchanger () const |
bool | isMinimumTemperatureDifferencetoActivateHeatExchangerDefaulted () const |
std::string | heatTransferMeteringEndUseType () const |
bool | isHeatTransferMeteringEndUseTypeDefaulted () const |
boost::optional< Node > | componentOverrideLoopSupplySideInletNode () const |
boost::optional< Node > | componentOverrideLoopDemandSideInletNode () const |
std::string | componentOverrideCoolingControlTemperatureMode () const |
bool | isComponentOverrideCoolingControlTemperatureModeDefaulted () const |
double | sizingFactor () const |
bool | isSizingFactorDefaulted () const |
boost::optional< double > | operationMinimumTemperatureLimit () const |
boost::optional< double > | operationMaximumTemperatureLimit () const |
Setters | |
bool | setAvailabilitySchedule (Schedule &schedule) |
void | resetAvailabilitySchedule () |
bool | setLoopDemandSideDesignFlowRate (double loopDemandSideDesignFlowRate) |
void | autosizeLoopDemandSideDesignFlowRate () |
bool | setLoopSupplySideDesignFlowRate (double loopSupplySideDesignFlowRate) |
void | autosizeLoopSupplySideDesignFlowRate () |
bool | setHeatExchangeModelType (const std::string &heatExchangeModelType) |
void | resetHeatExchangeModelType () |
bool | setHeatExchangerUFactorTimesAreaValue (double heatExchangerUFactorTimesAreaValue) |
void | autosizeHeatExchangerUFactorTimesAreaValue () |
bool | setControlType (const std::string &controlType) |
void | resetControlType () |
bool | setMinimumTemperatureDifferencetoActivateHeatExchanger (double minimumTemperatureDifferencetoActivateHeatExchanger) |
void | resetMinimumTemperatureDifferencetoActivateHeatExchanger () |
bool | setHeatTransferMeteringEndUseType (const std::string &heatTransferMeteringEndUseType) |
void | resetHeatTransferMeteringEndUseType () |
bool | setComponentOverrideLoopSupplySideInletNode (const Node &node) |
void | resetComponentOverrideLoopSupplySideInletNode () |
bool | setComponentOverrideLoopDemandSideInletNode (const Node &node) |
void | resetComponentOverrideLoopDemandSideInletNode () |
bool | setComponentOverrideCoolingControlTemperatureMode (const std::string &componentOverrideCoolingControlTemperatureMode) |
void | resetComponentOverrideCoolingControlTemperatureMode () |
bool | setSizingFactor (double sizingFactor) |
void | resetSizingFactor () |
bool | setOperationMinimumTemperatureLimit (double operationMinimumTemperatureLimit) |
void | resetOperationMinimumTemperatureLimit () |
bool | setOperationMaximumTemperatureLimit (double operationMaximumTemperatureLimit) |
void | resetOperationMaximumTemperatureLimit () |
Other | |
boost::optional< double > | autosizedLoopDemandSideDesignFlowRate () const |
boost::optional< double > | autosizedLoopSupplySideDesignFlowRate () const |
boost::optional< double > | autosizedHeatExchangerUFactorTimesAreaValue () const |
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 () |
WaterToWaterComponent & | operator= (const WaterToWaterComponent &)=default |
WaterToWaterComponent & | operator= (WaterToWaterComponent &&)=default |
boost::optional< PlantLoop > | plantLoop () 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< PlantLoop > | secondaryPlantLoop () 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< ModelObject > | tertiaryInletModelObject () const |
Returns the optional ModelObject connected to the tertiary inlet. More... | |
boost::optional< ModelObject > | tertiaryOutletModelObject () const |
Returns the optional ModelObject connected to the tertiary outlet. More... | |
boost::optional< PlantLoop > | tertiaryPlantLoop () 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< AirLoopHVAC > | airLoopHVAC () 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< HVACComponent > | containingHVACComponent () 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< Loop > | loop () const |
Returns the optional Loop object that the HVAC component is attached to. More... | |
HVACComponent & | operator= (const HVACComponent &)=default |
HVACComponent & | operator= (HVACComponent &&)=default |
boost::optional< PlantLoop > | plantLoop () 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< ModelObject > | children () const |
Return direct child objects in the Model. More... | |
ParentObject & | operator= (const ParentObject &)=default |
ParentObject & | operator= (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 | |
ModelObject & | operator= (const ModelObject &)=default |
ModelObject & | operator= (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< ParentObject > | parent () const |
Return this object's parent in the hierarchy, if it has one. More... | |
std::vector< ResourceObject > | resources () 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< OutputVariable > | outputVariables () 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< LifeCycleCost > | lifeCycleCosts () 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< ScheduleTypeKey > | getScheduleTypeKeys (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< ModelObject > | connectedObject (unsigned port) const |
boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
static std::vector< std::string > | componentOverrideCoolingControlTemperatureModeValues () |
static std::vector< std::string > | controlTypeValues () |
static std::vector< std::string > | heatExchangeModelTypeValues () |
static std::vector< std::string > | heatTransferMeteringEndUseTypeValues () |
static IddObjectType | iddObjectType () |
Related Functions | |
(Note that these are not member functions.) | |
using | HeatExchangerFluidToFluidVector = std::vector< HeatExchangerFluidToFluid > |
using | OptionalHeatExchangerFluidToFluid = boost::optional< HeatExchangerFluidToFluid > |
Related Functions inherited from openstudio::model::ParentObject | |
std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true) |
Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
Related Functions inherited from openstudio::model::ModelObject | |
std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
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< ModelObject > | children () 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) | |
HeatExchangerFluidToFluid is a WaterToWaterComponent that wraps the OpenStudio IDD object 'OS:HeatExchanger:FluidToFluid'.
|
explicit |
|
virtualdefault |
|
default |
|
default |
boost::optional<double> openstudio::model::HeatExchangerFluidToFluid::autosizedHeatExchangerUFactorTimesAreaValue | ( | ) | const |
boost::optional<double> openstudio::model::HeatExchangerFluidToFluid::autosizedLoopDemandSideDesignFlowRate | ( | ) | const |
boost::optional<double> openstudio::model::HeatExchangerFluidToFluid::autosizedLoopSupplySideDesignFlowRate | ( | ) | const |
void openstudio::model::HeatExchangerFluidToFluid::autosizeHeatExchangerUFactorTimesAreaValue | ( | ) |
void openstudio::model::HeatExchangerFluidToFluid::autosizeLoopDemandSideDesignFlowRate | ( | ) |
void openstudio::model::HeatExchangerFluidToFluid::autosizeLoopSupplySideDesignFlowRate | ( | ) |
boost::optional<Schedule> openstudio::model::HeatExchangerFluidToFluid::availabilitySchedule | ( | ) | const |
std::string openstudio::model::HeatExchangerFluidToFluid::componentOverrideCoolingControlTemperatureMode | ( | ) | const |
|
static |
boost::optional<Node> openstudio::model::HeatExchangerFluidToFluid::componentOverrideLoopDemandSideInletNode | ( | ) | const |
boost::optional<Node> openstudio::model::HeatExchangerFluidToFluid::componentOverrideLoopSupplySideInletNode | ( | ) | const |
std::string openstudio::model::HeatExchangerFluidToFluid::controlType | ( | ) | const |
|
static |
std::string openstudio::model::HeatExchangerFluidToFluid::heatExchangeModelType | ( | ) | const |
|
static |
boost::optional<double> openstudio::model::HeatExchangerFluidToFluid::heatExchangerUFactorTimesAreaValue | ( | ) | const |
std::string openstudio::model::HeatExchangerFluidToFluid::heatTransferMeteringEndUseType | ( | ) | const |
|
static |
|
static |
bool openstudio::model::HeatExchangerFluidToFluid::isComponentOverrideCoolingControlTemperatureModeDefaulted | ( | ) | const |
bool openstudio::model::HeatExchangerFluidToFluid::isControlTypeDefaulted | ( | ) | const |
bool openstudio::model::HeatExchangerFluidToFluid::isHeatExchangeModelTypeDefaulted | ( | ) | const |
bool openstudio::model::HeatExchangerFluidToFluid::isHeatExchangerUFactorTimesAreaValueAutosized | ( | ) | const |
bool openstudio::model::HeatExchangerFluidToFluid::isHeatTransferMeteringEndUseTypeDefaulted | ( | ) | const |
bool openstudio::model::HeatExchangerFluidToFluid::isLoopDemandSideDesignFlowRateAutosized | ( | ) | const |
bool openstudio::model::HeatExchangerFluidToFluid::isLoopSupplySideDesignFlowRateAutosized | ( | ) | const |
bool openstudio::model::HeatExchangerFluidToFluid::isMinimumTemperatureDifferencetoActivateHeatExchangerDefaulted | ( | ) | const |
bool openstudio::model::HeatExchangerFluidToFluid::isSizingFactorDefaulted | ( | ) | const |
boost::optional<double> openstudio::model::HeatExchangerFluidToFluid::loopDemandSideDesignFlowRate | ( | ) | const |
boost::optional<double> openstudio::model::HeatExchangerFluidToFluid::loopSupplySideDesignFlowRate | ( | ) | const |
double openstudio::model::HeatExchangerFluidToFluid::minimumTemperatureDifferencetoActivateHeatExchanger | ( | ) | const |
boost::optional<double> openstudio::model::HeatExchangerFluidToFluid::operationMaximumTemperatureLimit | ( | ) | const |
boost::optional<double> openstudio::model::HeatExchangerFluidToFluid::operationMinimumTemperatureLimit | ( | ) | const |
|
default |
|
default |
void openstudio::model::HeatExchangerFluidToFluid::resetAvailabilitySchedule | ( | ) |
void openstudio::model::HeatExchangerFluidToFluid::resetComponentOverrideCoolingControlTemperatureMode | ( | ) |
void openstudio::model::HeatExchangerFluidToFluid::resetComponentOverrideLoopDemandSideInletNode | ( | ) |
void openstudio::model::HeatExchangerFluidToFluid::resetComponentOverrideLoopSupplySideInletNode | ( | ) |
void openstudio::model::HeatExchangerFluidToFluid::resetControlType | ( | ) |
void openstudio::model::HeatExchangerFluidToFluid::resetHeatExchangeModelType | ( | ) |
void openstudio::model::HeatExchangerFluidToFluid::resetHeatTransferMeteringEndUseType | ( | ) |
void openstudio::model::HeatExchangerFluidToFluid::resetMinimumTemperatureDifferencetoActivateHeatExchanger | ( | ) |
void openstudio::model::HeatExchangerFluidToFluid::resetOperationMaximumTemperatureLimit | ( | ) |
void openstudio::model::HeatExchangerFluidToFluid::resetOperationMinimumTemperatureLimit | ( | ) |
void openstudio::model::HeatExchangerFluidToFluid::resetSizingFactor | ( | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setAvailabilitySchedule | ( | Schedule & | schedule | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setComponentOverrideCoolingControlTemperatureMode | ( | const std::string & | componentOverrideCoolingControlTemperatureMode | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setComponentOverrideLoopDemandSideInletNode | ( | const Node & | node | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setComponentOverrideLoopSupplySideInletNode | ( | const Node & | node | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setControlType | ( | const std::string & | controlType | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setHeatExchangeModelType | ( | const std::string & | heatExchangeModelType | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setHeatExchangerUFactorTimesAreaValue | ( | double | heatExchangerUFactorTimesAreaValue | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setHeatTransferMeteringEndUseType | ( | const std::string & | heatTransferMeteringEndUseType | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setLoopDemandSideDesignFlowRate | ( | double | loopDemandSideDesignFlowRate | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setLoopSupplySideDesignFlowRate | ( | double | loopSupplySideDesignFlowRate | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setMinimumTemperatureDifferencetoActivateHeatExchanger | ( | double | minimumTemperatureDifferencetoActivateHeatExchanger | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setOperationMaximumTemperatureLimit | ( | double | operationMaximumTemperatureLimit | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setOperationMinimumTemperatureLimit | ( | double | operationMinimumTemperatureLimit | ) |
bool openstudio::model::HeatExchangerFluidToFluid::setSizingFactor | ( | double | sizingFactor | ) |
double openstudio::model::HeatExchangerFluidToFluid::sizingFactor | ( | ) | const |
|
related |
|
related |