#include <SpaceInfiltrationDesignFlowRate.hpp>

Inheritance diagram for openstudio::model::SpaceInfiltrationDesignFlowRate:

Public Member Functions
Constructors and Destructors
	SpaceInfiltrationDesignFlowRate (const Model &model)

virtual	~SpaceInfiltrationDesignFlowRate ()

Getters
boost::optional< Schedule >	schedule () const
	Returns the (fractional) infiltration schedule. More...

bool	isScheduleDefaulted () const
	Returns true if this object does not specify a schedule directly. More...

std::string	designFlowRateCalculationMethod () const

boost::optional< double >	designFlowRate () const

boost::optional< double >	flowperSpaceFloorArea () const

boost::optional< double >	flowperExteriorSurfaceArea () const

boost::optional< double >	flowperExteriorWallArea () const

boost::optional< double >	airChangesperHour () const

double	constantTermCoefficient () const

bool	isConstantTermCoefficientDefaulted () const

double	temperatureTermCoefficient () const

bool	isTemperatureTermCoefficientDefaulted () const

double	velocityTermCoefficient () const

bool	isVelocityTermCoefficientDefaulted () const

double	velocitySquaredTermCoefficient () const

bool	isVelocitySquaredTermCoefficientDefaulted () const

Setters
bool	setSchedule (Schedule &schedule)
	Sets the (fractional) Schedule. More...

void	resetSchedule ()
	Resets the (fractional) Schedule. More...

bool	setDesignFlowRate (double designFlowRate)

bool	setFlowperSpaceFloorArea (double flowperSpaceFloorArea)

bool	setFlowperExteriorSurfaceArea (double flowperExteriorSurfaceArea)

bool	setFlowperExteriorWallArea (double flowperExteriorWallArea)

bool	setAirChangesperHour (double airChangesperHour)

bool	setConstantTermCoefficient (double constantTermCoefficient)

void	resetConstantTermCoefficient ()

bool	setTemperatureTermCoefficient (double temperatureTermCoefficient)

void	resetTemperatureTermCoefficient ()

bool	setVelocityTermCoefficient (double velocityTermCoefficient)

void	resetVelocityTermCoefficient ()

bool	setVelocitySquaredTermCoefficient (double velocitySquaredTermCoefficient)

void	resetVelocitySquaredTermCoefficient ()

Other
double	getDesignFlowRate (double floorArea, double exteriorSurfaceArea, double exteriorWallArea, double airVolume) const
	Returns the design flow rate (m^3/s) based on the floorArea (m^2), exteriorSurfaceArea (m^2), exteriorWallArea (m^2), and airVolume (m^3). More...

double	getFlowPerSpaceFloorArea (double floorArea, double exteriorSurfaceArea, double exteriorWallArea, double airVolume) const
	Returns the design flow per space floor area (m^3/m^2*s) based on the floorArea (m^2), exteriorSurfaceArea (m^2), exteriorWallArea (m^2), and airVolume (m^3). More...

double	getFlowPerExteriorSurfaceArea (double floorArea, double exteriorSurfaceArea, double exteriorWallArea, double airVolume) const
	Returns the design flow per exterior surface area (m^3/m^2*s) based on the floorArea (m^2), exteriorSurfaceArea (m^2), exteriorWallArea (m^2), and airVolume (m^3). More...

double	getFlowPerExteriorWallArea (double floorArea, double exteriorSurfaceArea, double exteriorWallArea, double airVolume) const
	Returns the design flow per exterior wall area (m^3/m^2*s) based on the floorArea (m^2), exteriorSurfaceArea (m^2), exteriorWallArea (m^2), and airVolume (m^3). More...

double	getAirChangesPerHour (double floorArea, double exteriorSurfaceArea, double exteriorWallArea, double airVolume) const
	Returns the design air changes per hour (1/h) based on the floorArea (m^2), exteriorSurfaceArea (m^2), exteriorWallArea (m^2), and airVolume (m^3). More...

Public Member Functions inherited from openstudio::model::SpaceLoad
bool	hardApplySchedules ()
	Directly applies default schedules to this space load if found. More...

bool	hardSize ()
	Converts space load levels to absolute values rather than by per area, etc. More...

bool	isAbsolute () const
	Returns true if the load represents an absolute quantity that must be added when combining space types. More...

void	resetSpaceType ()

bool	setSpaceType (const SpaceType &spaceType)
	Sets the parent SpaceType. More...

boost::optional< SpaceType >	spaceType () const
	Returns the parent SpaceType. More...

virtual	~SpaceLoad ()

Public Member Functions inherited from openstudio::model::SpaceItem
void	resetSpace ()

bool	setSpace (const Space &space)
	Sets the parent Space. More...

boost::optional< Space >	space () const
	Returns the parent Space. More...

virtual	~SpaceItem ()

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...

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 (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 Methods
static IddObjectType	iddObjectType ()

static std::vector< std::string >	validDesignFlowRateCalculationMethodValues ()

static std::vector< std::string >	designFlowRateCalculationMethodValues ()

Related Functions
(Note that these are not member functions.)
typedef boost::optional < SpaceInfiltrationDesignFlowRate >	OptionalSpaceInfiltrationDesignFlowRate

typedef std::vector < SpaceInfiltrationDesignFlowRate >	SpaceInfiltrationDesignFlowRateVector

Related Functions inherited from openstudio::model::SpaceLoad
typedef boost::optional < SpaceLoad >	OptionalSpaceLoad

typedef std::vector< SpaceLoad >	SpaceLoadVector

Related Functions inherited from openstudio::model::SpaceItem
typedef boost::optional < SpaceItem >	OptionalSpaceItem

typedef std::vector< SpaceItem >	SpaceItemVector

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::ModelObject
typedef detail::ModelObject_Impl	ImplType

Protected Member Functions inherited from openstudio::model::SpaceLoad
	SpaceLoad (IddObjectType type, const Model &model)
	Constructs a new SpaceLoad object in the model. More...

Protected Member Functions inherited from openstudio::model::SpaceItem
	SpaceItem (IddObjectType type, const Model &model)
	Constructs a new SpaceItem 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

SpaceInfiltrationDesignFlowRate is a SpaceLoad that wraps the OpenStudio IDD object 'OS:SpaceInfiltration:DesignFlowRate'.

Constructor & Destructor Documentation

openstudio::model::SpaceInfiltrationDesignFlowRate::SpaceInfiltrationDesignFlowRate ( const Model & model )

explicit

virtual openstudio::model::SpaceInfiltrationDesignFlowRate::~SpaceInfiltrationDesignFlowRate ( )

inlinevirtual

Member Function Documentation

boost::optional<double> openstudio::model::SpaceInfiltrationDesignFlowRate::airChangesperHour ( ) const

double openstudio::model::SpaceInfiltrationDesignFlowRate::constantTermCoefficient ( ) const

boost::optional<double> openstudio::model::SpaceInfiltrationDesignFlowRate::designFlowRate ( ) const

std::string openstudio::model::SpaceInfiltrationDesignFlowRate::designFlowRateCalculationMethod ( ) const

static std::vector<std::string> openstudio::model::SpaceInfiltrationDesignFlowRate::designFlowRateCalculationMethodValues ( )

static

Deprecated:

boost::optional<double> openstudio::model::SpaceInfiltrationDesignFlowRate::flowperExteriorSurfaceArea ( ) const

boost::optional<double> openstudio::model::SpaceInfiltrationDesignFlowRate::flowperExteriorWallArea ( ) const

boost::optional<double> openstudio::model::SpaceInfiltrationDesignFlowRate::flowperSpaceFloorArea ( ) const

double openstudio::model::SpaceInfiltrationDesignFlowRate::getAirChangesPerHour	(	double	floorArea,
		double	exteriorSurfaceArea,
		double	exteriorWallArea,
		double	airVolume
	)		const

Returns the design air changes per hour (1/h) based on the floorArea (m^2), exteriorSurfaceArea (m^2), exteriorWallArea (m^2), and airVolume (m^3).

double openstudio::model::SpaceInfiltrationDesignFlowRate::getDesignFlowRate	(	double	floorArea,
		double	exteriorSurfaceArea,
		double	exteriorWallArea,
		double	airVolume
	)		const

Returns the design flow rate (m^3/s) based on the floorArea (m^2), exteriorSurfaceArea (m^2), exteriorWallArea (m^2), and airVolume (m^3).

double openstudio::model::SpaceInfiltrationDesignFlowRate::getFlowPerExteriorSurfaceArea	(	double	floorArea,
		double	exteriorSurfaceArea,
		double	exteriorWallArea,
		double	airVolume
	)		const

Returns the design flow per exterior surface area (m^3/m^2*s) based on the floorArea (m^2), exteriorSurfaceArea (m^2), exteriorWallArea (m^2), and airVolume (m^3).

double openstudio::model::SpaceInfiltrationDesignFlowRate::getFlowPerExteriorWallArea	(	double	floorArea,
		double	exteriorSurfaceArea,
		double	exteriorWallArea,
		double	airVolume
	)		const

Returns the design flow per exterior wall area (m^3/m^2*s) based on the floorArea (m^2), exteriorSurfaceArea (m^2), exteriorWallArea (m^2), and airVolume (m^3).

double openstudio::model::SpaceInfiltrationDesignFlowRate::getFlowPerSpaceFloorArea	(	double	floorArea,
		double	exteriorSurfaceArea,
		double	exteriorWallArea,
		double	airVolume
	)		const

Returns the design flow per space floor area (m^3/m^2*s) based on the floorArea (m^2), exteriorSurfaceArea (m^2), exteriorWallArea (m^2), and airVolume (m^3).

static IddObjectType openstudio::model::SpaceInfiltrationDesignFlowRate::iddObjectType ( )

static

bool openstudio::model::SpaceInfiltrationDesignFlowRate::isConstantTermCoefficientDefaulted ( ) const

bool openstudio::model::SpaceInfiltrationDesignFlowRate::isScheduleDefaulted ( ) const

Returns true if this object does not specify a schedule directly.

bool openstudio::model::SpaceInfiltrationDesignFlowRate::isTemperatureTermCoefficientDefaulted ( ) const

bool openstudio::model::SpaceInfiltrationDesignFlowRate::isVelocitySquaredTermCoefficientDefaulted ( ) const

bool openstudio::model::SpaceInfiltrationDesignFlowRate::isVelocityTermCoefficientDefaulted ( ) const

void openstudio::model::SpaceInfiltrationDesignFlowRate::resetConstantTermCoefficient ( )

void openstudio::model::SpaceInfiltrationDesignFlowRate::resetSchedule ( )

Resets the (fractional) Schedule.

void openstudio::model::SpaceInfiltrationDesignFlowRate::resetTemperatureTermCoefficient ( )

void openstudio::model::SpaceInfiltrationDesignFlowRate::resetVelocitySquaredTermCoefficient ( )

void openstudio::model::SpaceInfiltrationDesignFlowRate::resetVelocityTermCoefficient ( )

boost::optional<Schedule> openstudio::model::SpaceInfiltrationDesignFlowRate::schedule ( ) const

Returns the (fractional) infiltration schedule.

If this object does not specify a schedule this function will search the hierarchy.

bool openstudio::model::SpaceInfiltrationDesignFlowRate::setAirChangesperHour ( double airChangesperHour )

bool openstudio::model::SpaceInfiltrationDesignFlowRate::setConstantTermCoefficient ( double constantTermCoefficient )

bool openstudio::model::SpaceInfiltrationDesignFlowRate::setDesignFlowRate ( double designFlowRate )

bool openstudio::model::SpaceInfiltrationDesignFlowRate::setFlowperExteriorSurfaceArea ( double flowperExteriorSurfaceArea )

bool openstudio::model::SpaceInfiltrationDesignFlowRate::setFlowperExteriorWallArea ( double flowperExteriorWallArea )

bool openstudio::model::SpaceInfiltrationDesignFlowRate::setFlowperSpaceFloorArea ( double flowperSpaceFloorArea )

bool openstudio::model::SpaceInfiltrationDesignFlowRate::setSchedule ( Schedule & schedule )

Sets the (fractional) Schedule.

bool openstudio::model::SpaceInfiltrationDesignFlowRate::setTemperatureTermCoefficient ( double temperatureTermCoefficient )

bool openstudio::model::SpaceInfiltrationDesignFlowRate::setVelocitySquaredTermCoefficient ( double velocitySquaredTermCoefficient )

bool openstudio::model::SpaceInfiltrationDesignFlowRate::setVelocityTermCoefficient ( double velocityTermCoefficient )

double openstudio::model::SpaceInfiltrationDesignFlowRate::temperatureTermCoefficient ( ) const

static std::vector<std::string> openstudio::model::SpaceInfiltrationDesignFlowRate::validDesignFlowRateCalculationMethodValues ( )

static

double openstudio::model::SpaceInfiltrationDesignFlowRate::velocitySquaredTermCoefficient ( ) const

double openstudio::model::SpaceInfiltrationDesignFlowRate::velocityTermCoefficient ( ) const

Friends And Related Function Documentation

typedef boost::optional<SpaceInfiltrationDesignFlowRate> OptionalSpaceInfiltrationDesignFlowRate

Public Member Functions

Static Public Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation