OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Related Functions | List of all members
openstudio::model::GasMixture Class Reference

#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 ()=default
 
 GasMixture (const GasMixture &other)=default
 
 GasMixture (GasMixture &&other)=default
 
GasMixtureoperator= (const GasMixture &)=default
 
GasMixtureoperator= (GasMixture &&)=default
 
Getters
std::string getGasType (unsigned index) const
 Get the type of gas at index, where index starts at 0. More...
 
double getGasFraction (unsigned index) const
 Get the mixture fraction of the gas at index, where index starts at 0. 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) of the mixture at temperature (K). More...
 
double getSpecificHeat (double temperature) const
 The specific heat (J/kg*K) of the mixture at temperature (K). More...
 
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. More...
 
bool setGasType (unsigned index, const std::string &type)
 Set the type of gas at index, if index < numGases. More...
 
bool setGasFraction (unsigned index, double fraction)
 Set the fraction of gas at index, if index < numGases. More...
 
bool addGas (const std::string &type, double fraction)
 Append gas if numGases < 4. More...
 
bool setFractions (const std::vector< double > &fractions)
 Set the gas fractions. More...
 
bool balanceFractions (unsigned index)
 Assign gas fraction at index to 1.0 - sum(other gas fractions), if index < numGases. More...
 
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 ()=default
 
 GasLayer (const GasLayer &other)=default
 
 GasLayer (GasLayer &&other)=default
 
GasLayeroperator= (const GasLayer &)=default
 
GasLayeroperator= (GasLayer &&)=default
 
- Public Member Functions inherited from openstudio::model::FenestrationMaterial
virtual ~FenestrationMaterial ()=default
 
 FenestrationMaterial (const FenestrationMaterial &other)=default
 
 FenestrationMaterial (FenestrationMaterial &&other)=default
 
FenestrationMaterialoperator= (const FenestrationMaterial &)=default
 
FenestrationMaterialoperator= (FenestrationMaterial &&)=default
 
- Public Member Functions inherited from openstudio::model::Material
virtual ~Material ()=default
 
 Material (const Material &other)=default
 
 Material (Material &&other)=default
 
Materialoperator= (const Material &)=default
 
Materialoperator= (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...
 
ResourceObjectoperator= (const ResourceObject &)=default
 
ResourceObjectoperator= (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< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (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
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () 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< LifeCycleCostlifeCycleCosts () 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< ScheduleTypeKeygetScheduleTypeKeys (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< ModelObjectconnectedObject (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 > 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). 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 GasMixtureVector = std::vector< GasMixture >
 
using OptionalGasMixture = boost::optional< GasMixture >
 

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

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

Constructor & Destructor Documentation

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
virtual openstudio::model::GasMixture::~GasMixture ( )
virtualdefault
openstudio::model::GasMixture::GasMixture ( const GasMixture other)
default
openstudio::model::GasMixture::GasMixture ( GasMixture &&  other)
default

Member Function Documentation

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

Append gas if numGases < 4.

See also
validGasTypes
bool openstudio::model::GasMixture::balanceFractions ( unsigned  index)

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

double openstudio::model::GasMixture::gas1Fraction ( ) const
std::string openstudio::model::GasMixture::gas1Type ( ) const
static std::vector<std::string> openstudio::model::GasMixture::gas1TypeValues ( )
static
double openstudio::model::GasMixture::gas2Fraction ( ) const
std::string openstudio::model::GasMixture::gas2Type ( ) const
static std::vector<std::string> openstudio::model::GasMixture::gas2TypeValues ( )
static
boost::optional<double> openstudio::model::GasMixture::gas3Fraction ( ) const
std::string openstudio::model::GasMixture::gas3Type ( ) const
static std::vector<std::string> openstudio::model::GasMixture::gas3TypeValues ( )
static
boost::optional<double> openstudio::model::GasMixture::gas4Fraction ( ) const
std::string openstudio::model::GasMixture::gas4Type ( ) const
static std::vector<std::string> openstudio::model::GasMixture::gas4TypeValues ( )
static
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.

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

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

Throws if unavailable.

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

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

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

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

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

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

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

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

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

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

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

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

static IddObjectType openstudio::model::GasMixture::iddObjectType ( )
static
int openstudio::model::GasMixture::numberofGasesinMixture ( ) const
unsigned openstudio::model::GasMixture::numGases ( ) const
GasMixture& openstudio::model::GasMixture::operator= ( const GasMixture )
default
GasMixture& openstudio::model::GasMixture::operator= ( GasMixture &&  )
default
void openstudio::model::GasMixture::resetGas1Fraction ( )
void openstudio::model::GasMixture::resetGas1Type ( )
void openstudio::model::GasMixture::resetGas2Fraction ( )
void openstudio::model::GasMixture::resetGas2Type ( )
void openstudio::model::GasMixture::resetGas3Fraction ( )
void openstudio::model::GasMixture::resetGas3Type ( )
void openstudio::model::GasMixture::resetGas4Fraction ( )
void openstudio::model::GasMixture::resetGas4Type ( )
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).

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
bool openstudio::model::GasMixture::setGas1Fraction ( double  gas1Fraction)
bool openstudio::model::GasMixture::setGas1Type ( const std::string &  gas1Type)
bool openstudio::model::GasMixture::setGas2Fraction ( double  gas2Fraction)
bool openstudio::model::GasMixture::setGas2Type ( const std::string &  gas2Type)
bool openstudio::model::GasMixture::setGas3Fraction ( double  gas3Fraction)
bool openstudio::model::GasMixture::setGas3Type ( const std::string &  gas3Type)
bool openstudio::model::GasMixture::setGas4Fraction ( double  gas4Fraction)
bool openstudio::model::GasMixture::setGas4Type ( const std::string &  gas4Type)
bool openstudio::model::GasMixture::setGasFraction ( unsigned  index,
double  fraction 
)

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

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

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

See also
validGasTypes
bool openstudio::model::GasMixture::setNumberofGasesinMixture ( int  numberofGasesinMixture)
bool openstudio::model::GasMixture::setThickness ( double  thickness)
double openstudio::model::GasMixture::thickness ( ) const
static std::vector<std::string> openstudio::model::GasMixture::validGasTypes ( )
static

Friends And Related Function Documentation

using GasMixtureVector = std::vector<GasMixture>
related
using OptionalGasMixture = boost::optional<GasMixture>
related