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

#include <OpaqueMaterial.hpp>

+ Inheritance diagram for openstudio::model::OpaqueMaterial:

Public Member Functions

Constructors and Destructors
virtual ~OpaqueMaterial ()
 
Getters
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...
 
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 (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...
 
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::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
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< OpaqueMaterial
OpaqueMaterialVector
 
typedef boost::optional
< OpaqueMaterial
OptionalOpaqueMaterial
 

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

OpaqueMaterial is a Material that serves as a base class for all LayeredConstructions for which isOpaque.

OpaqueMaterial also defines a number of virtually implemented attributes.

Constructor & Destructor Documentation

virtual openstudio::model::OpaqueMaterial::~OpaqueMaterial ( )
inlinevirtual

Member Function Documentation

boost::optional<double> openstudio::model::OpaqueMaterial::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'

bool openstudio::model::OpaqueMaterial::setSolarAbsorptance ( boost::optional< double >  value)

Set the solar absorptance (dimensionless fraction).

Attribute name: 'solarAbsorptance'

bool openstudio::model::OpaqueMaterial::setSolarReflectance ( boost::optional< double >  value)

Set the solar reflectance (dimensionless fraction).

Attribute name: 'solarReflectance'

bool openstudio::model::OpaqueMaterial::setThermalAbsorptance ( double  value)

Set the thermal absorptance (dimensionless fraction).

Attribute name: 'thermalAbsorptance'

bool openstudio::model::OpaqueMaterial::setThermalConductance ( double  value)

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

Attribute name: 'thermalConductance'

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

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

Attribute name: 'thermalConductivity'

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

Set the thermal reflectance (dimensionless fraction).

Attribute name: 'thermalReflectance'

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

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

Attribute name: 'thermalResistance'

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

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

Attribute name: 'thermalResistivity'

bool openstudio::model::OpaqueMaterial::setVisibleAbsorptance ( boost::optional< double >  value)

Set the visible absorptance (dimensionless fraction).

Attribute name: 'visibleAbsorptance'

bool openstudio::model::OpaqueMaterial::setVisibleReflectance ( boost::optional< double >  value)

Set the visible reflectance (dimensionless fraction).

Attribute name: 'visibleReflectance'

double openstudio::model::OpaqueMaterial::solarAbsorptance ( ) const

Solar absorptance of the Material (dimensionless fraction).

Attribute name: 'solarAbsorptance'

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

Solar reflectance of the Material (dimensionless fraction).

Attribute name: 'solarReflectance'

double openstudio::model::OpaqueMaterial::thermalAbsorptance ( ) const

Thermal absorptance of the Material (dimensionless fraction).

Attribute name: 'thermalAbsorptance'

double openstudio::model::OpaqueMaterial::thermalConductance ( ) const

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

Throws openstudio::Exception if unavailable.

Attribute name: 'thermalConductance'

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

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

Throws openstudio::Exception if unavailable.

Attribute name: 'thermalConductivity'

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

Thermal reflectance of the Material (dimensionless fraction).

Attribute name: 'thermalReflectance'

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

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

Throws openstudio::Exception if unavailable.

Attribute name: 'thermalResistance'.

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

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

Throws openstudio::Exception if unavailable.

Attribute name: 'thermalResistivity'.

double openstudio::model::OpaqueMaterial::visibleAbsorptance ( ) const

Visible absorptance of the Material (dimensionless fraction).

Attribute name: 'visibleAbsorptance'

boost::optional<double> openstudio::model::OpaqueMaterial::visibleReflectance ( ) const

Visible reflectance of the Material (dimensionless fraction).

Attribute name: 'visibleReflectance'

Friends And Related Function Documentation

typedef std::vector<OpaqueMaterial> OpaqueMaterialVector
related
typedef boost::optional<OpaqueMaterial> OptionalOpaqueMaterial
related