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, std::string roughness="Smooth", double thickness=0.1, double conductivity=0.1, double density=0.1, double specificHeat=1400)
 
virtual ~StandardOpaqueMaterial ()
 
Getters
double thermalConductivity () const
 Thermal conductivity of the OpaqueMaterial in W/m*K. More...
 
double thermalConductance () const
 Thermal conductance of the OpaqueMaterial in W/m^2*K. More...
 
double thermalResistivity () const
 Thermal resistivity of the OpaqueMaterial in m*K/W. More...
 
double thermalResistance () const
 Thermal resistance of the OpaqueMaterial in m^2*K/W. More...
 
boost::optional< double > thermalReflectance () const
 Thermal reflectance of the OpaqueMaterial (dimensionless fraction). More...
 
boost::optional< double > solarReflectance () const
 Solar reflectance of the OpaqueMaterial (dimensionless fraction). More...
 
boost::optional< double > visibleReflectance () const
 Visible reflectance of the OpaqueMaterial (dimensionless fraction). More...
 
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)
 Set the thermal conductivity (W/m*K). More...
 
bool setThermalConductance (double value)
 Set the thermal conductance (W/m^2*K). More...
 
bool setThermalResistivity (double value)
 Set the thermal resistivity (m*K/W). More...
 
bool setThermalResistance (double value)
 Set the thermal resistance (m^2*K/W). More...
 
bool setThermalAbsorptance (boost::optional< double > value)
 Set the thermal absorptance (dimensionless fraction). More...
 
bool setThermalReflectance (boost::optional< double > value)
 Set the thermal reflectance (dimensionless fraction). More...
 
bool setSolarAbsorptance (boost::optional< double > value)
 Set the solar absorptance (dimensionless fraction). More...
 
bool setSolarReflectance (boost::optional< double > value)
 Set the solar reflectance (dimensionless fraction). More...
 
bool setVisibleAbsorptance (boost::optional< double > value)
 Set the visible absorptance (dimensionless fraction). More...
 
bool setVisibleReflectance (boost::optional< double > value)
 Set the visible reflectance (dimensionless fraction). More...
 
bool setRoughness (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 ()
 
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 ()
 
double thermalConductivity () const
 Thermal conductivity of the Material in W/m*K. More...
 
double thermalConductance () const
 Thermal conductance of the Material in W/m^2*K. More...
 
double thermalResistivity () const
 Thermal resistivity of the Material in m*K/W. More...
 
double thermalResistance () const
 Thermal resistance of the Material in m^2*K/W. More...
 
double thermalAbsorptance () const
 Thermal absorptance of the Material (dimensionless fraction). More...
 
boost::optional< double > thermalReflectance () const
 Thermal reflectance of the Material (dimensionless fraction). More...
 
double solarAbsorptance () const
 Solar absorptance of the Material (dimensionless fraction). More...
 
boost::optional< double > solarReflectance () const
 Solar reflectance of the Material (dimensionless fraction). More...
 
double visibleAbsorptance () const
 Visible absorptance of the Material (dimensionless fraction). More...
 
boost::optional< double > visibleReflectance () const
 Visible reflectance of the Material (dimensionless fraction). More...
 
bool setThermalConductivity (double value)
 Set the thermal conductivity (W/m*K). More...
 
bool setThermalConductance (double value)
 Set the thermal conductance (W/m^2*K). More...
 
bool setThermalResistivity (double value)
 Set the thermal resistivity (m*K/W). More...
 
bool setThermalResistance (double value)
 Set the thermal resistance (m^2*K/W). More...
 
bool setThermalAbsorptance (double value)
 Set the thermal absorptance (dimensionless fraction). More...
 
bool setThermalReflectance (boost::optional< double > value)
 Set the thermal reflectance (dimensionless fraction). More...
 
bool setSolarAbsorptance (boost::optional< double > value)
 Set the solar absorptance (dimensionless fraction). More...
 
bool setSolarReflectance (boost::optional< double > value)
 Set the solar reflectance (dimensionless fraction). More...
 
bool setVisibleAbsorptance (boost::optional< double > value)
 Set the visible absorptance (dimensionless fraction). More...
 
bool setVisibleReflectance (boost::optional< double > value)
 Set the visible reflectance (dimensionless fraction). More...
 
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 ()
 
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...
 
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 ()
 
- 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< IddObjectType > allowableChildTypes () 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< 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...
 
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 (std::string valueName, std::string unitString) 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.)

typedef boost::optional
< StandardOpaqueMaterial
OptionalStandardOpaqueMaterial
 
typedef std::vector
< StandardOpaqueMaterial
StadardOpaqueMaterialVector
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_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)
 

Detailed Description

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

Constructor & Destructor Documentation

openstudio::model::StandardOpaqueMaterial::StandardOpaqueMaterial ( const Model model,
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 ( )
inlinevirtual

Member Function Documentation

double openstudio::model::StandardOpaqueMaterial::conductivity ( ) const
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().

Attribute name: 'heatCapacity'

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
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 ( std::string  roughness)
bool openstudio::model::StandardOpaqueMaterial::setSolarAbsorptance ( boost::optional< double >  value)

Set the solar absorptance (dimensionless fraction).

Attribute name: 'solarAbsorptance'

bool openstudio::model::StandardOpaqueMaterial::setSolarAbsorptance ( double  solarAbsorptance)
bool openstudio::model::StandardOpaqueMaterial::setSolarReflectance ( boost::optional< double >  value)

Set the solar reflectance (dimensionless fraction).

Attribute name: 'solarReflectance'

bool openstudio::model::StandardOpaqueMaterial::setSpecificHeat ( double  specificHeat)
bool openstudio::model::StandardOpaqueMaterial::setThermalAbsorptance ( boost::optional< double >  value)

Set the thermal absorptance (dimensionless fraction).

Attribute name: 'thermalAbsorptance'

bool openstudio::model::StandardOpaqueMaterial::setThermalAbsorptance ( double  thermalAbsorptance)
bool openstudio::model::StandardOpaqueMaterial::setThermalConductance ( double  value)

Set the thermal conductance (W/m^2*K).

Attribute name: 'thermalConductance'

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

Set the thermal conductivity (W/m*K).

Attribute name: 'thermalConductivity'

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

Set the thermal reflectance (dimensionless fraction).

Attribute name: 'thermalReflectance'

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

Set the thermal resistance (m^2*K/W).

Attribute name: 'thermalResistance'

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

Set the thermal resistivity (m*K/W).

Attribute name: 'thermalResistivity'

bool openstudio::model::StandardOpaqueMaterial::setThickness ( double  thickness)
bool openstudio::model::StandardOpaqueMaterial::setVisibleAbsorptance ( boost::optional< double >  value)

Set the visible absorptance (dimensionless fraction).

Attribute name: 'visibleAbsorptance'

bool openstudio::model::StandardOpaqueMaterial::setVisibleAbsorptance ( double  visibleAbsorptance)
bool openstudio::model::StandardOpaqueMaterial::setVisibleReflectance ( boost::optional< double >  value)

Set the visible reflectance (dimensionless fraction).

Attribute name: 'visibleReflectance'

double openstudio::model::StandardOpaqueMaterial::solarAbsorptance ( ) const
boost::optional<double> openstudio::model::StandardOpaqueMaterial::solarReflectance ( ) const

Solar reflectance of the OpaqueMaterial (dimensionless fraction).

Attribute name: 'solarReflectance'

double openstudio::model::StandardOpaqueMaterial::specificHeat ( ) const
double openstudio::model::StandardOpaqueMaterial::thermalAbsorptance ( ) const
double openstudio::model::StandardOpaqueMaterial::thermalConductance ( ) const

Thermal conductance of the OpaqueMaterial in W/m^2*K.

Throws openstudio::Exception if unavailable.

Attribute name: 'thermalConductance'

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

Thermal conductivity of the OpaqueMaterial in W/m*K.

Throws openstudio::Exception if unavailable.

Attribute name: 'thermalConductivity'

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

Thermal reflectance of the OpaqueMaterial (dimensionless fraction).

Attribute name: 'thermalReflectance'

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

Thermal resistance of the OpaqueMaterial in m^2*K/W.

Throws openstudio::Exception if unavailable.

Attribute name: 'thermalResistance'.

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

Thermal resistivity of the OpaqueMaterial in m*K/W.

Throws openstudio::Exception if unavailable.

Attribute name: 'thermalResistivity'.

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

Visible reflectance of the OpaqueMaterial (dimensionless fraction).

Attribute name: 'visibleReflectance'

Friends And Related Function Documentation

typedef boost::optional<StandardOpaqueMaterial> OptionalStandardOpaqueMaterial
related