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

#include <AirflowNetworkSimulationControl.hpp>

+ Inheritance diagram for openstudio::model::AirflowNetworkSimulationControl:

Public Member Functions

virtual ~AirflowNetworkSimulationControl ()
 
Getters
boost::optional< std::string > airflowNetworkControl () const
 Determines the type of AirflowNetwork simulation that will be run. More...
 
bool isAirflowNetworkControlDefaulted () const
 Returns true if the type of AirflowNetwork simulation is defaulted. More...
 
boost::optional< std::string > windPressureCoefficientType () const
 
bool isWindPressureCoefficientTypeDefaulted () const
 Returns true if the wind pressure treatment is defaulted. More...
 
boost::optional< std::string > heightSelectionforLocalWindPressureCalculation () const
 
bool isHeightSelectionforLocalWindPressureCalculationDefaulted () const
 Returns true if the height selection procedure is defaulted. More...
 
boost::optional< std::string > buildingType () const
 General building type, used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation. More...
 
bool isBuildingTypeDefaulted () const
 Returns true if the building type is defaulted. More...
 
boost::optional< int > maximumNumberofIterations () const
 Determines the maximum number of iterations used to converge on a solution. More...
 
bool isMaximumNumberofIterationsDefaulted () const
 Returns true if the maximum number of iterations is defaulted. More...
 
boost::optional< std::string > initializationType () const
 Determines how the network equations are initialized. More...
 
bool isInitializationTypeDefaulted () const
 Returns true if the initialization type is defaulted. More...
 
boost::optional< double > relativeAirflowConvergenceTolerance () const
 This tolerance is defined as the absolute value of the sum of the mass flow rates divided by the sum of the absolute value of the mass Flow Rates. More...
 
bool isRelativeAirflowConvergenceToleranceDefaulted () const
 Returns true if the relative convergence tolerance is defaulted. More...
 
boost::optional< double > absoluteAirflowConvergenceTolerance () const
 This tolerance is defined as the absolute value of the sum of the mass flow rates. More...
 
bool isAbsoluteAirflowConvergenceToleranceDefaulted () const
 Returns true if the absolute convergence tolerance is defaulted. More...
 
boost::optional< double > convergenceAccelerationLimit () const
 Used only for AirflowNetwork:SimulationControl. More...
 
bool isConvergenceAccelerationLimitDefaulted () const
 Returns true if the convergence acceleration limit is defaulted. More...
 
boost::optional< double > azimuthAngleofLongAxisofBuilding () const
 Azimuth angle of long axis of building in degrees clockwise from true North. More...
 
bool isAzimuthAngleofLongAxisofBuildingDefaulted () const
 Returns true if the azimuth angle of long axis is defaulted. More...
 
boost::optional< double > buildingAspectRatio () const
 Ratio of building width along short axis to width along long axis. More...
 
bool isBuildingAspectRatioDefaulted () const
 Returns true if the ratio of the building width to length is defaulted. More...
 
bool heightDependenceofExternalNodeTemperature () const
 Returns true if the temperature of external nodes will be computed based on height. More...
 
bool isHeightDependenceofExternalNodeTemperatureDefaulted () const
 Returns true if the external nodes temperature computation type is defaulted. More...
 
std::string solver () const
 
bool isSolverDefaulted () const
 
bool allowUnsupportedZoneEquipment () const
 
bool isAllowUnsupportedZoneEquipmentDefaulted () const
 
Setters
bool setAirflowNetworkControl (std::string airflowNetworkControl)
 Sets the airflow network control type. More...
 
void resetAirflowNetworkControl ()
 Resets the airflow network control type. More...
 
bool setWindPressureCoefficientType (std::string type)
 Sets the wind pressure coefficient type. More...
 
void resetWindPressureCoefficientType ()
 Resets the wind pressure coefficient type. More...
 
bool setHeightSelectionforLocalWindPressureCalculation (std::string height)
 Sets the height selection procedure. More...
 
void resetHeightSelectionforLocalWindPressureCalculation ()
 Resets the height selection procedure. More...
 
bool setBuildingType (std::string type)
 Sets the building type. More...
 
void resetBuildingType ()
 Resets the building type. More...
 
bool setMaximumNumberofIterations (int number)
 Sets the maximum number of iteration. More...
 
void resetMaximumNumberofIterations ()
 Resets the maximum number of iteration. More...
 
bool setInitializationType (std::string type)
 Sets the initialization type. More...
 
void resetInitializationType ()
 Resets the initialization type. More...
 
bool setRelativeAirflowConvergenceTolerance (double tolerance)
 Sets the relative airflow convergence tolerance. More...
 
void resetRelativeAirflowConvergenceTolerance ()
 Resets the relative airflow convergence tolerance. More...
 
bool setAbsoluteAirflowConvergenceTolerance (double tolerance)
 Sets the absolute airflow convergence tolerance. More...
 
void resetAbsoluteAirflowConvergenceTolerance ()
 Resets the absolute airflow convergence tolerance. More...
 
bool setConvergenceAccelerationLimit (double limit)
 Sets the convergence acceleration limit. More...
 
void resetConvergenceAccelerationLimit ()
 Resets the convergence acceleration limit. More...
 
bool setAzimuthAngleofLongAxisofBuilding (double angle)
 Sets the azimuthal angle of the building. More...
 
void resetAzimuthAngleofLongAxisofBuilding ()
 Resets the azimuthal angle of the building. More...
 
bool setBuildingAspectRatio (double ratio)
 Sets the building aspect ratio. More...
 
void resetBuildingAspectRatio ()
 Resets the building aspect ratio. More...
 
bool setHeightDependenceofExternalNodeTemperature (bool tf)
 Sets the external nodes temperature computation type. More...
 
void resetHeightDependenceofExternalNodeTemperature ()
 Resets the external nodes temperature computation type. More...
 
bool setSolver (const std::string &solver)
 
void resetSolver ()
 
bool setAllowUnsupportedZoneEquipment (bool allowUnsupportedZoneEquipment)
 
void resetAllowUnsupportedZoneEquipment ()
 
- 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 Methods
static IddObjectType iddObjectType ()
 
static std::vector< std::string > solverValues ()
 

Protected Member Functions

Constructors and Destructors
 AirflowNetworkSimulationControl (const Model &model)
 Constructs a new SimulationControl object in the model. More...
 
- 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)
 

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< AirflowNetworkSimulationControl
OptionalAirflowNetworkSimulationControl
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 

Detailed Description

AirflowNetworkSimulationControl derives from ParentObject and is an interface to the OpenStudio IDD object named "AirflowNetwork:SimulationControl".

AirflowNetworkSimulationControl defines what types of multizone airflow calculations are part of an EnergyPlus simulation. AirflowNetworkSimulationControl parents several other ModelObject types that configure simulation parameters for EnergyPlus. AirflowNetworkSimulationControl does not have a public constructor because it is a unique ModelObject. To get the AirflowNetworkSimulationControl object for a Model or create one if it does not yet exist use model.getUniqueObject<AirflowNetworkSimulationControl>(). To get the AirflowNetworkSimulationControl object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<AirflowNetworkSimulationControl>().

Constructor & Destructor Documentation

virtual openstudio::model::AirflowNetworkSimulationControl::~AirflowNetworkSimulationControl ( )
inlinevirtual
openstudio::model::AirflowNetworkSimulationControl::AirflowNetworkSimulationControl ( const Model model)
explicitprotected

Constructs a new SimulationControl object in the model.

Member Function Documentation

boost::optional<double> openstudio::model::AirflowNetworkSimulationControl::absoluteAirflowConvergenceTolerance ( ) const

This tolerance is defined as the absolute value of the sum of the mass flow rates.

The mass flow rates described here refer to the mass flow rates at all nodes in the AirflowNetwork model. The solution converges when both this tolerance and the tolerance in the previous field (Relative Airflow Convergence Tolerance) are satisfied.

boost::optional<std::string> openstudio::model::AirflowNetworkSimulationControl::airflowNetworkControl ( ) const

Determines the type of AirflowNetwork simulation that will be run.

NoMultizoneOrDistribution: Only perform Simple calculations (objects ZoneInfiltration:*, ZoneVentilation:*, ZoneMixing, ZoneCrossMixing, ZoneRefrigerationDoorMixing, ZoneAirBalance:OutdoorAir, ZoneEarthtube, ZoneThermalChimney, and ZoneCoolTower:Shower);

MultizoneWithoutDistribution: Use AirflowNetwork objects to simulate multizone Airflows driven by wind during simulation time, and objects of ZoneInfiltration:*, ZoneVentilation:*, ZoneMixing, ZoneCrossMixing, ZoneRefrigerationDoorMixing, ZoneAirBalance:OutdoorAir, ZoneEarthtube, ZoneThermalChimney, and ZoneCoolTower:Shower are ignored;

MultizoneWithDistributionOnlyDuringFanOperation: Perform distribution system calculations during system fan on time and Simple calculations during system Fan off time;

MultizoneWithDistribution: Perform distribution system calculations during system fan on time and multizone Airflow driven by wind during system fan off time.

bool openstudio::model::AirflowNetworkSimulationControl::allowUnsupportedZoneEquipment ( ) const
boost::optional<double> openstudio::model::AirflowNetworkSimulationControl::azimuthAngleofLongAxisofBuilding ( ) const

Azimuth angle of long axis of building in degrees clockwise from true North.

Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation.

boost::optional<double> openstudio::model::AirflowNetworkSimulationControl::buildingAspectRatio ( ) const

Ratio of building width along short axis to width along long axis.

Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation.

boost::optional<std::string> openstudio::model::AirflowNetworkSimulationControl::buildingType ( ) const

General building type, used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation.

boost::optional<double> openstudio::model::AirflowNetworkSimulationControl::convergenceAccelerationLimit ( ) const

Used only for AirflowNetwork:SimulationControl.

bool openstudio::model::AirflowNetworkSimulationControl::heightDependenceofExternalNodeTemperature ( ) const

Returns true if the temperature of external nodes will be computed based on height.

boost::optional<std::string> openstudio::model::AirflowNetworkSimulationControl::heightSelectionforLocalWindPressureCalculation ( ) const
static IddObjectType openstudio::model::AirflowNetworkSimulationControl::iddObjectType ( )
static
boost::optional<std::string> openstudio::model::AirflowNetworkSimulationControl::initializationType ( ) const

Determines how the network equations are initialized.

bool openstudio::model::AirflowNetworkSimulationControl::isAbsoluteAirflowConvergenceToleranceDefaulted ( ) const

Returns true if the absolute convergence tolerance is defaulted.

bool openstudio::model::AirflowNetworkSimulationControl::isAirflowNetworkControlDefaulted ( ) const

Returns true if the type of AirflowNetwork simulation is defaulted.

bool openstudio::model::AirflowNetworkSimulationControl::isAllowUnsupportedZoneEquipmentDefaulted ( ) const
bool openstudio::model::AirflowNetworkSimulationControl::isAzimuthAngleofLongAxisofBuildingDefaulted ( ) const

Returns true if the azimuth angle of long axis is defaulted.

bool openstudio::model::AirflowNetworkSimulationControl::isBuildingAspectRatioDefaulted ( ) const

Returns true if the ratio of the building width to length is defaulted.

bool openstudio::model::AirflowNetworkSimulationControl::isBuildingTypeDefaulted ( ) const

Returns true if the building type is defaulted.

bool openstudio::model::AirflowNetworkSimulationControl::isConvergenceAccelerationLimitDefaulted ( ) const

Returns true if the convergence acceleration limit is defaulted.

bool openstudio::model::AirflowNetworkSimulationControl::isHeightDependenceofExternalNodeTemperatureDefaulted ( ) const

Returns true if the external nodes temperature computation type is defaulted.

bool openstudio::model::AirflowNetworkSimulationControl::isHeightSelectionforLocalWindPressureCalculationDefaulted ( ) const

Returns true if the height selection procedure is defaulted.

bool openstudio::model::AirflowNetworkSimulationControl::isInitializationTypeDefaulted ( ) const

Returns true if the initialization type is defaulted.

bool openstudio::model::AirflowNetworkSimulationControl::isMaximumNumberofIterationsDefaulted ( ) const

Returns true if the maximum number of iterations is defaulted.

bool openstudio::model::AirflowNetworkSimulationControl::isRelativeAirflowConvergenceToleranceDefaulted ( ) const

Returns true if the relative convergence tolerance is defaulted.

bool openstudio::model::AirflowNetworkSimulationControl::isSolverDefaulted ( ) const
bool openstudio::model::AirflowNetworkSimulationControl::isWindPressureCoefficientTypeDefaulted ( ) const

Returns true if the wind pressure treatment is defaulted.

boost::optional<int> openstudio::model::AirflowNetworkSimulationControl::maximumNumberofIterations ( ) const

Determines the maximum number of iterations used to converge on a solution.

If this limit is exceeded, the program terminates.

boost::optional<double> openstudio::model::AirflowNetworkSimulationControl::relativeAirflowConvergenceTolerance ( ) const

This tolerance is defined as the absolute value of the sum of the mass flow rates divided by the sum of the absolute value of the mass Flow Rates.

The mass flow rates described here refer to the mass Flow Rates at all Nodes in the AirflowNetwork model. The solution converges when both this tolerance and the tolerance in the Absolute Airflow Convergence Tolerance field are satisfied.

void openstudio::model::AirflowNetworkSimulationControl::resetAbsoluteAirflowConvergenceTolerance ( )

Resets the absolute airflow convergence tolerance.

void openstudio::model::AirflowNetworkSimulationControl::resetAirflowNetworkControl ( )

Resets the airflow network control type.

void openstudio::model::AirflowNetworkSimulationControl::resetAllowUnsupportedZoneEquipment ( )
void openstudio::model::AirflowNetworkSimulationControl::resetAzimuthAngleofLongAxisofBuilding ( )

Resets the azimuthal angle of the building.

void openstudio::model::AirflowNetworkSimulationControl::resetBuildingAspectRatio ( )

Resets the building aspect ratio.

void openstudio::model::AirflowNetworkSimulationControl::resetBuildingType ( )

Resets the building type.

void openstudio::model::AirflowNetworkSimulationControl::resetConvergenceAccelerationLimit ( )

Resets the convergence acceleration limit.

void openstudio::model::AirflowNetworkSimulationControl::resetHeightDependenceofExternalNodeTemperature ( )

Resets the external nodes temperature computation type.

void openstudio::model::AirflowNetworkSimulationControl::resetHeightSelectionforLocalWindPressureCalculation ( )

Resets the height selection procedure.

void openstudio::model::AirflowNetworkSimulationControl::resetInitializationType ( )

Resets the initialization type.

void openstudio::model::AirflowNetworkSimulationControl::resetMaximumNumberofIterations ( )

Resets the maximum number of iteration.

void openstudio::model::AirflowNetworkSimulationControl::resetRelativeAirflowConvergenceTolerance ( )

Resets the relative airflow convergence tolerance.

void openstudio::model::AirflowNetworkSimulationControl::resetSolver ( )
void openstudio::model::AirflowNetworkSimulationControl::resetWindPressureCoefficientType ( )

Resets the wind pressure coefficient type.

bool openstudio::model::AirflowNetworkSimulationControl::setAbsoluteAirflowConvergenceTolerance ( double  tolerance)

Sets the absolute airflow convergence tolerance.

bool openstudio::model::AirflowNetworkSimulationControl::setAirflowNetworkControl ( std::string  airflowNetworkControl)

Sets the airflow network control type.

bool openstudio::model::AirflowNetworkSimulationControl::setAllowUnsupportedZoneEquipment ( bool  allowUnsupportedZoneEquipment)
bool openstudio::model::AirflowNetworkSimulationControl::setAzimuthAngleofLongAxisofBuilding ( double  angle)

Sets the azimuthal angle of the building.

bool openstudio::model::AirflowNetworkSimulationControl::setBuildingAspectRatio ( double  ratio)

Sets the building aspect ratio.

bool openstudio::model::AirflowNetworkSimulationControl::setBuildingType ( std::string  type)

Sets the building type.

bool openstudio::model::AirflowNetworkSimulationControl::setConvergenceAccelerationLimit ( double  limit)

Sets the convergence acceleration limit.

bool openstudio::model::AirflowNetworkSimulationControl::setHeightDependenceofExternalNodeTemperature ( bool  tf)

Sets the external nodes temperature computation type.

bool openstudio::model::AirflowNetworkSimulationControl::setHeightSelectionforLocalWindPressureCalculation ( std::string  height)

Sets the height selection procedure.

bool openstudio::model::AirflowNetworkSimulationControl::setInitializationType ( std::string  type)

Sets the initialization type.

bool openstudio::model::AirflowNetworkSimulationControl::setMaximumNumberofIterations ( int  number)

Sets the maximum number of iteration.

bool openstudio::model::AirflowNetworkSimulationControl::setRelativeAirflowConvergenceTolerance ( double  tolerance)

Sets the relative airflow convergence tolerance.

bool openstudio::model::AirflowNetworkSimulationControl::setSolver ( const std::string &  solver)
bool openstudio::model::AirflowNetworkSimulationControl::setWindPressureCoefficientType ( std::string  type)

Sets the wind pressure coefficient type.

std::string openstudio::model::AirflowNetworkSimulationControl::solver ( ) const
static std::vector<std::string> openstudio::model::AirflowNetworkSimulationControl::solverValues ( )
static
boost::optional<std::string> openstudio::model::AirflowNetworkSimulationControl::windPressureCoefficientType ( ) const

Friends And Related Function Documentation