OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "FoundationKivaSettings.hpp"

Inheritance diagram for openstudio::model::FoundationKivaSettings:

Public Member Functions

virtual ~FoundationKivaSettings ()=default
 FoundationKivaSettings (const FoundationKivaSettings &other)=default
 FoundationKivaSettings (FoundationKivaSettings &&other)=default
FoundationKivaSettingsoperator= (const FoundationKivaSettings &)=default
FoundationKivaSettingsoperator= (FoundationKivaSettings &&)=default
double soilConductivity () const
bool isSoilConductivityDefaulted () const
double soilDensity () const
bool isSoilDensityDefaulted () const
double soilSpecificHeat () const
bool isSoilSpecificHeatDefaulted () const
double groundSolarAbsorptivity () const
bool isGroundSolarAbsorptivityDefaulted () const
double groundThermalAbsorptivity () const
bool isGroundThermalAbsorptivityDefaulted () const
double groundSurfaceRoughness () const
bool isGroundSurfaceRoughnessDefaulted () const
double farFieldWidth () const
bool isFarFieldWidthDefaulted () const
std::string deepGroundBoundaryCondition () const
bool isDeepGroundBoundaryConditionAutoselected ()
boost::optional< double > deepGroundDepth ()
bool isDeepGroundDepthAutocalculated ()
double minimumCellDimension () const
bool isMinimumCellDimensionDefaulted () const
double maximumCellGrowthCoefficient () const
bool isMaximumCellGrowthCoefficientDefaulted () const
std::string simulationTimestep () const
bool isSimulationTimestepDefaulted () const
bool setSoilConductivity (double soilConductivity)
void resetSoilConductivity ()
bool setSoilDensity (double soilDensity)
void resetSoilDensity ()
bool setSoilSpecificHeat (double soilSpecificHeat)
void resetSoilSpecificHeat ()
bool setGroundSolarAbsorptivity (double groundSolarAbsorptivity)
void resetGroundSolarAbsorptivity ()
bool setGroundThermalAbsorptivity (double groundThermalAbsorptivity)
void resetGroundThermalAbsorptivity ()
bool setGroundSurfaceRoughness (double groundSurfaceRoughness)
void resetGroundSurfaceRoughness ()
bool setFarFieldWidth (double farFieldWidth)
void resetFarFieldWidth ()
bool setDeepGroundBoundaryCondition (const std::string &deepGroundBoundaryCondition)
void resetDeepGroundBoundaryCondition ()
bool setDeepGroundDepth (double deepGroundDepth)
void autocalculateDeepGroundDepth ()
bool setMinimumCellDimension (double minimumCellDimension)
void resetMinimumCellDimension ()
bool setMaximumCellGrowthCoefficient (double maximumCellGrowthCoefficient)
void resetMaximumCellGrowthCoefficient ()
bool setSimulationTimestep (const std::string &simulationTimestep)
void resetSimulationTimestep ()

Static Public Member Functions

static IddObjectType iddObjectType ()

Protected Member Functions

 FoundationKivaSettings (Model &model)

Related Functions

using FoundationKivaSettingsVector = std::vector< FoundationKivaSettings >
using OptionalFoundationKivaSettings = boost::optional< FoundationKivaSettings >

Detailed Description

FoundationKivaSettings is a ModelObject that wraps the OpenStudio IDD object 'OS:Foundation:Kiva:Settings'.

Constructor & Destructor Documentation

virtual openstudio::model::FoundationKivaSettings::~FoundationKivaSettings ( )
virtualdefault
openstudio::model::FoundationKivaSettings::FoundationKivaSettings ( const FoundationKivaSettings other)
default
openstudio::model::FoundationKivaSettings::FoundationKivaSettings ( FoundationKivaSettings &&  other)
default
openstudio::model::FoundationKivaSettings::FoundationKivaSettings ( Model model)
explicitprotected

Member Function Documentation

void openstudio::model::FoundationKivaSettings::autocalculateDeepGroundDepth ( )
std::string openstudio::model::FoundationKivaSettings::deepGroundBoundaryCondition ( ) const
boost::optional<double> openstudio::model::FoundationKivaSettings::deepGroundDepth ( )
double openstudio::model::FoundationKivaSettings::farFieldWidth ( ) const
double openstudio::model::FoundationKivaSettings::groundSolarAbsorptivity ( ) const
double openstudio::model::FoundationKivaSettings::groundSurfaceRoughness ( ) const
double openstudio::model::FoundationKivaSettings::groundThermalAbsorptivity ( ) const
static IddObjectType openstudio::model::FoundationKivaSettings::iddObjectType ( )
static
bool openstudio::model::FoundationKivaSettings::isDeepGroundBoundaryConditionAutoselected ( )
bool openstudio::model::FoundationKivaSettings::isDeepGroundDepthAutocalculated ( )
bool openstudio::model::FoundationKivaSettings::isFarFieldWidthDefaulted ( ) const
bool openstudio::model::FoundationKivaSettings::isGroundSolarAbsorptivityDefaulted ( ) const
bool openstudio::model::FoundationKivaSettings::isGroundSurfaceRoughnessDefaulted ( ) const
bool openstudio::model::FoundationKivaSettings::isGroundThermalAbsorptivityDefaulted ( ) const
bool openstudio::model::FoundationKivaSettings::isMaximumCellGrowthCoefficientDefaulted ( ) const
bool openstudio::model::FoundationKivaSettings::isMinimumCellDimensionDefaulted ( ) const
bool openstudio::model::FoundationKivaSettings::isSimulationTimestepDefaulted ( ) const
bool openstudio::model::FoundationKivaSettings::isSoilConductivityDefaulted ( ) const
bool openstudio::model::FoundationKivaSettings::isSoilDensityDefaulted ( ) const
bool openstudio::model::FoundationKivaSettings::isSoilSpecificHeatDefaulted ( ) const
double openstudio::model::FoundationKivaSettings::maximumCellGrowthCoefficient ( ) const
double openstudio::model::FoundationKivaSettings::minimumCellDimension ( ) const
FoundationKivaSettings& openstudio::model::FoundationKivaSettings::operator= ( const FoundationKivaSettings )
default
FoundationKivaSettings& openstudio::model::FoundationKivaSettings::operator= ( FoundationKivaSettings &&  )
default
void openstudio::model::FoundationKivaSettings::resetDeepGroundBoundaryCondition ( )
void openstudio::model::FoundationKivaSettings::resetFarFieldWidth ( )
void openstudio::model::FoundationKivaSettings::resetGroundSolarAbsorptivity ( )
void openstudio::model::FoundationKivaSettings::resetGroundSurfaceRoughness ( )
void openstudio::model::FoundationKivaSettings::resetGroundThermalAbsorptivity ( )
void openstudio::model::FoundationKivaSettings::resetMaximumCellGrowthCoefficient ( )
void openstudio::model::FoundationKivaSettings::resetMinimumCellDimension ( )
void openstudio::model::FoundationKivaSettings::resetSimulationTimestep ( )
void openstudio::model::FoundationKivaSettings::resetSoilConductivity ( )
void openstudio::model::FoundationKivaSettings::resetSoilDensity ( )
void openstudio::model::FoundationKivaSettings::resetSoilSpecificHeat ( )
bool openstudio::model::FoundationKivaSettings::setDeepGroundBoundaryCondition ( const std::string &  deepGroundBoundaryCondition)
bool openstudio::model::FoundationKivaSettings::setDeepGroundDepth ( double  deepGroundDepth)
bool openstudio::model::FoundationKivaSettings::setFarFieldWidth ( double  farFieldWidth)
bool openstudio::model::FoundationKivaSettings::setGroundSolarAbsorptivity ( double  groundSolarAbsorptivity)
bool openstudio::model::FoundationKivaSettings::setGroundSurfaceRoughness ( double  groundSurfaceRoughness)
bool openstudio::model::FoundationKivaSettings::setGroundThermalAbsorptivity ( double  groundThermalAbsorptivity)
bool openstudio::model::FoundationKivaSettings::setMaximumCellGrowthCoefficient ( double  maximumCellGrowthCoefficient)
bool openstudio::model::FoundationKivaSettings::setMinimumCellDimension ( double  minimumCellDimension)
bool openstudio::model::FoundationKivaSettings::setSimulationTimestep ( const std::string &  simulationTimestep)
bool openstudio::model::FoundationKivaSettings::setSoilConductivity ( double  soilConductivity)
bool openstudio::model::FoundationKivaSettings::setSoilDensity ( double  soilDensity)
bool openstudio::model::FoundationKivaSettings::setSoilSpecificHeat ( double  soilSpecificHeat)
std::string openstudio::model::FoundationKivaSettings::simulationTimestep ( ) const
double openstudio::model::FoundationKivaSettings::soilConductivity ( ) const
double openstudio::model::FoundationKivaSettings::soilDensity ( ) const
double openstudio::model::FoundationKivaSettings::soilSpecificHeat ( ) const

Friends And Related Function Documentation

using OptionalFoundationKivaSettings = boost::optional<FoundationKivaSettings>
related