 |
OpenStudio:model |
|
OpenStudio:model |
#include "AirflowNetworkSimulationControl.hpp"
Static Public Member Functions | |
| static IddObjectType | iddObjectType () |
| static std::vector< std::string > | solverValues () |
Protected Member Functions | |
| AirflowNetworkSimulationControl (const Model &model) | |
Related Functions | |
| using | OptionalAirflowNetworkSimulationControl = boost::optional< AirflowNetworkSimulationControl > |
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>().
|
virtualdefault |
|
default |
|
default |
|
explicitprotected |
Constructs a new SimulationControl object in the model.
| 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 |
| 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.
|
default |
|
default |
| 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 | ( | const 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 | ( | const 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 | ( | const std::string & | height | ) |
Sets the height selection procedure.
| bool openstudio::model::AirflowNetworkSimulationControl::setInitializationType | ( | const 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 | ( | const std::string & | type | ) |
Sets the wind pressure coefficient type.
| std::string openstudio::model::AirflowNetworkSimulationControl::solver | ( | ) | const |
|
static |
| boost::optional<std::string> openstudio::model::AirflowNetworkSimulationControl::windPressureCoefficientType | ( | ) | const |
|
related |