#include <GroundHeatExchangerHorizontalTrench.hpp>
Public Member Functions | |
Constructors and Destructors | |
GroundHeatExchangerHorizontalTrench (const Model &model) | |
virtual | ~GroundHeatExchangerHorizontalTrench () |
Getters | |
double | designFlowRate () const |
double | trenchLengthinPipeAxialDirection () const |
int | numberofTrenches () const |
double | horizontalSpacingBetweenPipes () const |
double | pipeInnerDiameter () const |
double | pipeOuterDiameter () const |
double | burialDepth () const |
double | soilThermalConductivity () const |
double | soilDensity () const |
double | soilSpecificHeat () const |
double | pipeThermalConductivity () const |
double | pipeDensity () const |
double | pipeSpecificHeat () const |
double | soilMoistureContentPercent () const |
double | soilMoistureContentPercentatSaturation () const |
std::string | groundTemperatureModel () const |
bool | isGroundTemperatureModelDefaulted () const |
double | kusudaAchenbachAverageSurfaceTemperature () const |
double | kusudaAchenbachAverageAmplitudeofSurfaceTemperature () const |
double | kusudaAchenbachPhaseShiftofMinimumSurfaceTemperature () const |
double | evapotranspirationGroundCoverParameter () const |
Setters | |
bool | setDesignFlowRate (double designFlowRate) |
bool | setTrenchLengthinPipeAxialDirection (double trenchLengthinPipeAxialDirection) |
bool | setNumberofTrenches (int numberofTrenches) |
bool | setHorizontalSpacingBetweenPipes (double horizontalSpacingBetweenPipes) |
bool | setPipeInnerDiameter (double pipeInnerDiameter) |
bool | setPipeOuterDiameter (double pipeOuterDiameter) |
bool | setBurialDepth (double burialDepth) |
bool | setSoilThermalConductivity (double soilThermalConductivity) |
bool | setSoilDensity (double soilDensity) |
bool | setSoilSpecificHeat (double soilSpecificHeat) |
bool | setPipeThermalConductivity (double pipeThermalConductivity) |
bool | setPipeDensity (double pipeDensity) |
bool | setPipeSpecificHeat (double pipeSpecificHeat) |
bool | setSoilMoistureContentPercent (double soilMoistureContentPercent) |
bool | setSoilMoistureContentPercentatSaturation (double soilMoistureContentPercentatSaturation) |
bool | setGroundTemperatureModel (const std::string &groundTemperatureModel) |
void | resetGroundTemperatureModel () |
bool | setKusudaAchenbachAverageSurfaceTemperature (double kusudaAchenbachAverageSurfaceTemperature) |
bool | setKusudaAchenbachAverageAmplitudeofSurfaceTemperature (double kusudaAchenbachAverageAmplitudeofSurfaceTemperature) |
bool | setKusudaAchenbachPhaseShiftofMinimumSurfaceTemperature (double kusudaAchenbachPhaseShiftofMinimumSurfaceTemperature) |
bool | setEvapotranspirationGroundCoverParameter (double evapotranspirationGroundCoverParameter) |
Public Member Functions inherited from openstudio::model::StraightComponent | |
bool | addToNode (Node &node) |
boost::optional< AirLoopHVAC > | airLoopHVAC () const |
Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More... | |
ModelObject | clone (Model model) const |
void | disconnect () |
boost::optional< ModelObject > | inletModelObject () const |
Returns the optional ModelObject connected to the inlet port. More... | |
unsigned | inletPort () const |
Returns the inlet port. More... | |
boost::optional< ModelObject > | outletModelObject () 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< 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... | |
void | applySizingValues () |
void | autosize () |
Returns the optional ModelObject connected to this object's port. More... | |
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... | |
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< Loop > | loop () const |
Returns the optional Loop object that the HVAC component is attached to. More... | |
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 () |
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... | |
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< 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... | |
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 (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< ModelObject > | connectedObject (unsigned port) const |
boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
static std::vector< std::string > | groundTemperatureModelValues () |
static IddObjectType | iddObjectType () |
Related Functions | |
(Note that these are not member functions.) | |
typedef std::vector < GroundHeatExchangerHorizontalTrench > | GroundHeatExchangerHorizontalTrenchVector |
typedef boost::optional < GroundHeatExchangerHorizontalTrench > | OptionalGroundHeatExchangerHorizontalTrench |
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 | |
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< 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) | |
GroundHeatExchangerHorizontalTrench is a StraightComponent that wraps the OpenStudio IDD object 'OS:GroundHeatExchanger:HorizontalTrench'.
|
explicit |
|
inlinevirtual |
double openstudio::model::GroundHeatExchangerHorizontalTrench::burialDepth | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::designFlowRate | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::evapotranspirationGroundCoverParameter | ( | ) | const |
std::string openstudio::model::GroundHeatExchangerHorizontalTrench::groundTemperatureModel | ( | ) | const |
|
static |
double openstudio::model::GroundHeatExchangerHorizontalTrench::horizontalSpacingBetweenPipes | ( | ) | const |
|
static |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::isGroundTemperatureModelDefaulted | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::kusudaAchenbachAverageAmplitudeofSurfaceTemperature | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::kusudaAchenbachAverageSurfaceTemperature | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::kusudaAchenbachPhaseShiftofMinimumSurfaceTemperature | ( | ) | const |
int openstudio::model::GroundHeatExchangerHorizontalTrench::numberofTrenches | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::pipeDensity | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::pipeInnerDiameter | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::pipeOuterDiameter | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::pipeSpecificHeat | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::pipeThermalConductivity | ( | ) | const |
void openstudio::model::GroundHeatExchangerHorizontalTrench::resetGroundTemperatureModel | ( | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setBurialDepth | ( | double | burialDepth | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setDesignFlowRate | ( | double | designFlowRate | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setEvapotranspirationGroundCoverParameter | ( | double | evapotranspirationGroundCoverParameter | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setGroundTemperatureModel | ( | const std::string & | groundTemperatureModel | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setHorizontalSpacingBetweenPipes | ( | double | horizontalSpacingBetweenPipes | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setKusudaAchenbachAverageAmplitudeofSurfaceTemperature | ( | double | kusudaAchenbachAverageAmplitudeofSurfaceTemperature | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setKusudaAchenbachAverageSurfaceTemperature | ( | double | kusudaAchenbachAverageSurfaceTemperature | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setKusudaAchenbachPhaseShiftofMinimumSurfaceTemperature | ( | double | kusudaAchenbachPhaseShiftofMinimumSurfaceTemperature | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setNumberofTrenches | ( | int | numberofTrenches | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setPipeDensity | ( | double | pipeDensity | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setPipeInnerDiameter | ( | double | pipeInnerDiameter | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setPipeOuterDiameter | ( | double | pipeOuterDiameter | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setPipeSpecificHeat | ( | double | pipeSpecificHeat | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setPipeThermalConductivity | ( | double | pipeThermalConductivity | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setSoilDensity | ( | double | soilDensity | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setSoilMoistureContentPercent | ( | double | soilMoistureContentPercent | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setSoilMoistureContentPercentatSaturation | ( | double | soilMoistureContentPercentatSaturation | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setSoilSpecificHeat | ( | double | soilSpecificHeat | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setSoilThermalConductivity | ( | double | soilThermalConductivity | ) |
bool openstudio::model::GroundHeatExchangerHorizontalTrench::setTrenchLengthinPipeAxialDirection | ( | double | trenchLengthinPipeAxialDirection | ) |
double openstudio::model::GroundHeatExchangerHorizontalTrench::soilDensity | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::soilMoistureContentPercent | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::soilMoistureContentPercentatSaturation | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::soilSpecificHeat | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::soilThermalConductivity | ( | ) | const |
double openstudio::model::GroundHeatExchangerHorizontalTrench::trenchLengthinPipeAxialDirection | ( | ) | const |
|
related |
|
related |