#include <GasMixture.hpp>

Inheritance diagram for openstudio::model::GasMixture:

Public Member Functions
Constructors and Destructors
	GasMixture (const Model &model, int numberofGasesinMixture=4, double thickness=0.003, std::string gas1Type="Air", double gas1Fraction=.97, std::string gas2Type="Argon", double gas2Fraction=0.01, std::string gas3Type="Krypton", double gas3Fraction=0.01, std::string gas4Type="Xenon", double gas4Fraction=0.01)

virtual	~GasMixture () override=default

	GasMixture (const GasMixture &other)=default

	GasMixture (GasMixture &&other)=default

GasMixture &	operator= (const GasMixture &)=default

GasMixture &	operator= (GasMixture &&)=default

Getters
std::string	getGasType (unsigned index) const
	Get the type of gas at index, where index starts at 0.

double	getGasFraction (unsigned index) const
	Get the mixture fraction of the gas at index, where index starts at 0.

double	getThermalConductivity (double temperature) const
	The conductivity (W/m*K) at temperature (K).

double	getThermalConductance (double temperature) const
	The conductance (W/m^2*K) at temperature (K).

double	getThermalResistivity (double temperature) const
	The resistivity (m*K/W) at temperature (K).

double	getThermalResistance (double temperature) const
	The resistance (m^2*K/W) at temperature (K).

double	getViscosity (double temperature) const
	The viscosity (kg/m*s) of the mixture at temperature (K).

double	getSpecificHeat (double temperature) const
	The specific heat (J/kg*K) of the mixture at temperature (K).

double	thickness () const

int	numberofGasesinMixture () const

std::string	gas1Type () const

double	gas1Fraction () const

std::string	gas2Type () const

double	gas2Fraction () const

std::string	gas3Type () const

boost::optional< double >	gas3Fraction () const

std::string	gas4Type () const

boost::optional< double >	gas4Fraction () const

Setters
bool	setGas (unsigned index, const std::string &type, double fraction)
	Set the gas at index, if index <= numGases and index < 4.

bool	setGasType (unsigned index, const std::string &type)
	Set the type of gas at index, if index < numGases.

bool	setGasFraction (unsigned index, double fraction)
	Set the fraction of gas at index, if index < numGases.

bool	addGas (const std::string &type, double fraction)
	Append gas if numGases < 4.

bool	setFractions (const std::vector< double > &fractions)
	Set the gas fractions.

bool	balanceFractions (unsigned index)
	Assign gas fraction at index to 1.0 - sum(other gas fractions), if index < numGases.

bool	setThickness (double thickness)

bool	setNumberofGasesinMixture (int numberofGasesinMixture)

bool	setGas1Type (const std::string &gas1Type)

void	resetGas1Type ()

bool	setGas1Fraction (double gas1Fraction)

void	resetGas1Fraction ()

bool	setGas2Type (const std::string &gas2Type)

void	resetGas2Type ()

bool	setGas2Fraction (double gas2Fraction)

void	resetGas2Fraction ()

bool	setGas3Type (const std::string &gas3Type)

void	resetGas3Type ()

bool	setGas3Fraction (double gas3Fraction)

void	resetGas3Fraction ()

bool	setGas4Type (const std::string &gas4Type)

void	resetGas4Type ()

bool	setGas4Fraction (double gas4Fraction)

void	resetGas4Fraction ()

Queries
unsigned	numGases () const

Public Member Functions inherited from openstudio::model::GasLayer
virtual	~GasLayer () override=default

	GasLayer (const GasLayer &other)=default

	GasLayer (GasLayer &&other)=default

GasLayer &	operator= (const GasLayer &)=default

GasLayer &	operator= (GasLayer &&)=default

Public Member Functions inherited from openstudio::model::FenestrationMaterial
virtual	~FenestrationMaterial () override=default

	FenestrationMaterial (const FenestrationMaterial &other)=default

	FenestrationMaterial (FenestrationMaterial &&other)=default

FenestrationMaterial &	operator= (const FenestrationMaterial &)=default

FenestrationMaterial &	operator= (FenestrationMaterial &&)=default

Public Member Functions inherited from openstudio::model::Material
virtual	~Material () override=default

	Material (const Material &other)=default

	Material (Material &&other)=default

Material &	operator= (const Material &)=default

Material &	operator= (Material &&)=default

double	thickness () const

boost::optional< double >	getVisibleTransmittance () const

boost::optional< double >	interiorVisibleAbsorptance () const

boost::optional< double >	exteriorVisibleAbsorptance () const

StandardsInformationMaterial	standardsInformation () const
	Returns this materials's standards information, constructing a new object if necessary.

bool	setThickness (double value)

Public Member Functions inherited from openstudio::model::ResourceObject
unsigned	directUseCount (bool excludeChildren=false) const
	Returns the number of objects that use this resource directly.

unsigned	nonResourceObjectUseCount (bool excludeChildren=false) const
	Returns the number of non-ResourceObjects that use this resource either directly or indirectly.

ResourceObject &	operator= (const ResourceObject &)=default

ResourceObject &	operator= (ResourceObject &&)=default

	ResourceObject (const ResourceObject &other)=default

	ResourceObject (ResourceObject &&other)=default

virtual	~ResourceObject () override=default

Public Member Functions inherited from openstudio::model::ParentObject
ParentObject &	operator= (const ParentObject &)=default

ParentObject &	operator= (ParentObject &&)=default

	ParentObject (const ParentObject &other)=default

	ParentObject (ParentObject &&other)=default

virtual	~ParentObject () override=default

std::vector< ModelObject >	children () const
	Return direct child objects in the Model.

std::vector< IddObjectType >	allowableChildTypes () const
	Returns a vector of allowable children types.

Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject () override=default

	ModelObject (const ModelObject &other)=default

	ModelObject (ModelObject &&other)=default

ModelObject &	operator= (const ModelObject &)=default

ModelObject &	operator= (ModelObject &&)=default

ModelObject	clone () const
	Creates a deep copy of this object, placing it in this object's model().

ModelObject	clone (Model model) const
	Creates a deep copy of this object, placing it in model.

Component	createComponent () const
	Method for creating sharable Model snippets.

Model	model () const
	Returns the Model that contains this object.

boost::optional< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one.

std::vector< ResourceObject >	resources () const
	Get the resources directly used by this ModelObject.

template<typename T >
std::vector< T >	getModelObjectSources () const
	Get all objects of type T that point to this object.

template<typename T >
std::vector< T >	getModelObjectSources (IddObjectType iddObjectType) const
	Get all objects of type T that point to this object.

template<typename T >
boost::optional< T >	getModelObjectTarget (unsigned index) const
	Get the object of type T pointed to by this object from field index.

template<typename T >
std::vector< T >	getModelObjectTargets () const
	Get all objects of type T to which this object points.

const std::vector< std::string > &	outputVariableNames () const
	Get all output variables names that could be associated with this object.

std::vector< OutputVariable >	outputVariables () const
	Get all output variables associated with this object, must run simulation to generate data.

boost::optional< openstudio::TimeSeries >	getData (const OutputVariable &variable, const std::string &envPeriod) const
	Get data associated with this output variable and this object.

std::vector< LifeCycleCost >	lifeCycleCosts () const
	Returns the list of all LifeCycleCosts that refer to this object.

std::vector< IdfObject >	removeLifeCycleCosts ()
	Removes all LifeCycleCosts that refer to this object.

IddObjectType	iddObjectType () const
	This is a virtual function that will tell you the type of iddObject you are dealing with.

AdditionalProperties	additionalProperties () const
	Returns this object's additional properties, constructing a new object if necessary.

bool	hasAdditionalProperties () const
	Returns true if this object has additional properties.

std::vector< IdfObject >	removeAdditionalProperties ()
	Removes all additional properties that refer to this object.

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

bool	operator< (const ModelObject &right) const

bool	operator== (const ModelObject &other) const
	equality test

bool	operator!= (const ModelObject &other) const
	inequality test

std::vector< ScheduleTypeKey >	getScheduleTypeKeys (const Schedule &schedule) const
	Return the ScheduleTypeKeys indicating how schedule is used in this object.

boost::optional< double >	getAutosizedValue (const std::string &valueName, const std::string &units) const
	Gets the autosized component value from the sql file.

virtual std::vector< EMSActuatorNames >	emsActuatorNames () const
	Return the names of the available ems actuators.

virtual std::vector< std::string >	emsInternalVariableNames () const
	Return the names of the available ems internal variables.

boost::optional< ModelObject >	connectedObject (unsigned port) const

boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Public Member Functions inherited from openstudio::WorkspaceObject
bool	canBeSource () const

bool	canBeSource () const

bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const

bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const

std::vector< std::string >	canBeTarget () const

std::vector< std::string >	canBeTarget () const

std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const

std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const

std::vector< WorkspaceObject >	getSources (IddObjectType type) const

std::vector< WorkspaceObject >	getSources (IddObjectType type) const

boost::optional< WorkspaceObject >	getTarget (unsigned index) const

boost::optional< WorkspaceObject >	getTarget (unsigned index) const

IdfObject	idfObject ()

IdfObject	idfObject () const

bool	initialized () const

bool	initialized () const

bool	isSource () const

bool	isSource () const

bool	isTarget () const

bool	isTarget () const

unsigned	numSources () const

unsigned	numSources () const

bool	objectListFieldsEqual (const WorkspaceObject &other) const

bool	objectListFieldsEqual (const WorkspaceObject &other) const

bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const

bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const

bool	operator< (const WorkspaceObject &right) const

bool	operator< (const WorkspaceObject &right) const

std::ostream &	operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)

WorkspaceObject &	operator= (const WorkspaceObject &)=default

WorkspaceObject &	operator= (const WorkspaceObject &)=default

WorkspaceObject &	operator= (WorkspaceObject &&)=default

WorkspaceObject &	operator= (WorkspaceObject &&)=default

std::vector< openstudio::IdfObject >	remove ()

std::vector< openstudio::IdfObject >	remove ()

bool	setPointer (unsigned index, const Handle &targetHandle)

bool	setPointer (unsigned index, const Handle &targetHandle)

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	targets () const

std::vector< WorkspaceObject >	targets () const

Workspace	workspace () const

Workspace	workspace () const

	WorkspaceObject (const WorkspaceObject &other)=default

	WorkspaceObject (const WorkspaceObject &other)=default

	WorkspaceObject (WorkspaceObject &&other)=default

	WorkspaceObject (WorkspaceObject &&other)=default

virtual	~WorkspaceObject () override=default

virtual	~WorkspaceObject () override=default

Public Member Functions inherited from openstudio::IdfObject
std::string	briefDescription () const

std::string	briefDescription () const

T	cast () const

std::vector< T >	castVector (const std::vector< U > &objects)

std::vector< std::vector< std::string > >	clearExtensibleGroups ()

std::vector< std::vector< std::string > >	clearExtensibleGroups ()

IdfObject	clone (bool keepHandle=false) const

IdfObject	clone (bool keepHandle=false) const

std::string	comment () const

std::string	comment () const

boost::optional< std::string >	createName (bool overwrite=true)

boost::optional< std::string >	createName (bool overwrite=true)

std::vector< unsigned >	dataFields () const

std::vector< unsigned >	dataFields () const

bool	dataFieldsEqual (const IdfObject &other) const

bool	dataFieldsEqual (const IdfObject &other) const

std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)

std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)

std::vector< IdfExtensibleGroup >	extensibleGroups () const

std::vector< IdfExtensibleGroup >	extensibleGroups () const

boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const

boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const

boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const

boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const

IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const

IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const

boost::optional< std::string >	getField (unsigned index, bool returnDefault=false) const

boost::optional< std::string >	getField (unsigned index, bool returnDefault=false) const

std::vector< Handle >	getHandles (const std::vector< T > &objects)

boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const

boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const

OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const

OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const

boost::optional< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const

boost::optional< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const

boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const

boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const

Handle	handle () const

Handle	handle () const

IddObject	iddObject () const

IddObject	iddObject () const

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (const IdfObject &other)

	IdfObject (const IdfObject &other)

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (IdfObject &&other) noexcept

	IdfObject (IdfObject &&other) noexcept

void	initializeFields (bool fill_default=false)

void	initializeFields (bool fill_default=false)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)

bool	isDataField (unsigned index) const

bool	isDataField (unsigned index) const

bool	isEmpty (unsigned index) const

bool	isEmpty (unsigned index) const

bool	isObjectListField (unsigned index) const

bool	isObjectListField (unsigned index) const

bool	isValid (StrictnessLevel level, bool checkNames=false) const

bool	isValid (StrictnessLevel level, bool checkNames=false) const

boost::optional< unsigned >	maxExtensibleGroups () const

boost::optional< unsigned >	maxExtensibleGroups () const

boost::optional< unsigned >	maxFields () const

boost::optional< unsigned >	maxFields () const

unsigned	minExtensibleGroups () const

unsigned	minExtensibleGroups () const

unsigned	minFields () const

unsigned	minFields () const

boost::optional< std::string >	name (bool returnDefault=false) const

boost::optional< std::string >	name (bool returnDefault=false) const

std::string	nameString (bool returnDefault=false) const

std::string	nameString (bool returnDefault=false) const

unsigned	numExtensibleGroups () const

unsigned	numExtensibleGroups () const

unsigned	numFields () const

unsigned	numFields () const

unsigned	numNonextensibleFields () const

unsigned	numNonextensibleFields () const

std::vector< unsigned >	objectListFields () const

std::vector< unsigned >	objectListFields () const

bool	objectListFieldsEqual (const IdfObject &other) const

bool	objectListFieldsEqual (const IdfObject &other) const

bool	objectListFieldsNonConflicting (const IdfObject &other) const

bool	objectListFieldsNonConflicting (const IdfObject &other) const

bool	operator!= (const IdfObject &other) const

bool	operator!= (const IdfObject &other) const

std::ostream &	operator<< (std::ostream &os, const IdfObject &IdfObject)

IdfObject &	operator= (const IdfObject &other)

IdfObject &	operator= (const IdfObject &other)

IdfObject &	operator= (IdfObject &&other) noexcept

IdfObject &	operator= (IdfObject &&other) noexcept

bool	operator== (const IdfObject &other) const

bool	operator== (const IdfObject &other) const

boost::optional< T >	optionalCast () const

std::vector< std::string >	popExtensibleGroup ()

std::vector< std::string >	popExtensibleGroup ()

std::ostream &	print (std::ostream &os) const

std::ostream &	printField (std::ostream &os, unsigned index, bool isLastField=false) const

std::ostream &	printName (std::ostream &os, bool hasFields=true) const

IdfExtensibleGroup	pushExtensibleGroup ()

IdfExtensibleGroup	pushExtensibleGroup ()

IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)

IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)

std::vector< unsigned >	requiredFields () const

std::vector< unsigned >	requiredFields () const

void	setComment (const std::string &msg)

void	setComment (const std::string &msg)

bool	setDouble (unsigned index, double value)

bool	setDouble (unsigned index, double value)

bool	setFieldComment (unsigned index, const std::string &cmnt)

bool	setFieldComment (unsigned index, const std::string &cmnt)

bool	setInt (unsigned index, int value)

bool	setInt (unsigned index, int value)

boost::optional< std::string >	setName (const std::string &newName)

boost::optional< std::string >	setName (const std::string &newName)

bool	setQuantity (unsigned index, const Quantity &q)

bool	setQuantity (unsigned index, const Quantity &q)

bool	setString (unsigned index, const std::string &value)

bool	setString (unsigned index, const std::string &value)

bool	setUnsigned (unsigned index, unsigned value)

bool	setUnsigned (unsigned index, unsigned value)

std::vector< T >	subsetCastVector (const std::vector< U > &original)

ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const

ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const

virtual	~IdfObject ()=default

virtual	~IdfObject ()=default

Static Public Member Functions
Static Methods
static std::vector< std::string >	validGasTypes ()

static IddObjectType	iddObjectType ()

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

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

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

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

Static Public Member Functions inherited from openstudio::model::FenestrationMaterial
static double	ufactorInsideAirTemperature ()
	Returns the inside air temperature used by EnergyPlus for calculating fenestration u-factors (K).

static double	ufactorOutsideAirTemperature ()
	Returns the outside air temperature used by EnergyPlus for calculating fenestration u-factors (K).

static const std::vector< double >	airThermalConductivityCoefficients ()
	Returns the conductivity coefficients for air.

static const std::vector< double >	airViscosityCoefficients ()
	Returns the viscosity coefficients for air.

static const std::vector< double >	airSpecificHeatCoefficients ()
	Returns the specific heat coefficients for air.

static double	airMolecularWeight ()
	The molecular weight of air (u).

static const std::vector< double >	argonThermalConductivityCoefficients ()
	Returns the conductivity coefficients for argon.

static const std::vector< double >	argonViscosityCoefficients ()
	Returns the viscosity coefficients for argon.

static const std::vector< double >	argonSpecificHeatCoefficients ()
	Returns the specific heat coefficients for argon.

static double	argonMolecularWeight ()
	The molecular weight of argon (u).

static const std::vector< double >	kryptonThermalConductivityCoefficients ()
	Returns the conductivity coefficients for krypton.

static const std::vector< double >	kryptonViscosityCoefficients ()
	Returns the viscosity coefficients for krypton.

static const std::vector< double >	kryptonSpecificHeatCoefficients ()
	Returns the specific heat coefficients for krypton.

static double	kryptonMolecularWeight ()
	The molecular weight of krypton (u).

static const std::vector< double >	xenonThermalConductivityCoefficients ()
	Returns the conductivity coefficients for xenon.

static const std::vector< double >	xenonViscosityCoefficients ()
	Returns the viscosity coefficients for xenon.

static const std::vector< double >	xenonSpecificHeatCoefficients ()
	Returns the specific heat coefficients for xenon.

static double	xenonMolecularWeight ()
	The molecular weight of xenon (u).

Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObject >	load (const std::string &text)

static boost::optional< IdfObject >	load (const std::string &text, const IddObject &iddObject)

static int	printedFieldSpace ()

Related Symbols
(Note that these are not member symbols.)
using	GasMixtureVector = std::vector<GasMixture>

using	OptionalGasMixture = boost::optional<GasMixture>

Related Symbols inherited from openstudio::model::FenestrationMaterial
using	FenestrationMaterialVector = std::vector<FenestrationMaterial>

using	OptionalFenestrationMaterial = boost::optional<FenestrationMaterial>

Related Symbols inherited from openstudio::model::Material
using	MaterialVector = std::vector<Material>

using	OptionalMaterial = boost::optional<Material>

Related Symbols inherited from openstudio::model::ResourceObject
using	OptionalResourceObject = boost::optional<ResourceObject>

using	ResourceObjectVector = std::vector<ResourceObject>

Related Symbols inherited from openstudio::model::ParentObject
std::vector< ModelObject >	getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true)
	Returns object and all other objects accessible by calling children() on encountered ParentObjects .

std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects .

Related Symbols inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object.

Additional Inherited Members
Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional< WorkspaceObject >	OptionalWorkspaceObject

typedef std::vector< WorkspaceObject >	WorkspaceObjectVector

Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObject >	IdfObjectPair

typedef std::vector< IdfObject >	IdfObjectVector

typedef boost::optional< IdfObject >	OptionalIdfObject

Protected Types inherited from openstudio::model::ModelObject
using	ImplType = detail::ModelObject_Impl

Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl	ImplType

Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl	ImplType

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

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

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)

Protected Member Functions inherited from openstudio::WorkspaceObject
	WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)

Protected Member Functions inherited from openstudio::IdfObject
	IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)

Detailed Description

GasMixture is a GasLayer that wraps the OpenStudio IDD object 'OS:WindowMaterial:GasMixture'.

Constructor & Destructor Documentation

◆ GasMixture() [1/3]

openstudio::model::GasMixture::GasMixture	(	const Model &	model,
		int	numberofGasesinMixture = 4,
		double	thickness = 0.003,
		std::string	gas1Type = "Air",
		double	gas1Fraction = .97,
		std::string	gas2Type = "Argon",
		double	gas2Fraction = 0.01,
		std::string	gas3Type = "Krypton",
		double	gas3Fraction = 0.01,
		std::string	gas4Type = "Xenon",
		double	gas4Fraction = 0.01 )

explicit

◆ ~GasMixture()

virtual openstudio::model::GasMixture::~GasMixture ( )

overridevirtualdefault

◆ GasMixture() [2/3]

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

default

◆ GasMixture() [3/3]

openstudio::model::GasMixture::GasMixture ( GasMixture && other )

default

Member Function Documentation

◆ addGas()

bool openstudio::model::GasMixture::addGas	(	const std::string &	type,
		double	fraction )

Append gas if numGases < 4.

See also: validGasTypes

◆ balanceFractions()

bool openstudio::model::GasMixture::balanceFractions ( unsigned index )

Assign gas fraction at index to 1.0 - sum(other gas fractions), if index < numGases.

◆ gas1Fraction()

double openstudio::model::GasMixture::gas1Fraction ( ) const

◆ gas1Type()

std::string openstudio::model::GasMixture::gas1Type ( ) const

◆ gas1TypeValues()

static std::vector< std::string > openstudio::model::GasMixture::gas1TypeValues ( )

static

◆ gas2Fraction()

double openstudio::model::GasMixture::gas2Fraction ( ) const

◆ gas2Type()

std::string openstudio::model::GasMixture::gas2Type ( ) const

◆ gas2TypeValues()

static std::vector< std::string > openstudio::model::GasMixture::gas2TypeValues ( )

static

◆ gas3Fraction()

boost::optional< double > openstudio::model::GasMixture::gas3Fraction ( ) const

◆ gas3Type()

std::string openstudio::model::GasMixture::gas3Type ( ) const

◆ gas3TypeValues()

static std::vector< std::string > openstudio::model::GasMixture::gas3TypeValues ( )

static

◆ gas4Fraction()

boost::optional< double > openstudio::model::GasMixture::gas4Fraction ( ) const

◆ gas4Type()

std::string openstudio::model::GasMixture::gas4Type ( ) const

◆ gas4TypeValues()

static std::vector< std::string > openstudio::model::GasMixture::gas4TypeValues ( )

static

◆ getGasFraction()

double openstudio::model::GasMixture::getGasFraction ( unsigned index ) const

Get the mixture fraction of the gas at index, where index starts at 0.

Throws if unavailable.

◆ getGasType()

std::string openstudio::model::GasMixture::getGasType ( unsigned index ) const

Get the type of gas at index, where index starts at 0.

Throws if unavailable.

◆ getSpecificHeat()

double openstudio::model::GasMixture::getSpecificHeat ( double temperature ) const

The specific heat (J/kg*K) of the mixture at temperature (K).

◆ getThermalConductance()

double openstudio::model::GasMixture::getThermalConductance ( double temperature ) const

The conductance (W/m^2*K) at temperature (K).

◆ getThermalConductivity()

double openstudio::model::GasMixture::getThermalConductivity ( double temperature ) const

The conductivity (W/m*K) at temperature (K).

◆ getThermalResistance()

double openstudio::model::GasMixture::getThermalResistance ( double temperature ) const

The resistance (m^2*K/W) at temperature (K).

◆ getThermalResistivity()

double openstudio::model::GasMixture::getThermalResistivity ( double temperature ) const

The resistivity (m*K/W) at temperature (K).

◆ getViscosity()

double openstudio::model::GasMixture::getViscosity ( double temperature ) const

The viscosity (kg/m*s) of the mixture at temperature (K).

◆ iddObjectType()

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

static

◆ numberofGasesinMixture()

int openstudio::model::GasMixture::numberofGasesinMixture ( ) const

◆ numGases()

unsigned openstudio::model::GasMixture::numGases ( ) const

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

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

default

◆ resetGas1Fraction()

void openstudio::model::GasMixture::resetGas1Fraction ( )

◆ resetGas1Type()

void openstudio::model::GasMixture::resetGas1Type ( )

◆ resetGas2Fraction()

void openstudio::model::GasMixture::resetGas2Fraction ( )

◆ resetGas2Type()

void openstudio::model::GasMixture::resetGas2Type ( )

◆ resetGas3Fraction()

void openstudio::model::GasMixture::resetGas3Fraction ( )

◆ resetGas3Type()

void openstudio::model::GasMixture::resetGas3Type ( )

◆ resetGas4Fraction()

void openstudio::model::GasMixture::resetGas4Fraction ( )

◆ resetGas4Type()

void openstudio::model::GasMixture::resetGas4Type ( )

◆ setFractions()

bool openstudio::model::GasMixture::setFractions ( const std::vector< double > & fractions )

Set the gas fractions.

Length of vector should be equal to numGases, and sum should be openstudio::equal(1.0). If all fractions except the last is < 1.0, will set last fraction value if necessary (and issue warning).

◆ setGas()

bool openstudio::model::GasMixture::setGas	(	unsigned	index,
		const std::string &	type,
		double	fraction )

Set the gas at index, if index <= numGases and index < 4.

See also: validGasTypes

◆ setGas1Fraction()

bool openstudio::model::GasMixture::setGas1Fraction ( double gas1Fraction )

◆ setGas1Type()

bool openstudio::model::GasMixture::setGas1Type ( const std::string & gas1Type )

◆ setGas2Fraction()

bool openstudio::model::GasMixture::setGas2Fraction ( double gas2Fraction )

◆ setGas2Type()

bool openstudio::model::GasMixture::setGas2Type ( const std::string & gas2Type )

◆ setGas3Fraction()

bool openstudio::model::GasMixture::setGas3Fraction ( double gas3Fraction )

◆ setGas3Type()

bool openstudio::model::GasMixture::setGas3Type ( const std::string & gas3Type )

◆ setGas4Fraction()

bool openstudio::model::GasMixture::setGas4Fraction ( double gas4Fraction )

◆ setGas4Type()

bool openstudio::model::GasMixture::setGas4Type ( const std::string & gas4Type )

◆ setGasFraction()

bool openstudio::model::GasMixture::setGasFraction	(	unsigned	index,
		double	fraction )

Set the fraction of gas at index, if index < numGases.

◆ setGasType()

bool openstudio::model::GasMixture::setGasType	(	unsigned	index,
		const std::string &	type )

Set the type of gas at index, if index < numGases.

See also: validGasTypes

◆ setNumberofGasesinMixture()

bool openstudio::model::GasMixture::setNumberofGasesinMixture ( int numberofGasesinMixture )

◆ setThickness()

bool openstudio::model::GasMixture::setThickness ( double thickness )

◆ thickness()

double openstudio::model::GasMixture::thickness ( ) const

◆ validGasTypes()

static std::vector< std::string > openstudio::model::GasMixture::validGasTypes ( )

static

Friends And Related Symbol Documentation

◆ GasMixtureVector

using GasMixtureVector = std::vector<GasMixture>

using OptionalGasMixture = boost::optional<GasMixture>

Public Member Functions

Static Public Member Functions

Related Symbols

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GasMixture() [1/3]

◆ ~GasMixture()

◆ GasMixture() [2/3]

◆ GasMixture() [3/3]

Member Function Documentation

◆ addGas()

◆ balanceFractions()

◆ gas1Fraction()

◆ gas1Type()

◆ gas1TypeValues()

◆ gas2Fraction()

◆ gas2Type()

◆ gas2TypeValues()

◆ gas3Fraction()

◆ gas3Type()

◆ gas3TypeValues()

◆ gas4Fraction()

◆ gas4Type()

◆ gas4TypeValues()

◆ getGasFraction()

◆ getGasType()

◆ getSpecificHeat()

◆ getThermalConductance()

◆ getThermalConductivity()

◆ getThermalResistance()

◆ getThermalResistivity()

◆ getViscosity()

◆ iddObjectType()

◆ numberofGasesinMixture()

◆ numGases()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ resetGas1Fraction()

◆ resetGas1Type()

◆ resetGas2Fraction()

◆ resetGas2Type()

◆ resetGas3Fraction()

◆ resetGas3Type()

◆ resetGas4Fraction()

◆ resetGas4Type()

◆ setFractions()

◆ setGas()

◆ setGas1Fraction()

◆ setGas1Type()

◆ setGas2Fraction()

◆ setGas2Type()

◆ setGas3Fraction()

◆ setGas3Type()

◆ setGas4Fraction()

◆ setGas4Type()

◆ setGasFraction()

◆ setGasType()

◆ setNumberofGasesinMixture()

◆ setThickness()

◆ thickness()

◆ validGasTypes()

Friends And Related Symbol Documentation

◆ GasMixtureVector

◆ OptionalGasMixture