openstudio::model::Gas Class Reference

#include <Gas.hpp>

Inheritance diagram for openstudio::model::Gas:

Public Member Functions
Constructors and Destructors
	Gas (const Model &model, std::string gasType="Air", double thickness=0.003)
virtual	~Gas ()=default
	Gas (const Gas &other)=default
	Gas (Gas &&other)=default
Gas &	operator= (const Gas &)=default
Gas &	operator= (Gas &&)=default
Getters
std::string	gasType () const
	Gets the gas type. More...
double	getThermalConductivity (double temperature) const
	The conductivity (W/m*K) at temperature (K). More...
double	getThermalConductance (double temperature) const
	The conductance (W/m^2*K) at temperature (K). More...
double	getThermalResistivity (double temperature) const
	The resistivity (m*K/W) at temperature (K). More...
double	getThermalResistance (double temperature) const
	The resistance (m^2*K/W) at temperature (K). More...
double	getViscosity (double temperature) const
	The viscosity (kg/m*s) at temperature (K). More...
double	getSpecificHeat (double temperature) const
	The specific heat (J/kg*K) at temperature (K). More...
boost::optional< double >	customConductivityCoefficientA () const
	The first conductivity coefficient of gasType "Custom" (W/m*K). More...
boost::optional< double >	customConductivityCoefficientB () const
	The second conductivity coefficient of gasType "Custom" (W/m*K^2). More...
boost::optional< double >	customConductivityCoefficientC () const
	The third conductivity coefficient of gasType "Custom" (W/m*K^3). More...
boost::optional< double >	customViscosityCoefficientA () const
	The first viscosity coefficient of gasType "Custom" (kg/m*s). More...
boost::optional< double >	customViscosityCoefficientB () const
	The second viscosity coefficient of gasType "Custom" (kg/m*s). More...
boost::optional< double >	customViscosityCoefficientC () const
	The third viscosity coefficient of gasType "Custom" (kg/m*s). More...
boost::optional< double >	customSpecificHeatCoefficientA () const
	The first specific heat coefficient of gasType "Custom" (J/kg*K). More...
boost::optional< double >	customSpecificHeatCoefficientB () const
	The second specific heat coefficient of gasType "Custom" (J/kg*K). More...
boost::optional< double >	customSpecificHeatCoefficientC () const
	The third specific heat coefficient of gasType "Custom" (J/kg*K). More...
boost::optional< double >	customMolecularWeight () const
	The molecular weight (u) of gasType "Custom". More...
boost::optional< double >	specificHeatRatio () const
double	thickness () const
boost::optional< double >	conductivityCoefficientA () const
boost::optional< double >	conductivityCoefficientB () const
boost::optional< double >	conductivityCoefficientC () const
boost::optional< double >	viscosityCoefficientA () const
boost::optional< double >	viscosityCoefficientB () const
boost::optional< double >	viscosityCoefficientC () const
boost::optional< double >	specificHeatCoefficientA () const
boost::optional< double >	specificHeatCoefficientB () const
boost::optional< double >	specificHeatCoefficientC () const
boost::optional< double >	molecularWeight () const
Setters
bool	setCustomConductivity (double A, double B, double C)
	If gasType() == "Custom", thermalConductivity (W/m*K) = A + B*temperature + C*temperature^2. More...
bool	setCustomViscosity (double A, double B, double C)
	If gasType() == "Custom", viscosity (g/m*s) = A + B*temperature + C*temperature^2. More...
bool	setCustomSpecificHeat (double A, double B, double C)
	If gasType() == "Custom", specific heat (J/kg*K) = A + B*temperature + C*temperature^2. More...
bool	setCustomMolecularWeight (double value)
	If gasType() == "Custom", specifies the molecular weight of the gas. More...
bool	setGasType (const std::string &gasType)
bool	setThickness (double thickness)
bool	setConductivityCoefficientA (double conductivityCoefficientA)
void	resetConductivityCoefficientA ()
bool	setConductivityCoefficientB (double conductivityCoefficientB)
void	resetConductivityCoefficientB ()
bool	setConductivityCoefficientC (double conductivityCoefficientC)
void	resetConductivityCoefficientC ()
bool	setViscosityCoefficientA (double viscosityCoefficientA)
void	resetViscosityCoefficientA ()
bool	setViscosityCoefficientB (double viscosityCoefficientB)
void	resetViscosityCoefficientB ()
bool	setViscosityCoefficientC (double viscosityCoefficientC)
void	resetViscosityCoefficientC ()
bool	setSpecificHeatCoefficientA (double specificHeatCoefficientA)
void	resetSpecificHeatCoefficientA ()
bool	setSpecificHeatCoefficientB (double specificHeatCoefficientB)
void	resetSpecificHeatCoefficientB ()
bool	setSpecificHeatCoefficientC (double specificHeatCoefficientC)
void	resetSpecificHeatCoefficientC ()
bool	setMolecularWeight (double molecularWeight)
void	resetMolecularWeight ()
bool	setSpecificHeatRatio (double specificHeatRatio)
void	resetSpecificHeatRatio ()
Public Member Functions inherited from openstudio::model::GasLayer
virtual	~GasLayer ()=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 ()=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 ()=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. More...
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. More...
unsigned	nonResourceObjectUseCount (bool excludeChildren=false) const
	Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...
ResourceObject &	operator= (const ResourceObject &)=default
ResourceObject &	operator= (ResourceObject &&)=default
	ResourceObject (const ResourceObject &other)=default
	ResourceObject (ResourceObject &&other)=default
virtual	~ResourceObject ()=default
Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType >	allowableChildTypes () const
	Returns a vector of allowable children types. More...
std::vector< ModelObject >	children () const
	Return direct child objects in the Model. More...
ParentObject &	operator= (const ParentObject &)=default
ParentObject &	operator= (ParentObject &&)=default
	ParentObject (const ParentObject &other)=default
	ParentObject (ParentObject &&other)=default
virtual	~ParentObject ()=default
Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject ()=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(). 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 (const std::string &valueName, const std::string &units) 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 std::vector< std::string >	validGasTypes ()
static IddObjectType	iddObjectType ()
static std::vector< std::string >	gasTypeValues ()
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). More...
static double	ufactorOutsideAirTemperature ()
	Returns the outside air temperature used by EnergyPlus for calculating fenestration u-factors (K). More...
static const std::vector< double >	airThermalConductivityCoefficients ()
	Returns the conductivity coefficients for air. More...
static const std::vector< double >	airViscosityCoefficients ()
	Returns the viscosity coefficients for air. More...
static const std::vector< double >	airSpecificHeatCoefficients ()
	Returns the specific heat coefficients for air. More...
static double	airMolecularWeight ()
	The molecular weight of air (u). More...
static const std::vector< double >	argonThermalConductivityCoefficients ()
	Returns the conductivity coefficients for argon. More...
static const std::vector< double >	argonViscosityCoefficients ()
	Returns the viscosity coefficients for argon. More...
static const std::vector< double >	argonSpecificHeatCoefficients ()
	Returns the specific heat coefficients for argon. More...
static double	argonMolecularWeight ()
	The molecular weight of argon (u). More...
static const std::vector< double >	kryptonThermalConductivityCoefficients ()
	Returns the conductivity coefficients for krypton. More...
static const std::vector< double >	kryptonViscosityCoefficients ()
	Returns the viscosity coefficients for krypton. More...
static const std::vector< double >	kryptonSpecificHeatCoefficients ()
	Returns the specific heat coefficients for krypton. More...
static double	kryptonMolecularWeight ()
	The molecular weight of krypton (u). More...
static const std::vector< double >	xenonThermalConductivityCoefficients ()
	Returns the conductivity coefficients for xenon. More...
static const std::vector< double >	xenonViscosityCoefficients ()
	Returns the viscosity coefficients for xenon. More...
static const std::vector< double >	xenonSpecificHeatCoefficients ()
	Returns the specific heat coefficients for xenon. More...
static double	xenonMolecularWeight ()
	The molecular weight of xenon (u). More...

Related Functions
(Note that these are not member functions.)
using	GasVector = std::vector< Gas >
using	OptionalGas = boost::optional< Gas >
Related Functions inherited from openstudio::model::FenestrationMaterial
using	FenestrationMaterialVector = std::vector< FenestrationMaterial >
using	OptionalFenestrationMaterial = boost::optional< FenestrationMaterial >
Related Functions inherited from openstudio::model::Material
using	MaterialVector = std::vector< Material >
using	OptionalMaterial = boost::optional< Material >
Related Functions inherited from openstudio::model::ResourceObject
using	OptionalResourceObject = boost::optional< ResourceObject >
using	ResourceObjectVector = std::vector< ResourceObject >
Related Functions 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 . More...
std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More...
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
using	ImplType = detail::ModelObject_Impl
Protected Member Functions inherited from openstudio::model::ResourceObject
	ResourceObject (IddObjectType type, const Model &model)
	Constructs a new PlanarSurface object in the model. More...
Protected Member Functions inherited from openstudio::model::ParentObject
	ParentObject (IddObjectType type, const Model &model)
	Constructs a new ParentObject 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

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

Constructor & Destructor Documentation

openstudio::model::Gas::Gas ( const Model &  model, std::string  gasType = "Air", double  thickness = 0.003  )

explicit

virtual openstudio::model::Gas::~Gas ( )

virtualdefault

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

default

openstudio::model::Gas::Gas ( Gas &&  other )

default

Member Function Documentation

boost::optional<double> openstudio::model::Gas::conductivityCoefficientA

(

)

const

boost::optional<double> openstudio::model::Gas::conductivityCoefficientB

(

)

const

boost::optional<double> openstudio::model::Gas::conductivityCoefficientC

(

)

const

boost::optional<double> openstudio::model::Gas::customConductivityCoefficientA

(

)

const

The first conductivity coefficient of gasType "Custom" (W/m*K).

The conductivity (W/m*K) = A (W/m*K) + B (W/m*K^2) * temperature (K) + C (W/m*K^3) * temperature (K^2).

boost::optional<double> openstudio::model::Gas::customConductivityCoefficientB

(

)

const

The second conductivity coefficient of gasType "Custom" (W/m*K^2).

The conductivity (W/m*K) = A (W/m*K) + B (W/m*K^2) * temperature (K) + C (W/m*K^3) * temperature (K^2).

boost::optional<double> openstudio::model::Gas::customConductivityCoefficientC

(

)

const

The third conductivity coefficient of gasType "Custom" (W/m*K^3).

The conductivity (W/m*K) = A (W/m*K) + B (W/m*K^2) * temperature (K) + C (W/m*K^3) * temperature (K^2).

boost::optional<double> openstudio::model::Gas::customMolecularWeight

(

)

const

The molecular weight (u) of gasType "Custom".

boost::optional<double> openstudio::model::Gas::customSpecificHeatCoefficientA

(

)

const

The first specific heat coefficient of gasType "Custom" (J/kg*K).

The specific heat (J/kg*K) = A (J/kg*K) + B (J/kg*K^2) * temperature (K) + C (J/kg*K^3) * temperature (K^2).

boost::optional<double> openstudio::model::Gas::customSpecificHeatCoefficientB

(

)

const

The second specific heat coefficient of gasType "Custom" (J/kg*K).

The specific heat (J/kg*K) = A (J/kg*K) + B (J/kg*K^2) * temperature (K) + C (J/kg*K^3) * temperature (K^2).

boost::optional<double> openstudio::model::Gas::customSpecificHeatCoefficientC

(

)

const

The third specific heat coefficient of gasType "Custom" (J/kg*K).

The specific heat (J/kg*K) = A (J/kg*K) + B (J/kg*K^2) * temperature (K) + C (J/kg*K^3) * temperature (K^2).

boost::optional<double> openstudio::model::Gas::customViscosityCoefficientA

(

)

const

The first viscosity coefficient of gasType "Custom" (kg/m*s).

The viscosity (kg/m*s) = A (kg/m*s) + B (kg/m*s*K) * temperature (K) + C (kg/m*s*K^2) * temperature (K^2).

boost::optional<double> openstudio::model::Gas::customViscosityCoefficientB

(

)

const

The second viscosity coefficient of gasType "Custom" (kg/m*s).

The viscosity (kg/m*s) = A (kg/m*s) + B (kg/m*s*K) * temperature (K) + C (kg/m*s*K^2) * temperature (K^2).

boost::optional<double> openstudio::model::Gas::customViscosityCoefficientC

(

)

const

The third viscosity coefficient of gasType "Custom" (kg/m*s).

The viscosity (kg/m*s) = A (kg/m*s) + B (kg/m*s*K) * temperature (K) + C (kg/m*s*K^2) * temperature (K^2).

std::string openstudio::model::Gas::gasType

(

)

const

Gets the gas type.

static std::vector<std::string> openstudio::model::Gas::gasTypeValues ( )

static

double openstudio::model::Gas::getSpecificHeat

(

double

temperature

)

const

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

Will throw if gasType == "Custom" and necessary values are not available.

double openstudio::model::Gas::getThermalConductance

(

double

temperature

)

const

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

Will throw if gasType == "Custom" and necessary values are not available.

double openstudio::model::Gas::getThermalConductivity

(

double

temperature

)

const

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

Will throw if gasType == "Custom" and necessary values are not available.

double openstudio::model::Gas::getThermalResistance

(

double

temperature

)

const

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

Will throw if gasType == "Custom" and necessary values are not available.

double openstudio::model::Gas::getThermalResistivity

(

double

temperature

)

const

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

Will throw if gasType == "Custom" and necessary values are not available.

double openstudio::model::Gas::getViscosity

(

double

temperature

)

const

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

Will throw if gasType == "Custom" and necessary values are not available.

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

static

boost::optional<double> openstudio::model::Gas::molecularWeight

(

)

const

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

default

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

default

void openstudio::model::Gas::resetConductivityCoefficientA

(

)

void openstudio::model::Gas::resetConductivityCoefficientB

(

)

void openstudio::model::Gas::resetConductivityCoefficientC

(

)

void openstudio::model::Gas::resetMolecularWeight

(

)

void openstudio::model::Gas::resetSpecificHeatCoefficientA

(

)

void openstudio::model::Gas::resetSpecificHeatCoefficientB

(

)

void openstudio::model::Gas::resetSpecificHeatCoefficientC

(

)

void openstudio::model::Gas::resetSpecificHeatRatio

(

)

void openstudio::model::Gas::resetViscosityCoefficientA

(

)

void openstudio::model::Gas::resetViscosityCoefficientB

(

)

void openstudio::model::Gas::resetViscosityCoefficientC

(

)

bool openstudio::model::Gas::setConductivityCoefficientA

(

double

conductivityCoefficientA

)

bool openstudio::model::Gas::setConductivityCoefficientB

(

double

conductivityCoefficientB

)

bool openstudio::model::Gas::setConductivityCoefficientC

(

double

conductivityCoefficientC

)

bool openstudio::model::Gas::setCustomConductivity	(	double	A,
		double	B,
		double	C
	)

If gasType() == "Custom", thermalConductivity (W/m*K) = A + B*temperature + C*temperature^2.

bool openstudio::model::Gas::setCustomMolecularWeight

(

double

value

)

If gasType() == "Custom", specifies the molecular weight of the gas.

bool openstudio::model::Gas::setCustomSpecificHeat	(	double	A,
		double	B,
		double	C
	)

If gasType() == "Custom", specific heat (J/kg*K) = A + B*temperature + C*temperature^2.

bool openstudio::model::Gas::setCustomViscosity	(	double	A,
		double	B,
		double	C
	)

If gasType() == "Custom", viscosity (g/m*s) = A + B*temperature + C*temperature^2.

bool openstudio::model::Gas::setGasType

(

const std::string &

gasType

)

bool openstudio::model::Gas::setMolecularWeight

(

double

molecularWeight

)

bool openstudio::model::Gas::setSpecificHeatCoefficientA

(

double

specificHeatCoefficientA

)

bool openstudio::model::Gas::setSpecificHeatCoefficientB

(

double

specificHeatCoefficientB

)

bool openstudio::model::Gas::setSpecificHeatCoefficientC

(

double

specificHeatCoefficientC

)

bool openstudio::model::Gas::setSpecificHeatRatio

(

double

specificHeatRatio

)

bool openstudio::model::Gas::setThickness

(

double

thickness

)

bool openstudio::model::Gas::setViscosityCoefficientA

(

double

viscosityCoefficientA

)

bool openstudio::model::Gas::setViscosityCoefficientB

(

double

viscosityCoefficientB

)

bool openstudio::model::Gas::setViscosityCoefficientC

(

double

viscosityCoefficientC

)

boost::optional<double> openstudio::model::Gas::specificHeatCoefficientA

(

)

const

boost::optional<double> openstudio::model::Gas::specificHeatCoefficientB

(

)

const

boost::optional<double> openstudio::model::Gas::specificHeatCoefficientC

(

)

const

boost::optional<double> openstudio::model::Gas::specificHeatRatio

(

)

const

double openstudio::model::Gas::thickness

(

)

const

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

static

boost::optional<double> openstudio::model::Gas::viscosityCoefficientA

(

)

const

boost::optional<double> openstudio::model::Gas::viscosityCoefficientB

(

)

const

boost::optional<double> openstudio::model::Gas::viscosityCoefficientC

(

)

const

Friends And Related Function Documentation

using GasVector = std::vector<Gas>

related

using OptionalGas = boost::optional<Gas>

related