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

#include <StandardOpaqueMaterial.hpp>

+ Inheritance diagram for openstudio::model::StandardOpaqueMaterial:

Public Member Functions

Constructors and Destructors
 StandardOpaqueMaterial (const Model &model, const std::string &roughness="Smooth", double thickness=0.1, double conductivity=0.1, double density=0.1, double specificHeat=1400)
 
virtual ~StandardOpaqueMaterial ()=default
 
 StandardOpaqueMaterial (const StandardOpaqueMaterial &other)=default
 
 StandardOpaqueMaterial (StandardOpaqueMaterial &&other)=default
 
StandardOpaqueMaterialoperator= (const StandardOpaqueMaterial &)=default
 
StandardOpaqueMaterialoperator= (StandardOpaqueMaterial &&)=default
 
Getters
double thermalConductivity () const
 The conductivity of the material in W/m*K. More...
 
double thermalConductance () const
 The conductance of the material in W/m^2*K. More...
 
double thermalResistivity () const
 The resistivity of the material in m*K/W. More...
 
double thermalResistance () const
 The resistance of the material in m^2*K/W. More...
 
boost::optional< double > thermalReflectance () const
 
boost::optional< double > solarReflectance () const
 
boost::optional< double > visibleReflectance () const
 
std::string roughness () const
 
double thickness () const
 
double conductivity () const
 
double density () const
 
double specificHeat () const
 
double thermalAbsorptance () const
 
bool isThermalAbsorptanceDefaulted () const
 
double solarAbsorptance () const
 
bool isSolarAbsorptanceDefaulted () const
 
double visibleAbsorptance () const
 
bool isVisibleAbsorptanceDefaulted () const
 
Setters
bool setThermalConductivity (double value)
 Sets the conductivity of the material in W/m*K, if possible. More...
 
bool setThermalConductance (double value)
 Sets the conductance of the material in W/m^2*K, if possible. More...
 
bool setThermalResistivity (double value)
 Sets the resistivity of the material in m*K/W, if possible. More...
 
bool setThermalResistance (double value)
 Sets the resistance of the material in m^2*K/W, if possible. More...
 
bool setThermalAbsorptance (boost::optional< double > value)
 
bool setThermalReflectance (boost::optional< double > value)
 
bool setSolarAbsorptance (boost::optional< double > value)
 
bool setSolarReflectance (boost::optional< double > value)
 
bool setVisibleAbsorptance (boost::optional< double > value)
 
bool setVisibleReflectance (boost::optional< double > value)
 
bool setRoughness (const std::string &roughness)
 
bool setThickness (double thickness)
 
bool setConductivity (double conductivity)
 
bool setDensity (double density)
 
bool setSpecificHeat (double specificHeat)
 
bool setThermalAbsorptance (double thermalAbsorptance)
 
void resetThermalAbsorptance ()
 
bool setSolarAbsorptance (double solarAbsorptance)
 
void resetSolarAbsorptance ()
 
bool setVisibleAbsorptance (double visibleAbsorptance)
 
void resetVisibleAbsorptance ()
 
boost::optional
< MaterialPropertyMoisturePenetrationDepthSettings
createMaterialPropertyMoisturePenetrationDepthSettings (double waterVaporDiffusionResistanceFactor, double moistureEquationCoefficientA, double moistureEquationCoefficientB, double moistureEquationCoefficientC, double moistureEquationCoefficientD, double coatingLayerThickness, double coatingLayerWaterVaporDiffusionResistanceFactor)
 
boost::optional
< MaterialPropertyMoisturePenetrationDepthSettings
materialPropertyMoisturePenetrationDepthSettings () const
 
void resetMaterialPropertyMoisturePenetrationDepthSettings ()
 
boost::optional
< MaterialPropertyPhaseChange
createMaterialPropertyPhaseChange ()
 
boost::optional
< MaterialPropertyPhaseChange
createMaterialPropertyPhaseChange (const std::vector< TemperatureEnthalpy > &temperatureEnthalpys)
 
boost::optional
< MaterialPropertyPhaseChange
materialPropertyPhaseChange () const
 
void resetMaterialPropertyPhaseChange ()
 
boost::optional
< MaterialPropertyPhaseChangeHysteresis
createMaterialPropertyPhaseChangeHysteresis ()
 
boost::optional
< MaterialPropertyPhaseChangeHysteresis
materialPropertyPhaseChangeHysteresis () const
 
void resetMaterialPropertyPhaseChangeHysteresis ()
 
Queries
boost::optional< double > heatCapacity () const
 Energy it takes to raise the temperature of this material 1 K (J/m^2*K). More...
 
- Public Member Functions inherited from openstudio::model::OpaqueMaterial
virtual ~OpaqueMaterial ()=default
 
 OpaqueMaterial (const OpaqueMaterial &other)=default
 
 OpaqueMaterial (OpaqueMaterial &&other)=default
 
OpaqueMaterialoperator= (const OpaqueMaterial &)=default
 
OpaqueMaterialoperator= (OpaqueMaterial &&)=default
 
double thermalConductivity () const
 The conductivity of the material in W/m*K. More...
 
double thermalConductance () const
 The conductance of the material in W/m^2*K. More...
 
double thermalResistivity () const
 The resistivity of the material in m*K/W. More...
 
double thermalResistance () const
 The resistance of the material in m^2*K/W. More...
 
double thermalAbsorptance () const
 
boost::optional< double > thermalReflectance () const
 
double solarAbsorptance () const
 
boost::optional< double > solarReflectance () const
 
double visibleAbsorptance () const
 
boost::optional< double > visibleReflectance () const
 
bool setThermalConductivity (double value)
 Sets the conductivity of the material in W/m*K, if possible. More...
 
bool setThermalConductance (double value)
 Sets the conductance of the material in W/m^2*K, if possible. More...
 
bool setThermalResistivity (double value)
 Sets the resistivity of the material in m*K/W, if possible. More...
 
bool setThermalResistance (double value)
 Sets the resistance of the material in m^2*K/W, if possible. More...
 
bool setThermalAbsorptance (double value)
 
bool setThermalReflectance (boost::optional< double > value)
 
bool setSolarAbsorptance (boost::optional< double > value)
 
bool setSolarReflectance (boost::optional< double > value)
 
bool setVisibleAbsorptance (boost::optional< double > value)
 
bool setVisibleReflectance (boost::optional< double > value)
 
boost::optional< double > heatCapacity () const
 Energy it takes to raise the temperature of this material 1 K (J/m^2*K). More...
 
- 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 IddObjectType iddObjectType ()
 
static std::vector< std::string > roughnessValues ()
 

Related Functions

(Note that these are not member functions.)

using OptionalStandardOpaqueMaterial = boost::optional< StandardOpaqueMaterial >
 
using StadardOpaqueMaterialVector = std::vector< StandardOpaqueMaterial >
 

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

StandardOpaqueMaterial is a OpaqueMaterial that wraps the OpenStudio IDD object 'OS:OpaqueMaterial'.

Constructor & Destructor Documentation

openstudio::model::StandardOpaqueMaterial::StandardOpaqueMaterial ( const Model model,
const std::string &  roughness = "Smooth",
double  thickness = 0.1,
double  conductivity = 0.1,
double  density = 0.1,
double  specificHeat = 1400 
)
explicit
virtual openstudio::model::StandardOpaqueMaterial::~StandardOpaqueMaterial ( )
virtualdefault
openstudio::model::StandardOpaqueMaterial::StandardOpaqueMaterial ( const StandardOpaqueMaterial other)
default
openstudio::model::StandardOpaqueMaterial::StandardOpaqueMaterial ( StandardOpaqueMaterial &&  other)
default

Member Function Documentation

double openstudio::model::StandardOpaqueMaterial::conductivity ( ) const
boost::optional<MaterialPropertyMoisturePenetrationDepthSettings> openstudio::model::StandardOpaqueMaterial::createMaterialPropertyMoisturePenetrationDepthSettings ( double  waterVaporDiffusionResistanceFactor,
double  moistureEquationCoefficientA,
double  moistureEquationCoefficientB,
double  moistureEquationCoefficientC,
double  moistureEquationCoefficientD,
double  coatingLayerThickness,
double  coatingLayerWaterVaporDiffusionResistanceFactor 
)
boost::optional<MaterialPropertyPhaseChange> openstudio::model::StandardOpaqueMaterial::createMaterialPropertyPhaseChange ( )
boost::optional<MaterialPropertyPhaseChange> openstudio::model::StandardOpaqueMaterial::createMaterialPropertyPhaseChange ( const std::vector< TemperatureEnthalpy > &  temperatureEnthalpys)
boost::optional<MaterialPropertyPhaseChangeHysteresis> openstudio::model::StandardOpaqueMaterial::createMaterialPropertyPhaseChangeHysteresis ( )
double openstudio::model::StandardOpaqueMaterial::density ( ) const
boost::optional<double> openstudio::model::StandardOpaqueMaterial::heatCapacity ( ) const

Energy it takes to raise the temperature of this material 1 K (J/m^2*K).

Equal to specificHeat() * density() * thickness().

static IddObjectType openstudio::model::StandardOpaqueMaterial::iddObjectType ( )
static
bool openstudio::model::StandardOpaqueMaterial::isSolarAbsorptanceDefaulted ( ) const
bool openstudio::model::StandardOpaqueMaterial::isThermalAbsorptanceDefaulted ( ) const
bool openstudio::model::StandardOpaqueMaterial::isVisibleAbsorptanceDefaulted ( ) const
boost::optional<MaterialPropertyMoisturePenetrationDepthSettings> openstudio::model::StandardOpaqueMaterial::materialPropertyMoisturePenetrationDepthSettings ( ) const
boost::optional<MaterialPropertyPhaseChange> openstudio::model::StandardOpaqueMaterial::materialPropertyPhaseChange ( ) const
boost::optional<MaterialPropertyPhaseChangeHysteresis> openstudio::model::StandardOpaqueMaterial::materialPropertyPhaseChangeHysteresis ( ) const
StandardOpaqueMaterial& openstudio::model::StandardOpaqueMaterial::operator= ( const StandardOpaqueMaterial )
default
StandardOpaqueMaterial& openstudio::model::StandardOpaqueMaterial::operator= ( StandardOpaqueMaterial &&  )
default
void openstudio::model::StandardOpaqueMaterial::resetMaterialPropertyMoisturePenetrationDepthSettings ( )
void openstudio::model::StandardOpaqueMaterial::resetMaterialPropertyPhaseChange ( )
void openstudio::model::StandardOpaqueMaterial::resetMaterialPropertyPhaseChangeHysteresis ( )
void openstudio::model::StandardOpaqueMaterial::resetSolarAbsorptance ( )
void openstudio::model::StandardOpaqueMaterial::resetThermalAbsorptance ( )
void openstudio::model::StandardOpaqueMaterial::resetVisibleAbsorptance ( )
std::string openstudio::model::StandardOpaqueMaterial::roughness ( ) const
static std::vector<std::string> openstudio::model::StandardOpaqueMaterial::roughnessValues ( )
static
bool openstudio::model::StandardOpaqueMaterial::setConductivity ( double  conductivity)
bool openstudio::model::StandardOpaqueMaterial::setDensity ( double  density)
bool openstudio::model::StandardOpaqueMaterial::setRoughness ( const std::string &  roughness)
bool openstudio::model::StandardOpaqueMaterial::setSolarAbsorptance ( boost::optional< double >  value)
bool openstudio::model::StandardOpaqueMaterial::setSolarAbsorptance ( double  solarAbsorptance)
bool openstudio::model::StandardOpaqueMaterial::setSolarReflectance ( boost::optional< double >  value)
bool openstudio::model::StandardOpaqueMaterial::setSpecificHeat ( double  specificHeat)
bool openstudio::model::StandardOpaqueMaterial::setThermalAbsorptance ( boost::optional< double >  value)
bool openstudio::model::StandardOpaqueMaterial::setThermalAbsorptance ( double  thermalAbsorptance)
bool openstudio::model::StandardOpaqueMaterial::setThermalConductance ( double  value)

Sets the conductance of the material in W/m^2*K, if possible.

Sets thickness to achieve conductivity.

bool openstudio::model::StandardOpaqueMaterial::setThermalConductivity ( double  value)

Sets the conductivity of the material in W/m*K, if possible.

bool openstudio::model::StandardOpaqueMaterial::setThermalReflectance ( boost::optional< double >  value)
bool openstudio::model::StandardOpaqueMaterial::setThermalResistance ( double  value)

Sets the resistance of the material in m^2*K/W, if possible.

Sets thickness to achieve resistivity.

bool openstudio::model::StandardOpaqueMaterial::setThermalResistivity ( double  value)

Sets the resistivity of the material in m*K/W, if possible.

bool openstudio::model::StandardOpaqueMaterial::setThickness ( double  thickness)
bool openstudio::model::StandardOpaqueMaterial::setVisibleAbsorptance ( boost::optional< double >  value)
bool openstudio::model::StandardOpaqueMaterial::setVisibleAbsorptance ( double  visibleAbsorptance)
bool openstudio::model::StandardOpaqueMaterial::setVisibleReflectance ( boost::optional< double >  value)
double openstudio::model::StandardOpaqueMaterial::solarAbsorptance ( ) const
boost::optional<double> openstudio::model::StandardOpaqueMaterial::solarReflectance ( ) const
double openstudio::model::StandardOpaqueMaterial::specificHeat ( ) const
double openstudio::model::StandardOpaqueMaterial::thermalAbsorptance ( ) const
double openstudio::model::StandardOpaqueMaterial::thermalConductance ( ) const

The conductance of the material in W/m^2*K.

double openstudio::model::StandardOpaqueMaterial::thermalConductivity ( ) const

The conductivity of the material in W/m*K.

boost::optional<double> openstudio::model::StandardOpaqueMaterial::thermalReflectance ( ) const
double openstudio::model::StandardOpaqueMaterial::thermalResistance ( ) const

The resistance of the material in m^2*K/W.

double openstudio::model::StandardOpaqueMaterial::thermalResistivity ( ) const

The resistivity of the material in m*K/W.

double openstudio::model::StandardOpaqueMaterial::thickness ( ) const
double openstudio::model::StandardOpaqueMaterial::visibleAbsorptance ( ) const
boost::optional<double> openstudio::model::StandardOpaqueMaterial::visibleReflectance ( ) const

Friends And Related Function Documentation

using OptionalStandardOpaqueMaterial = boost::optional<StandardOpaqueMaterial>
related