OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
openstudio::model::FoundationKivaSettings Class Reference

#include <FoundationKivaSettings.hpp>

+ Inheritance diagram for openstudio::model::FoundationKivaSettings:

Public Member Functions

Constructors and Destructors
virtual ~FoundationKivaSettings ()=default
 
 FoundationKivaSettings (const FoundationKivaSettings &other)=default
 
 FoundationKivaSettings (FoundationKivaSettings &&other)=default
 
FoundationKivaSettingsoperator= (const FoundationKivaSettings &)=default
 
FoundationKivaSettingsoperator= (FoundationKivaSettings &&)=default
 
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 (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 ()
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
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< IdfObjectremoveLifeCycleCosts ()
 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< IdfObjectremoveAdditionalProperties ()
 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< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
 
boost::optional< double > getAutosizedValue (const std::string &valueName, const std::string &units) 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
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool isSource () const
 
bool isTarget () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
 WorkspaceObject (const WorkspaceObject &other)=default
 
 WorkspaceObject (WorkspaceObject &&other)=default
 
virtual ~WorkspaceObject ()=default
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector
< std::string > > 
clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
boost::optional< std::string > getField (unsigned index, bool returnDefault=false) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< intgetInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (IdfObject &&other) noexcept
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level, bool checkNames=false) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
IdfObjectoperator= (const IdfObject &other)
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
std::ostream & print (std::ostream &os) const
 
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
 
std::ostream & printName (std::ostream &os, bool hasFields=true) const
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
IdfExtensibleGroup pushExtensibleGroup ()
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=false) const
 
virtual ~IdfObject ()=default
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

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)
 
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)
 

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
OptionalWorkspaceObject
 
typedef std::vector
< WorkspaceObject
WorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
IdfObject
IdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- Protected Types inherited from openstudio::WorkspaceObject
typedef
detail::WorkspaceObject_Impl 
ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
 

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