InsideSurfaceConvectionAlgorithm Class Reference

#include "InsideSurfaceConvectionAlgorithm.hpp"

Inheritance diagram for openstudio::model::InsideSurfaceConvectionAlgorithm:

Public Member Functions
	InsideSurfaceConvectionAlgorithm (const InsideSurfaceConvectionAlgorithm &other)=default
	InsideSurfaceConvectionAlgorithm (InsideSurfaceConvectionAlgorithm &&other)=default
InsideSurfaceConvectionAlgorithm &	operator= (const InsideSurfaceConvectionAlgorithm &)=default
InsideSurfaceConvectionAlgorithm &	operator= (InsideSurfaceConvectionAlgorithm &&)=default
virtual	~InsideSurfaceConvectionAlgorithm ()=default
std::string	algorithm () const
bool	isAlgorithmDefaulted () const
bool	setAlgorithm (const std::string &algorithm)
void	resetAlgorithm ()

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

Protected Member Functions
	InsideSurfaceConvectionAlgorithm (const Model &model)

Related Functions
using	OptionalInsideSurfaceConvectionAlgorithm = boost::optional< InsideSurfaceConvectionAlgorithm >

Detailed Description

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

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

Constructor & Destructor Documentation

virtual openstudio::model::InsideSurfaceConvectionAlgorithm::~InsideSurfaceConvectionAlgorithm ( )

virtualdefault

openstudio::model::InsideSurfaceConvectionAlgorithm::InsideSurfaceConvectionAlgorithm ( const InsideSurfaceConvectionAlgorithm &  other )

default

openstudio::model::InsideSurfaceConvectionAlgorithm::InsideSurfaceConvectionAlgorithm ( InsideSurfaceConvectionAlgorithm &&  other )

default

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

explicitprotected

Constructs a new InsideSurfaceConvectionAlgorithm object in the model.

Member Function Documentation

std::string openstudio::model::InsideSurfaceConvectionAlgorithm::algorithm

(

)

const

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

static

bool openstudio::model::InsideSurfaceConvectionAlgorithm::isAlgorithmDefaulted

(

)

const

InsideSurfaceConvectionAlgorithm& openstudio::model::InsideSurfaceConvectionAlgorithm::operator= ( const InsideSurfaceConvectionAlgorithm &  )

default

InsideSurfaceConvectionAlgorithm& openstudio::model::InsideSurfaceConvectionAlgorithm::operator= ( InsideSurfaceConvectionAlgorithm &&  )

default

void openstudio::model::InsideSurfaceConvectionAlgorithm::resetAlgorithm

(

)

bool openstudio::model::InsideSurfaceConvectionAlgorithm::setAlgorithm

(

const std::string &

algorithm

)

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

static

Friends And Related Function Documentation

using OptionalInsideSurfaceConvectionAlgorithm = boost::optional<InsideSurfaceConvectionAlgorithm>

related