 |
OpenStudio:model |
|
OpenStudio:model |
#include "Surface.hpp"
Static Public Member Functions | |
| static IddObjectType | iddObjectType () |
| static std::vector< std::string > | validSurfaceTypeValues () |
| static std::vector< std::string > | validOutsideBoundaryConditionValues () |
| static std::vector< std::string > | validSunExposureValues () |
| static std::vector< std::string > | validWindExposureValues () |
Related Functions | |
| using | OptionalSurface = boost::optional< Surface > |
| using | SurfaceVector = std::vector< Surface > |
Surface is a PlanarSurface that wraps the OpenStudio IDD object 'OS_Surface'.
|
explicit |
|
overridevirtualdefault |
|
default |
|
default |
| boost::optional<FoundationKiva> openstudio::model::Surface::adjacentFoundation | ( | ) | const |
| boost::optional<Surface> openstudio::model::Surface::adjacentSurface | ( | ) | const |
Returns the adjacent Surface, if it exists.
| boost::optional<AirflowNetworkSurface> openstudio::model::Surface::airflowNetworkSurface | ( | ) | const |
| std::vector<SubSurface> openstudio::model::Surface::applyViewAndDaylightingGlassRatios | ( | double | viewGlassToWallRatio, |
| double | daylightingGlassToWallRatio, | ||
| double | desiredViewGlassSillHeight, | ||
| double | desiredDaylightingGlassHeaderHeight, | ||
| double | exteriorShadingProjectionFactor, | ||
| double | interiorShelfProjectionFactor, | ||
| const boost::optional< ConstructionBase > & | viewGlassConstruction, | ||
| const boost::optional< ConstructionBase > & | daylightingGlassConstruction | ||
| ) |
Applies banded view and daylighting windows to the surface with optional exterior shading and interior light shelf.
Assumes that this surface spans the entire height of the space, this method should not be used if the wall is broken into multiple vertical pieces.
Returns false if the surface is not a wall, if the surface is not rectangular in face coordinates, if requested ratio is too large (window area ~= surface area), or if surface has any doors.
Otherwise, removes all existing windows and adds new windows to meet requested ratio.
viewGlassToWallRatio - the ratio of view glass to wall area, if 0 no view glass will be created daylightingGlassToWallRatio - the ratio of daylighting glass to wall area, if 0 no daylighting glass will be created desiredViewGlassSillHeight - the desired distance from the floor to the bottom of the view glass, this may be reduced if the requested window area is too high desiredDaylightingGlassHeaderHeight - the distance from the ceiling to the top of the daylighting glass, this may be reduced if the requested window area is too high exteriorShadingProjectionFactor - projection factor of exterior shading applied to the view window, if 0 no exterior shading will be created interiorShelfProjectionFactor - projection factor of interior light shelf applied to the daylighting window, if 0 no interior light shelf will be created viewGlassConstruction - optional construction to use for the view glass daylightingGlassConstruction - optional construction to use for the daylighting glass
If successful returns a vector of sub surfaces created, view window will be the first in the vector if viewGlassToWallRatio > 0
| void openstudio::model::Surface::assignDefaultBoundaryCondition | ( | ) |
Assign default boundary condition.
| void openstudio::model::Surface::assignDefaultSunExposure | ( | ) |
Assign default sun exposure.
| void openstudio::model::Surface::assignDefaultSurfaceType | ( | ) |
Assign default surface type based on vertices.
| void openstudio::model::Surface::assignDefaultWindExposure | ( | ) |
Assign default wind exposure.
| void openstudio::model::Surface::autocalculateNumberofVertices | ( | ) |
| void openstudio::model::Surface::autocalculateViewFactortoGround | ( | ) |
| boost::optional<SurfaceIntersection> openstudio::model::Surface::computeIntersection | ( | Surface & | otherSurface | ) |
| boost::optional<Surface> openstudio::model::Surface::createAdjacentSurface | ( | const Space & | otherSpace | ) |
Creates an adjacent Surface in another Space, also create adjacent SubSurface objects if needed.
Returns the new Surface if created.
| std::vector<SubSurface> openstudio::model::Surface::createSubSurfaces | ( | const std::vector< std::vector< Point3d >> & | faces, |
| double | inset, | ||
| const boost::optional< ConstructionBase > & | construction | ||
| ) |
Moves all of the surfaces vertices towards the centroid by inset then intersects each face with the inset polygon.
Faces are in space coordinates, it is expected that not all faces will intersect the surface. Returns all new sub surfaces created, sub surface types are defaulted. Optional construction is applied. Returns false is this surface has any current sub surfaces or if there is an adjacent surface.
| boost::optional<SurfacePropertyExposedFoundationPerimeter> openstudio::model::Surface::createSurfacePropertyExposedFoundationPerimeter | ( | const std::string & | exposedPerimeterCalculationMethod, |
| double | exposedPerimeter | ||
| ) |
| double openstudio::model::Surface::exposedPerimeter | ( | const Polygon3d & | buildingPerimeter | ) | const |
| double openstudio::model::Surface::filmResistance | ( | ) | const |
Returns the default film thermal resistance (m^2*K/W) for this surface.
Assumes still indoor air, and 15 mph wind outside. Does not consider any custom SurfacePropertyConvectionCoefficients.
| AirflowNetworkSurface openstudio::model::Surface::getAirflowNetworkSurface | ( | const AirflowNetworkDetailedOpening & | surfaceAirflowLeakage | ) |
| AirflowNetworkSurface openstudio::model::Surface::getAirflowNetworkSurface | ( | const AirflowNetworkSimpleOpening & | surfaceAirflowLeakage | ) |
| AirflowNetworkSurface openstudio::model::Surface::getAirflowNetworkSurface | ( | const AirflowNetworkCrack & | surfaceAirflowLeakage | ) |
| AirflowNetworkSurface openstudio::model::Surface::getAirflowNetworkSurface | ( | const AirflowNetworkEffectiveLeakageArea & | surfaceAirflowLeakage | ) |
| AirflowNetworkSurface openstudio::model::Surface::getAirflowNetworkSurface | ( | const AirflowNetworkHorizontalOpening & | surfaceAirflowLeakage | ) |
| AirflowNetworkSurface openstudio::model::Surface::getAirflowNetworkSurface | ( | const AirflowNetworkSpecifiedFlowRate & | surfaceAirflowLeakage | ) |
|
static |
| bool openstudio::model::Surface::intersect | ( | Surface & | otherSurface | ) |
Intersect with other Surface in other Space.
Returns false if either surface has child windows. Returns false if either surface has an adjacent surface. Returns false if surfaces are not on the same plane with opposing outward normals. If the surfaces are the same, returns true but no new geometry is created. Returns true if an intersection occurred. Does not set surface adjacency.
| bool openstudio::model::Surface::isGroundSurface | ( | ) | const |
Returns true if the surface has outsideBoundaryCondition of Ground, GroundFCfactorMethod GroundSlabPreprocessorAverage, GroundSlabPreprocessorCore, GroundSlabPreprocessorPerimeter, GroundBasementPreprocessorAverageWall, GroundBasementPreprocessorAverageFloor, GroundBasementPreprocessorUpperWall, GroundBasementPreprocessorLowerWall, or Foundation.
| bool openstudio::model::Surface::isNumberofVerticesAutocalculated | ( | ) | const |
| bool openstudio::model::Surface::isNumberofVerticesDefaulted | ( | ) | const |
| bool openstudio::model::Surface::isPartOfEnvelope | ( | ) | const |
Returns true if the Surface is part of the building envelope.
| bool openstudio::model::Surface::isSunExposureDefaulted | ( | ) | const |
| bool openstudio::model::Surface::isViewFactortoGroundAutocalculated | ( | ) | const |
| bool openstudio::model::Surface::isViewFactortoGroundDefaulted | ( | ) | const |
| bool openstudio::model::Surface::isWindExposureDefaulted | ( | ) | const |
| boost::optional<double> openstudio::model::Surface::numberofVertices | ( | ) | const |
| std::string openstudio::model::Surface::outsideBoundaryCondition | ( | ) | const |
| void openstudio::model::Surface::resetAdjacentFoundation | ( | ) |
| void openstudio::model::Surface::resetAdjacentSurface | ( | ) |
Resets the adjacent Surface.
| void openstudio::model::Surface::resetNumberofVertices | ( | ) |
| void openstudio::model::Surface::resetSunExposure | ( | ) |
| void openstudio::model::Surface::resetSurfacePropertyExposedFoundationPerimeter | ( | ) |
| void openstudio::model::Surface::resetSurfacePropertyOtherSideCoefficients | ( | ) |
Resets the SurfacePropertyOtherSideCoefficients.
| void openstudio::model::Surface::resetSurfacePropertyOtherSideConditionsModel | ( | ) |
Resets the SurfacePropertyOtherSideConditionsModel.
| void openstudio::model::Surface::resetViewFactortoGround | ( | ) |
| void openstudio::model::Surface::resetWindExposure | ( | ) |
| bool openstudio::model::Surface::setAdjacentFoundation | ( | const FoundationKiva & | kiva | ) |
| bool openstudio::model::Surface::setAdjacentSurface | ( | Surface & | surface | ) |
Sets the adjacent Surface, will clear adjacent surface on other surface.
| bool openstudio::model::Surface::setNumberofVertices | ( | boost::optional< double > | numberofVertices | ) |
| bool openstudio::model::Surface::setNumberofVertices | ( | double | numberofVertices | ) |
| bool openstudio::model::Surface::setOutsideBoundaryCondition | ( | const std::string & | outsideBoundaryCondition | ) |
| bool openstudio::model::Surface::setSunExposure | ( | const std::string & | sunExposure | ) |
| bool openstudio::model::Surface::setSurfacePropertyOtherSideCoefficients | ( | const SurfacePropertyOtherSideCoefficients & | otherSideCoefficients | ) |
Sets the SurfacePropertyOtherSideCoefficients.
| bool openstudio::model::Surface::setSurfacePropertyOtherSideConditionsModel | ( | const SurfacePropertyOtherSideConditionsModel & | otherSideModel | ) |
Sets the SurfacePropertyOtherSideConditionsModel.
| bool openstudio::model::Surface::setSurfaceType | ( | const std::string & | surfaceType | ) |
| bool openstudio::model::Surface::setViewFactortoGround | ( | boost::optional< double > | viewFactortoGround | ) |
| bool openstudio::model::Surface::setViewFactortoGround | ( | double | viewFactortoGround | ) |
| bool openstudio::model::Surface::setWindExposure | ( | const std::string & | windExposure | ) |
| boost::optional<SubSurface> openstudio::model::Surface::setWindowToWallRatio | ( | double | wwr | ) |
Sets the window to wall ratio for this surface using a single banded window.
Uses applyViewAndDaylightingGlassRatios for implementation.
| boost::optional<SubSurface> openstudio::model::Surface::setWindowToWallRatio | ( | double | wwr, |
| double | desiredHeightOffset, | ||
| bool | heightOffsetFromFloor | ||
| ) |
Same as setWindowToWallRatio but with extra parameters desiredHeightOffset and heightOffsetFromFloor.
If heightOffsetFromFloor is true then desiredHeightOffset is the desired sill height, otherwise it is the offset from the ceiling. Uses applyViewAndDaylightingGlassRatios for implementation.
| std::vector<ShadingSurfaceGroup> openstudio::model::Surface::shadingSurfaceGroups | ( | ) | const |
Returns any shading surface groups associated with this surface.
| double openstudio::model::Surface::skylightToProjectedFloorRatio | ( | ) | const |
Get the skylight to projected floor ratio for this surface.
Calculated as sum(surface.skylights.netArea)/project(surface to z=0 plane).grossArea if this surface is a roof, returns 0 if this surface is not a roof.
| double openstudio::model::Surface::skylightToRoofRatio | ( | ) | const |
Get the skylight to roof ratio for this surface.
Calculated as sum(surface.skylights.netArea)/surface.grossArea if this surface is a roof, returns 0 if this surface is not a roof.
| std::vector<Surface> openstudio::model::Surface::splitSurfaceForSubSurfaces | ( | ) |
Splits this surface vertically surrounding any sub surfaces.
This surface must be a wall and must not have an adjacent surface. Returns any new surfaces created in this routine. Typically this is called on a surface that has doors but no windows before applying banded windows.
| std::vector<SubSurface> openstudio::model::Surface::subSurfaces | ( | ) | const |
Returns all child SubSurfaces .
| std::string openstudio::model::Surface::sunExposure | ( | ) | const |
| boost::optional<SurfaceControlMovableInsulation> openstudio::model::Surface::surfaceControlMovableInsulation | ( | ) | const |
Returns the SurfaceControlMovableInsulation, if it exists.
| boost::optional<SurfacePropertyConvectionCoefficients> openstudio::model::Surface::surfacePropertyConvectionCoefficients | ( | ) | const |
Returns the SurfacePropertyConvectionCoefficients, if it exists.
| boost::optional<SurfacePropertyExposedFoundationPerimeter> openstudio::model::Surface::surfacePropertyExposedFoundationPerimeter | ( | ) | const |
| boost::optional<SurfacePropertyLocalEnvironment> openstudio::model::Surface::surfacePropertyLocalEnvironment | ( | ) | const |
Returns the SurfacePropertyLocalEnvironment, if it exists.
| boost::optional<SurfacePropertyOtherSideCoefficients> openstudio::model::Surface::surfacePropertyOtherSideCoefficients | ( | ) | const |
Returns the adjacent SurfaceSurfacePropertyOtherSideCoefficients, if it exists.
| boost::optional<SurfacePropertyOtherSideConditionsModel> openstudio::model::Surface::surfacePropertyOtherSideConditionsModel | ( | ) | const |
Returns the adjacent SurfacePropertyOtherSideConditionsModel, if it exists.
| std::string openstudio::model::Surface::surfaceType | ( | ) | const |
|
static |
|
static |
|
static |
|
static |
| boost::optional<double> openstudio::model::Surface::viewFactortoGround | ( | ) | const |
| std::string openstudio::model::Surface::windExposure | ( | ) | const |
| double openstudio::model::Surface::windowToWallRatio | ( | ) | const |
Get the window to wall ratio for this surface.
Calculated as sum(surface.windows.netArea)/surface.grossArea if this surface is a wall, returns 0 if this surface is not a wall.
|
related |
|
related |
