OutsideSurfaceConvectionAlgorithm Class Reference

#include "OutsideSurfaceConvectionAlgorithm.hpp"

Inheritance diagram for openstudio::model::OutsideSurfaceConvectionAlgorithm:

Public Member Functions
virtual	~OutsideSurfaceConvectionAlgorithm ()
std::string	algorithm () const
bool	isAlgorithmDefaulted () const
bool	setAlgorithm (std::string algorithm)
void	resetAlgorithm ()

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

Protected Member Functions
	OutsideSurfaceConvectionAlgorithm (const Model &model)

Related Functions
typedef boost::optional < OutsideSurfaceConvectionAlgorithm >	OptionalOutsideSurfaceConvectionAlgorithm

Detailed Description

OutsideSurfaceConvectionAlgorithm derives from ModelObject and is an interface to the OpenStudio IDD object named "SurfaceConvectionAlgorithm:Outside".

OutsideSurfaceConvectionAlgorithm is a unique object that specifies the global model used for surface convection at the outside face of all the heat transfer surfaces in the model. This global algorithm may be overridden for specific Surface, SurfaceList, or Zone objects. OutsideSurfaceConvectionAlgorithm does not have a public constructor because it is a unique ModelObject. To get the OutsideSurfaceConvectionAlgorithm object for a Model or create one if it does not yet exist use model.getUniqueObject<OutsideSurfaceConvectionAlgorithm>(). To get the OutsideSurfaceConvectionAlgorithm object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<OutsideSurfaceConvectionAlgorithm>().

Constructor & Destructor Documentation

virtual openstudio::model::OutsideSurfaceConvectionAlgorithm::~OutsideSurfaceConvectionAlgorithm ( )

inlinevirtual

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

explicitprotected

Constructs a new OutsideSurfaceConvectionAlgorithm object in the model.

Member Function Documentation

std::string openstudio::model::OutsideSurfaceConvectionAlgorithm::algorithm

(

)

const

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

static

bool openstudio::model::OutsideSurfaceConvectionAlgorithm::isAlgorithmDefaulted

(

)

const

void openstudio::model::OutsideSurfaceConvectionAlgorithm::resetAlgorithm

(

)

bool openstudio::model::OutsideSurfaceConvectionAlgorithm::setAlgorithm

(

std::string

algorithm

)

static std::vector<std::string> openstudio::model::OutsideSurfaceConvectionAlgorithm::validAlgorithmValues ( )

static

Friends And Related Function Documentation

typedef boost::optional<OutsideSurfaceConvectionAlgorithm> OptionalOutsideSurfaceConvectionAlgorithm

related