#include <FoundationKivaSettings.hpp>
Public Member Functions | |
Constructors and Destructors | |
virtual | ~FoundationKivaSettings () |
Getters | |
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 |
Setters | |
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 (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 (std::string simulationTimestep) |
void | resetSimulationTimestep () |
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< ParentObject > | parent () const |
Return this object's parent in the hierarchy, if it has one. More... | |
std::vector< ResourceObject > | resources () 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< OutputVariable > | outputVariables () 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< LifeCycleCost > | lifeCycleCosts () 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< ScheduleTypeKey > | getScheduleTypeKeys (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< ModelObject > | connectedObject (unsigned port) const |
boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
static IddObjectType | iddObjectType () |
Protected Member Functions | |
FoundationKivaSettings (Model &model) | |
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) | |
Related Functions | |
(Note that these are not member functions.) | |
typedef std::vector < FoundationKivaSettings > | FoundationKivaSettingsVector |
typedef boost::optional < FoundationKivaSettings > | OptionalFoundationKivaSettings |
Related Functions inherited from openstudio::model::ModelObject | |
std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
Additional Inherited Members | |
Protected Types inherited from openstudio::model::ModelObject | |
typedef detail::ModelObject_Impl | ImplType |
FoundationKivaSettings is a ModelObject that wraps the OpenStudio IDD object 'OS:Foundation:Kiva:Settings'.
|
inlinevirtual |
|
explicitprotected |
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 |
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 |
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 | ( | 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 | ( | 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 |
|
related |
|
related |