OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends 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 ()
 
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
 
Quantity getThickness (bool returnIP=false) const
 
int numberofGasesinMixture () const
 
std::string gas1Type () const
 
double gas1Fraction () const
 
Quantity getGas1Fraction (bool returnIP=false) const
 
std::string gas2Type () const
 
double gas2Fraction () const
 
Quantity getGas2Fraction (bool returnIP=false) const
 
std::string gas3Type () const
 
boost::optional< double > gas3Fraction () const
 
OSOptionalQuantity getGas3Fraction (bool returnIP=false) const
 
std::string gas4Type () const
 
boost::optional< double > gas4Fraction () const
 
OSOptionalQuantity getGas4Fraction (bool returnIP=false) 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 setThickness (const Quantity &thickness)
 
bool setNumberofGasesinMixture (int numberofGasesinMixture)
 
bool setGas1Type (std::string gas1Type)
 
void resetGas1Type ()
 
bool setGas1Fraction (double gas1Fraction)
 
bool setGas1Fraction (const Quantity &gas1Fraction)
 
void resetGas1Fraction ()
 
bool setGas2Type (std::string gas2Type)
 
void resetGas2Type ()
 
bool setGas2Fraction (double gas2Fraction)
 
bool setGas2Fraction (const Quantity &gas2Fraction)
 
void resetGas2Fraction ()
 
bool setGas3Type (std::string gas3Type)
 
void resetGas3Type ()
 
bool setGas3Fraction (double gas3Fraction)
 
bool setGas3Fraction (const Quantity &gas3Fraction)
 
void resetGas3Fraction ()
 
bool setGas4Type (std::string gas4Type)
 
void resetGas4Type ()
 
bool setGas4Fraction (double gas4Fraction)
 
bool setGas4Fraction (const Quantity &gas4Fraction)
 
void resetGas4Fraction ()
 
Queries
unsigned numGases () const
 
- Public Member Functions inherited from openstudio::model::GasLayer
virtual ~GasLayer ()
 
- Public Member Functions inherited from openstudio::model::FenestrationMaterial
virtual ~FenestrationMaterial ()
 
- Public Member Functions inherited from openstudio::model::Material
virtual ~Material ()
 
double thickness () const
 Get the thickness of the material. More...
 
boost::optional< double > getVisibleTransmittance () const
 Get the visible transmittance of the material. More...
 
boost::optional< double > interiorVisibleAbsorptance () const
 Get the interiorVisibleAbsorptance of the material. More...
 
boost::optional< double > exteriorVisibleAbsorptance () const
 Get the exteriorVisibleAbsorptance of the material. More...
 
StandardsInformationMaterial standardsInformation () const
 Returns this materials's standards information, constructing a new object if necessary. More...
 
bool setThickness (double value)
 Set thickness to value (m). More...
 
- 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...
 
virtual ~ResourceObject ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectTypeallowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
virtual ~ParentObject ()
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()
 
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< IdfObjectremoveLifeCycleCosts ()
 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...
 
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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool isSource () const
 
bool isTarget () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
virtual ~WorkspaceObject ()
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector
< std::string > > 
clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< intgetInt (unsigned index, bool returnDefault=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< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
boost::optional< QUrl > getURL (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
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 (const std::vector< std::string > &values)
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=true) const
 
virtual ~IdfObject ()
 

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...
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector< GasMixtureGasMixtureVector
 
typedef boost::optional
< GasMixture
OptionalGasMixture
 

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< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- 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. 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)
 
- 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

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 ( )
inlinevirtual

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
Quantity openstudio::model::GasMixture::getGas1Fraction ( bool  returnIP = false) const
Quantity openstudio::model::GasMixture::getGas2Fraction ( bool  returnIP = false) const
OSOptionalQuantity openstudio::model::GasMixture::getGas3Fraction ( bool  returnIP = false) const
OSOptionalQuantity openstudio::model::GasMixture::getGas4Fraction ( bool  returnIP = false) const
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).

Quantity openstudio::model::GasMixture::getThickness ( bool  returnIP = false) const
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
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::setGas1Fraction ( const Quantity gas1Fraction)
bool openstudio::model::GasMixture::setGas1Type ( std::string  gas1Type)
bool openstudio::model::GasMixture::setGas2Fraction ( double  gas2Fraction)
bool openstudio::model::GasMixture::setGas2Fraction ( const Quantity gas2Fraction)
bool openstudio::model::GasMixture::setGas2Type ( std::string  gas2Type)
bool openstudio::model::GasMixture::setGas3Fraction ( double  gas3Fraction)
bool openstudio::model::GasMixture::setGas3Fraction ( const Quantity gas3Fraction)
bool openstudio::model::GasMixture::setGas3Type ( std::string  gas3Type)
bool openstudio::model::GasMixture::setGas4Fraction ( double  gas4Fraction)
bool openstudio::model::GasMixture::setGas4Fraction ( const Quantity gas4Fraction)
bool openstudio::model::GasMixture::setGas4Type ( 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)
bool openstudio::model::GasMixture::setThickness ( const Quantity thickness)
double openstudio::model::GasMixture::thickness ( ) const
static std::vector<std::string> openstudio::model::GasMixture::validGasTypes ( )
static

Friends And Related Function Documentation

typedef std::vector<GasMixture> GasMixtureVector
related
typedef boost::optional<GasMixture> OptionalGasMixture
related