OpenStudio:model
Loading...
Searching...
No Matches
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 () override=default
 
 Gas (const Gas &other)=default
 
 Gas (Gas &&other)=default
 
Gasoperator= (const Gas &)=default
 
Gasoperator= (Gas &&)=default
 
Getters
std::string gasType () const
 Gets the gas type.
 
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) at temperature (K).
 
double getSpecificHeat (double temperature) const
 The specific heat (J/kg*K) at temperature (K).
 
boost::optional< double > customConductivityCoefficientA () const
 The first conductivity coefficient of gasType "Custom" (W/m*K).
 
boost::optional< double > customConductivityCoefficientB () const
 The second conductivity coefficient of gasType "Custom" (W/m*K^2).
 
boost::optional< double > customConductivityCoefficientC () const
 The third conductivity coefficient of gasType "Custom" (W/m*K^3).
 
boost::optional< double > customViscosityCoefficientA () const
 The first viscosity coefficient of gasType "Custom" (kg/m*s).
 
boost::optional< double > customViscosityCoefficientB () const
 The second viscosity coefficient of gasType "Custom" (kg/m*s).
 
boost::optional< double > customViscosityCoefficientC () const
 The third viscosity coefficient of gasType "Custom" (kg/m*s).
 
boost::optional< double > customSpecificHeatCoefficientA () const
 The first specific heat coefficient of gasType "Custom" (J/kg*K).
 
boost::optional< double > customSpecificHeatCoefficientB () const
 The second specific heat coefficient of gasType "Custom" (J/kg*K).
 
boost::optional< double > customSpecificHeatCoefficientC () const
 The third specific heat coefficient of gasType "Custom" (J/kg*K).
 
boost::optional< double > customMolecularWeight () const
 The molecular weight (u) of gasType "Custom".
 
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.
 
bool setCustomViscosity (double A, double B, double C)
 If gasType() == "Custom", viscosity (g/m*s) = A + B*temperature + C*temperature^2.
 
bool setCustomSpecificHeat (double A, double B, double C)
 If gasType() == "Custom", specific heat (J/kg*K) = A + B*temperature + C*temperature^2.
 
bool setCustomMolecularWeight (double value)
 If gasType() == "Custom", specifies the molecular weight of the gas.
 
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 () override=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 () override=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 () override=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.
 
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.
 
ResourceObjectoperator= (const ResourceObject &)=default
 
ResourceObjectoperator= (ResourceObject &&)=default
 
 ResourceObject (const ResourceObject &other)=default
 
 ResourceObject (ResourceObject &&other)=default
 
virtual ~ResourceObject () override=default
 
- Public Member Functions inherited from openstudio::model::ParentObject
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject () override=default
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model.
 
std::vector< IddObjectTypeallowableChildTypes () 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
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one.
 
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data.
 
boost::optional< openstudio::TimeSeriesgetData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object.
 
std::vector< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object.
 
std::vector< IdfObjectremoveLifeCycleCosts ()
 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< IdfObjectremoveAdditionalProperties ()
 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< ScheduleTypeKeygetScheduleTypeKeys (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< EMSActuatorNamesemsActuatorNames () 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< ModelObjectconnectedObject (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< WorkspaceObjectgetSources (IddObjectType type) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
boost::optional< WorkspaceObjectgetTarget (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)
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
std::vector< openstudio::IdfObjectremove ()
 
std::vector< openstudio::IdfObjectremove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
std::vector< WorkspaceObjecttargets () 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
 
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< IdfExtensibleGroupextensibleGroups () const
 
std::vector< IdfExtensibleGroupextensibleGroups () 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)
 
IdfObjectoperator= (const IdfObject &other)
 
IdfObjectoperator= (const IdfObject &other)
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
IdfObjectoperator= (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 > 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).
 
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< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

Related Symbols

(Note that these are not member symbols.)

using GasVector = std::vector<Gas>
 
using OptionalGas = boost::optional<Gas>
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional< WorkspaceObjectOptionalWorkspaceObject
 
typedef std::vector< WorkspaceObjectWorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObjectIdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional< IdfObjectOptionalIdfObject
 
- 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

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

Constructor & Destructor Documentation

◆ Gas() [1/3]

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

◆ ~Gas()

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

◆ Gas() [2/3]

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

◆ Gas() [3/3]

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

Member Function Documentation

◆ conductivityCoefficientA()

boost::optional< double > openstudio::model::Gas::conductivityCoefficientA ( ) const

◆ conductivityCoefficientB()

boost::optional< double > openstudio::model::Gas::conductivityCoefficientB ( ) const

◆ conductivityCoefficientC()

boost::optional< double > openstudio::model::Gas::conductivityCoefficientC ( ) const

◆ customConductivityCoefficientA()

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).

◆ customConductivityCoefficientB()

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).

◆ customConductivityCoefficientC()

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).

◆ customMolecularWeight()

boost::optional< double > openstudio::model::Gas::customMolecularWeight ( ) const

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

◆ customSpecificHeatCoefficientA()

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).

◆ customSpecificHeatCoefficientB()

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).

◆ customSpecificHeatCoefficientC()

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).

◆ customViscosityCoefficientA()

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).

◆ customViscosityCoefficientB()

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).

◆ customViscosityCoefficientC()

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).

◆ gasType()

std::string openstudio::model::Gas::gasType ( ) const

Gets the gas type.

◆ gasTypeValues()

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

◆ getSpecificHeat()

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.

◆ getThermalConductance()

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.

◆ getThermalConductivity()

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.

◆ getThermalResistance()

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.

◆ getThermalResistivity()

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.

◆ getViscosity()

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.

◆ iddObjectType()

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

◆ molecularWeight()

boost::optional< double > openstudio::model::Gas::molecularWeight ( ) const

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ resetConductivityCoefficientA()

void openstudio::model::Gas::resetConductivityCoefficientA ( )

◆ resetConductivityCoefficientB()

void openstudio::model::Gas::resetConductivityCoefficientB ( )

◆ resetConductivityCoefficientC()

void openstudio::model::Gas::resetConductivityCoefficientC ( )

◆ resetMolecularWeight()

void openstudio::model::Gas::resetMolecularWeight ( )

◆ resetSpecificHeatCoefficientA()

void openstudio::model::Gas::resetSpecificHeatCoefficientA ( )

◆ resetSpecificHeatCoefficientB()

void openstudio::model::Gas::resetSpecificHeatCoefficientB ( )

◆ resetSpecificHeatCoefficientC()

void openstudio::model::Gas::resetSpecificHeatCoefficientC ( )

◆ resetSpecificHeatRatio()

void openstudio::model::Gas::resetSpecificHeatRatio ( )

◆ resetViscosityCoefficientA()

void openstudio::model::Gas::resetViscosityCoefficientA ( )

◆ resetViscosityCoefficientB()

void openstudio::model::Gas::resetViscosityCoefficientB ( )

◆ resetViscosityCoefficientC()

void openstudio::model::Gas::resetViscosityCoefficientC ( )

◆ setConductivityCoefficientA()

bool openstudio::model::Gas::setConductivityCoefficientA ( double conductivityCoefficientA)

◆ setConductivityCoefficientB()

bool openstudio::model::Gas::setConductivityCoefficientB ( double conductivityCoefficientB)

◆ setConductivityCoefficientC()

bool openstudio::model::Gas::setConductivityCoefficientC ( double conductivityCoefficientC)

◆ setCustomConductivity()

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

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

◆ setCustomMolecularWeight()

bool openstudio::model::Gas::setCustomMolecularWeight ( double value)

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

◆ setCustomSpecificHeat()

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.

◆ setCustomViscosity()

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

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

◆ setGasType()

bool openstudio::model::Gas::setGasType ( const std::string & gasType)

◆ setMolecularWeight()

bool openstudio::model::Gas::setMolecularWeight ( double molecularWeight)

◆ setSpecificHeatCoefficientA()

bool openstudio::model::Gas::setSpecificHeatCoefficientA ( double specificHeatCoefficientA)

◆ setSpecificHeatCoefficientB()

bool openstudio::model::Gas::setSpecificHeatCoefficientB ( double specificHeatCoefficientB)

◆ setSpecificHeatCoefficientC()

bool openstudio::model::Gas::setSpecificHeatCoefficientC ( double specificHeatCoefficientC)

◆ setSpecificHeatRatio()

bool openstudio::model::Gas::setSpecificHeatRatio ( double specificHeatRatio)

◆ setThickness()

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

◆ setViscosityCoefficientA()

bool openstudio::model::Gas::setViscosityCoefficientA ( double viscosityCoefficientA)

◆ setViscosityCoefficientB()

bool openstudio::model::Gas::setViscosityCoefficientB ( double viscosityCoefficientB)

◆ setViscosityCoefficientC()

bool openstudio::model::Gas::setViscosityCoefficientC ( double viscosityCoefficientC)

◆ specificHeatCoefficientA()

boost::optional< double > openstudio::model::Gas::specificHeatCoefficientA ( ) const

◆ specificHeatCoefficientB()

boost::optional< double > openstudio::model::Gas::specificHeatCoefficientB ( ) const

◆ specificHeatCoefficientC()

boost::optional< double > openstudio::model::Gas::specificHeatCoefficientC ( ) const

◆ specificHeatRatio()

boost::optional< double > openstudio::model::Gas::specificHeatRatio ( ) const

◆ thickness()

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

◆ validGasTypes()

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

◆ viscosityCoefficientA()

boost::optional< double > openstudio::model::Gas::viscosityCoefficientA ( ) const

◆ viscosityCoefficientB()

boost::optional< double > openstudio::model::Gas::viscosityCoefficientB ( ) const

◆ viscosityCoefficientC()

boost::optional< double > openstudio::model::Gas::viscosityCoefficientC ( ) const

Friends And Related Symbol Documentation

◆ GasVector

using GasVector = std::vector<Gas>
related

◆ OptionalGas

using OptionalGas = boost::optional<Gas>
related