HeatBalanceAlgorithm Class Reference

#include "HeatBalanceAlgorithm.hpp"

Inheritance diagram for openstudio::model::HeatBalanceAlgorithm:

Public Member Functions
std::string	algorithm () const
bool	isAlgorithmDefaulted () const
double	surfaceTemperatureUpperLimit () const
Quantity	getSurfaceTemperatureUpperLimit (bool returnIP=false) const
bool	isSurfaceTemperatureUpperLimitDefaulted () const
double	minimumSurfaceConvectionHeatTransferCoefficientValue () const
Quantity	getMinimumSurfaceConvectionHeatTransferCoefficientValue (bool returnIP=false) const
bool	isMinimumSurfaceConvectionHeatTransferCoefficientValueDefaulted () const
double	maximumSurfaceConvectionHeatTransferCoefficientValue () const
Quantity	getMaximumSurfaceConvectionHeatTransferCoefficientValue (bool returnIP=false) const
bool	isMaximumSurfaceConvectionHeatTransferCoefficientValueDefaulted () const
bool	setAlgorithm (std::string algorithm)
void	resetAlgorithm ()
bool	setSurfaceTemperatureUpperLimit (double surfaceTemperatureUpperLimit)
bool	setSurfaceTemperatureUpperLimit (const Quantity &surfaceTemperatureUpperLimit)
void	resetSurfaceTemperatureUpperLimit ()
bool	setMinimumSurfaceConvectionHeatTransferCoefficientValue (double minimumSurfaceConvectionHeatTransferCoefficientValue)
bool	setMinimumSurfaceConvectionHeatTransferCoefficientValue (const Quantity &minimumSurfaceConvectionHeatTransferCoefficientValue)
void	resetMinimumSurfaceConvectionHeatTransferCoefficientValue ()
bool	setMaximumSurfaceConvectionHeatTransferCoefficientValue (double maximumSurfaceConvectionHeatTransferCoefficientValue)
bool	setMaximumSurfaceConvectionHeatTransferCoefficientValue (const Quantity &maximumSurfaceConvectionHeatTransferCoefficientValue)
void	resetMaximumSurfaceConvectionHeatTransferCoefficientValue ()

Static Public Member Functions
static IddObjectType	iddObjectType ()
static std::vector< std::string >	algorithmValues ()

Related Functions
typedef std::vector < HeatBalanceAlgorithm >	HeatBalanceAlgorithmVector
typedef boost::optional < HeatBalanceAlgorithm >	OptionalHeatBalanceAlgorithm

Constructors and Destructors
virtual	~HeatBalanceAlgorithm ()
	HeatBalanceAlgorithm (const Model &model)

Detailed Description

HeatBalanceAlgorithm derives from ModelObject and is an interface to the OpenStudio IDD object named "HeatBalanceAlgorithm".

HeatBalanceAlgorithm is a unique object that specifies the global heat and moisture algorithms used across building construction calculations. HeatBalanceAlgorithm does not have a public constructor because it is a unique ModelObject. To get the HeatBalanceAlgorithm object for a Model or create one if it does not yet exist use model.getUniqueObject<HeatBalanceAlgorithm>(). To get the HeatBalanceAlgorithm object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<HeatBalanceAlgorithm>().

Constructor & Destructor Documentation

virtual openstudio::model::HeatBalanceAlgorithm::~HeatBalanceAlgorithm ( )

inlinevirtual

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

explicitprotected

Constructs a new HeatBalanceAlgorithm object in the model.

Member Function Documentation

std::string openstudio::model::HeatBalanceAlgorithm::algorithm

(

)

const

static std::vector<std::string> openstudio::model::HeatBalanceAlgorithm::algorithmValues ( )

static

Quantity openstudio::model::HeatBalanceAlgorithm::getMaximumSurfaceConvectionHeatTransferCoefficientValue

(

bool

returnIP = false

)

const

Quantity openstudio::model::HeatBalanceAlgorithm::getMinimumSurfaceConvectionHeatTransferCoefficientValue

(

bool

returnIP = false

)

const

Quantity openstudio::model::HeatBalanceAlgorithm::getSurfaceTemperatureUpperLimit

(

bool

returnIP = false

)

const

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

static

bool openstudio::model::HeatBalanceAlgorithm::isAlgorithmDefaulted

(

)

const

bool openstudio::model::HeatBalanceAlgorithm::isMaximumSurfaceConvectionHeatTransferCoefficientValueDefaulted

(

)

const

bool openstudio::model::HeatBalanceAlgorithm::isMinimumSurfaceConvectionHeatTransferCoefficientValueDefaulted

(

)

const

bool openstudio::model::HeatBalanceAlgorithm::isSurfaceTemperatureUpperLimitDefaulted

(

)

const

double openstudio::model::HeatBalanceAlgorithm::maximumSurfaceConvectionHeatTransferCoefficientValue

(

)

const

double openstudio::model::HeatBalanceAlgorithm::minimumSurfaceConvectionHeatTransferCoefficientValue

(

)

const

void openstudio::model::HeatBalanceAlgorithm::resetAlgorithm

(

)

void openstudio::model::HeatBalanceAlgorithm::resetMaximumSurfaceConvectionHeatTransferCoefficientValue

(

)

void openstudio::model::HeatBalanceAlgorithm::resetMinimumSurfaceConvectionHeatTransferCoefficientValue

(

)

void openstudio::model::HeatBalanceAlgorithm::resetSurfaceTemperatureUpperLimit

(

)

bool openstudio::model::HeatBalanceAlgorithm::setAlgorithm

(

std::string

algorithm

)

bool openstudio::model::HeatBalanceAlgorithm::setMaximumSurfaceConvectionHeatTransferCoefficientValue

(

double

maximumSurfaceConvectionHeatTransferCoefficientValue

)

bool openstudio::model::HeatBalanceAlgorithm::setMaximumSurfaceConvectionHeatTransferCoefficientValue

(

const Quantity &

maximumSurfaceConvectionHeatTransferCoefficientValue

)

bool openstudio::model::HeatBalanceAlgorithm::setMinimumSurfaceConvectionHeatTransferCoefficientValue

(

double

minimumSurfaceConvectionHeatTransferCoefficientValue

)

bool openstudio::model::HeatBalanceAlgorithm::setMinimumSurfaceConvectionHeatTransferCoefficientValue

(

const Quantity &

minimumSurfaceConvectionHeatTransferCoefficientValue

)

bool openstudio::model::HeatBalanceAlgorithm::setSurfaceTemperatureUpperLimit

(

double

surfaceTemperatureUpperLimit

)

bool openstudio::model::HeatBalanceAlgorithm::setSurfaceTemperatureUpperLimit

(

const Quantity &

surfaceTemperatureUpperLimit

)

double openstudio::model::HeatBalanceAlgorithm::surfaceTemperatureUpperLimit

(

)

const

Friends And Related Function Documentation

typedef std::vector<HeatBalanceAlgorithm> HeatBalanceAlgorithmVector

related

typedef boost::optional<HeatBalanceAlgorithm> OptionalHeatBalanceAlgorithm

related