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

#include <GeneratorFuelCellPowerModule.hpp>

+ Inheritance diagram for openstudio::model::GeneratorFuelCellPowerModule:

Public Member Functions

Constructors and Destructors
 GeneratorFuelCellPowerModule (const Model &model, const ThermalZone &heatlossZone, const Node &dilutionInletAirNode, const Node &dilutionOutletAirNode)
 
 GeneratorFuelCellPowerModule (const Model &model, const CurveQuadratic &efficiencyCurve, const ThermalZone &heatlossZone, const Node &dilutionInletAirNode, const Node &dilutionOutletAirNode)
 
 GeneratorFuelCellPowerModule (const Model &model, const CurveQuadratic &efficiencyCurve, const ThermalZone &heatlossZone, const Node &dilutionInletAirNode, const Node &dilutionOutletAirNode, const CurveQuadratic &skinlossCurve)
 
 GeneratorFuelCellPowerModule (const Model &model, const CurveQuadratic &efficiencyCurve)
 
 GeneratorFuelCellPowerModule (const Model &model)
 
virtual ~GeneratorFuelCellPowerModule ()
 
Getters
std::string efficiencyCurveMode () const
 
CurveQuadratic efficiencyCurve () const
 
double nominalEfficiency () const
 
double nominalElectricalPower () const
 
double numberofStopsatStartofSimulation () const
 
double cyclingPerformanceDegradationCoefficient () const
 
double numberofRunHoursatBeginningofSimulation () const
 
double accumulatedRunTimeDegradationCoefficient () const
 
double runTimeDegradationInitiationTimeThreshold () const
 
double powerUpTransientLimit () const
 
double powerDownTransientLimit () const
 
double startUpTime () const
 
double startUpFuel () const
 
double startUpElectricityConsumption () const
 
double startUpElectricityProduced () const
 
double shutDownTime () const
 
double shutDownFuel () const
 
double shutDownElectricityConsumption () const
 
double ancillaryElectricityConstantTerm () const
 
double ancillaryElectricityLinearTerm () const
 
std::string skinLossCalculationMode () const
 
boost::optional< ThermalZonezone () const
 
double skinLossRadiativeFraction () const
 
double constantSkinLossRate () const
 
double skinLossUFactorTimesAreaTerm () const
 
boost::optional< CurveQuadraticskinLossQuadraticCurve () const
 
double dilutionAirFlowRate () const
 
double stackHeatlosstoDilutionAir () const
 
boost::optional< NodedilutionInletAirNode () const
 
boost::optional< NodedilutionOutletAirNode () const
 
double minimumOperatingPoint () const
 
double maximumOperatingPoint () const
 
boost::optional
< GeneratorFuelCell
fuelCell () const
 
Setters
bool setEfficiencyCurveMode (const std::string &efficiencyCurveMode)
 
void resetEfficiencyCurveMode ()
 
bool setEfficiencyCurve (const CurveQuadratic &quadraticCurve)
 
bool setNominalEfficiency (double nominalEfficiency)
 
void resetNominalEfficiency ()
 
bool setNominalElectricalPower (double nominalElectricalPower)
 
void resetNominalElectricalPower ()
 
bool setNumberofStopsatStartofSimulation (double numberofStopsatStartofSimulation)
 
void resetNumberofStopsatStartofSimulation ()
 
bool setCyclingPerformanceDegradationCoefficient (double cyclingPerformanceDegradationCoefficient)
 
void resetCyclingPerformanceDegradationCoefficient ()
 
bool setNumberofRunHoursatBeginningofSimulation (double numberofRunHoursatBeginningofSimulation)
 
void resetNumberofRunHoursatBeginningofSimulation ()
 
bool setAccumulatedRunTimeDegradationCoefficient (double accumulatedRunTimeDegradationCoefficient)
 
void resetAccumulatedRunTimeDegradationCoefficient ()
 
bool setRunTimeDegradationInitiationTimeThreshold (double runTimeDegradationInitiationTimeThreshold)
 
void resetRunTimeDegradationInitiationTimeThreshold ()
 
bool setPowerUpTransientLimit (double powerUpTransientLimit)
 
void resetPowerUpTransientLimit ()
 
bool setPowerDownTransientLimit (double powerDownTransientLimit)
 
void resetPowerDownTransientLimit ()
 
bool setStartUpTime (double startUpTime)
 
void resetStartUpTime ()
 
bool setStartUpFuel (double startUpFuel)
 
void resetStartUpFuel ()
 
bool setStartUpElectricityConsumption (double startUpElectricityConsumption)
 
void resetStartUpElectricityConsumption ()
 
bool setStartUpElectricityProduced (double startUpElectricityProduced)
 
void resetStartUpElectricityProduced ()
 
bool setShutDownTime (double shutDownTime)
 
void resetShutDownTime ()
 
bool setShutDownFuel (double shutDownFuel)
 
void resetShutDownFuel ()
 
bool setShutDownElectricityConsumption (double shutDownElectricityConsumption)
 
void resetShutDownElectricityConsumption ()
 
bool setAncillaryElectricityConstantTerm (double ancillaryElectricityConstantTerm)
 
void resetAncillaryElectricityConstantTerm ()
 
bool setAncillaryElectricityLinearTerm (double ancillaryElectricityLinearTerm)
 
void resetAncillaryElectricityLinearTerm ()
 
bool setSkinLossCalculationMode (const std::string &skinLossCalculationMode)
 
void resetSkinLossCalculationMode ()
 
bool setZone (const ThermalZone &zone)
 
void resetZone ()
 
bool setSkinLossRadiativeFraction (double skinLossRadiativeFraction)
 
void resetSkinLossRadiativeFraction ()
 
bool setConstantSkinLossRate (double constantSkinLossRate)
 
void resetConstantSkinLossRate ()
 
bool setSkinLossUFactorTimesAreaTerm (double skinLossUFactorTimesAreaTerm)
 
void resetSkinLossUFactorTimesAreaTerm ()
 
bool setSkinLossQuadraticCurve (const CurveQuadratic &quadraticCurves)
 
void resetSkinLossQuadraticCurve ()
 
bool setDilutionAirFlowRate (double dilutionAirFlowRate)
 
void resetDilutionAirFlowRate ()
 
bool setStackHeatlosstoDilutionAir (double stackHeatlosstoDilutionAir)
 
void resetStackHeatlosstoDilutionAir ()
 
bool setDilutionInletAirNode (const Node &connection)
 
void resetDilutionInletAirNode ()
 
bool setDilutionOutletAirNode (const Node &connection)
 
void resetDilutionOutletAirNode ()
 
bool setMinimumOperatingPoint (double minimumOperatingPoint)
 
void resetMinimumOperatingPoint ()
 
bool setMaximumOperatingPoint (double maximumOperatingPoint)
 
void resetMaximumOperatingPoint ()
 
- 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
 

Static Public Member Functions

static std::vector< std::string > efficiencyCurveModeValues ()
 
static IddObjectType iddObjectType ()
 
static std::vector< std::string > skinLossCalculationModeValues ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< GeneratorFuelCellPowerModule
GeneratorFuelCellPowerModuleVector
 
typedef boost::optional
< GeneratorFuelCellPowerModule
OptionalGeneratorFuelCellPowerModule
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- 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

GeneratorFuelCellPowerModule is a ModelObject that wraps the OpenStudio IDD object 'OS:Generator:FuelCell:PowerModule'.

Constructor & Destructor Documentation

openstudio::model::GeneratorFuelCellPowerModule::GeneratorFuelCellPowerModule ( const Model model,
const ThermalZone heatlossZone,
const Node dilutionInletAirNode,
const Node dilutionOutletAirNode 
)
explicit
openstudio::model::GeneratorFuelCellPowerModule::GeneratorFuelCellPowerModule ( const Model model,
const CurveQuadratic efficiencyCurve,
const ThermalZone heatlossZone,
const Node dilutionInletAirNode,
const Node dilutionOutletAirNode 
)
explicit
openstudio::model::GeneratorFuelCellPowerModule::GeneratorFuelCellPowerModule ( const Model model,
const CurveQuadratic efficiencyCurve,
const ThermalZone heatlossZone,
const Node dilutionInletAirNode,
const Node dilutionOutletAirNode,
const CurveQuadratic skinlossCurve 
)
explicit
openstudio::model::GeneratorFuelCellPowerModule::GeneratorFuelCellPowerModule ( const Model model,
const CurveQuadratic efficiencyCurve 
)
explicit
openstudio::model::GeneratorFuelCellPowerModule::GeneratorFuelCellPowerModule ( const Model model)
explicit
virtual openstudio::model::GeneratorFuelCellPowerModule::~GeneratorFuelCellPowerModule ( )
inlinevirtual

Member Function Documentation

double openstudio::model::GeneratorFuelCellPowerModule::accumulatedRunTimeDegradationCoefficient ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::ancillaryElectricityConstantTerm ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::ancillaryElectricityLinearTerm ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::constantSkinLossRate ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::cyclingPerformanceDegradationCoefficient ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::dilutionAirFlowRate ( ) const
boost::optional<Node> openstudio::model::GeneratorFuelCellPowerModule::dilutionInletAirNode ( ) const
boost::optional<Node> openstudio::model::GeneratorFuelCellPowerModule::dilutionOutletAirNode ( ) const
CurveQuadratic openstudio::model::GeneratorFuelCellPowerModule::efficiencyCurve ( ) const
std::string openstudio::model::GeneratorFuelCellPowerModule::efficiencyCurveMode ( ) const
static std::vector<std::string> openstudio::model::GeneratorFuelCellPowerModule::efficiencyCurveModeValues ( )
static
boost::optional<GeneratorFuelCell> openstudio::model::GeneratorFuelCellPowerModule::fuelCell ( ) const
static IddObjectType openstudio::model::GeneratorFuelCellPowerModule::iddObjectType ( )
static
double openstudio::model::GeneratorFuelCellPowerModule::maximumOperatingPoint ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::minimumOperatingPoint ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::nominalEfficiency ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::nominalElectricalPower ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::numberofRunHoursatBeginningofSimulation ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::numberofStopsatStartofSimulation ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::powerDownTransientLimit ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::powerUpTransientLimit ( ) const
void openstudio::model::GeneratorFuelCellPowerModule::resetAccumulatedRunTimeDegradationCoefficient ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetAncillaryElectricityConstantTerm ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetAncillaryElectricityLinearTerm ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetConstantSkinLossRate ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetCyclingPerformanceDegradationCoefficient ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetDilutionAirFlowRate ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetDilutionInletAirNode ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetDilutionOutletAirNode ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetEfficiencyCurveMode ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetMaximumOperatingPoint ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetMinimumOperatingPoint ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetNominalEfficiency ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetNominalElectricalPower ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetNumberofRunHoursatBeginningofSimulation ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetNumberofStopsatStartofSimulation ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetPowerDownTransientLimit ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetPowerUpTransientLimit ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetRunTimeDegradationInitiationTimeThreshold ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetShutDownElectricityConsumption ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetShutDownFuel ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetShutDownTime ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetSkinLossCalculationMode ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetSkinLossQuadraticCurve ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetSkinLossRadiativeFraction ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetSkinLossUFactorTimesAreaTerm ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetStackHeatlosstoDilutionAir ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetStartUpElectricityConsumption ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetStartUpElectricityProduced ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetStartUpFuel ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetStartUpTime ( )
void openstudio::model::GeneratorFuelCellPowerModule::resetZone ( )
double openstudio::model::GeneratorFuelCellPowerModule::runTimeDegradationInitiationTimeThreshold ( ) const
bool openstudio::model::GeneratorFuelCellPowerModule::setAccumulatedRunTimeDegradationCoefficient ( double  accumulatedRunTimeDegradationCoefficient)
bool openstudio::model::GeneratorFuelCellPowerModule::setAncillaryElectricityConstantTerm ( double  ancillaryElectricityConstantTerm)
bool openstudio::model::GeneratorFuelCellPowerModule::setAncillaryElectricityLinearTerm ( double  ancillaryElectricityLinearTerm)
bool openstudio::model::GeneratorFuelCellPowerModule::setConstantSkinLossRate ( double  constantSkinLossRate)
bool openstudio::model::GeneratorFuelCellPowerModule::setCyclingPerformanceDegradationCoefficient ( double  cyclingPerformanceDegradationCoefficient)
bool openstudio::model::GeneratorFuelCellPowerModule::setDilutionAirFlowRate ( double  dilutionAirFlowRate)
bool openstudio::model::GeneratorFuelCellPowerModule::setDilutionInletAirNode ( const Node connection)
bool openstudio::model::GeneratorFuelCellPowerModule::setDilutionOutletAirNode ( const Node connection)
bool openstudio::model::GeneratorFuelCellPowerModule::setEfficiencyCurve ( const CurveQuadratic quadraticCurve)
bool openstudio::model::GeneratorFuelCellPowerModule::setEfficiencyCurveMode ( const std::string &  efficiencyCurveMode)
bool openstudio::model::GeneratorFuelCellPowerModule::setMaximumOperatingPoint ( double  maximumOperatingPoint)
bool openstudio::model::GeneratorFuelCellPowerModule::setMinimumOperatingPoint ( double  minimumOperatingPoint)
bool openstudio::model::GeneratorFuelCellPowerModule::setNominalEfficiency ( double  nominalEfficiency)
bool openstudio::model::GeneratorFuelCellPowerModule::setNominalElectricalPower ( double  nominalElectricalPower)
bool openstudio::model::GeneratorFuelCellPowerModule::setNumberofRunHoursatBeginningofSimulation ( double  numberofRunHoursatBeginningofSimulation)
bool openstudio::model::GeneratorFuelCellPowerModule::setNumberofStopsatStartofSimulation ( double  numberofStopsatStartofSimulation)
bool openstudio::model::GeneratorFuelCellPowerModule::setPowerDownTransientLimit ( double  powerDownTransientLimit)
bool openstudio::model::GeneratorFuelCellPowerModule::setPowerUpTransientLimit ( double  powerUpTransientLimit)
bool openstudio::model::GeneratorFuelCellPowerModule::setRunTimeDegradationInitiationTimeThreshold ( double  runTimeDegradationInitiationTimeThreshold)
bool openstudio::model::GeneratorFuelCellPowerModule::setShutDownElectricityConsumption ( double  shutDownElectricityConsumption)
bool openstudio::model::GeneratorFuelCellPowerModule::setShutDownFuel ( double  shutDownFuel)
bool openstudio::model::GeneratorFuelCellPowerModule::setShutDownTime ( double  shutDownTime)
bool openstudio::model::GeneratorFuelCellPowerModule::setSkinLossCalculationMode ( const std::string &  skinLossCalculationMode)
bool openstudio::model::GeneratorFuelCellPowerModule::setSkinLossQuadraticCurve ( const CurveQuadratic quadraticCurves)
bool openstudio::model::GeneratorFuelCellPowerModule::setSkinLossRadiativeFraction ( double  skinLossRadiativeFraction)
bool openstudio::model::GeneratorFuelCellPowerModule::setSkinLossUFactorTimesAreaTerm ( double  skinLossUFactorTimesAreaTerm)
bool openstudio::model::GeneratorFuelCellPowerModule::setStackHeatlosstoDilutionAir ( double  stackHeatlosstoDilutionAir)
bool openstudio::model::GeneratorFuelCellPowerModule::setStartUpElectricityConsumption ( double  startUpElectricityConsumption)
bool openstudio::model::GeneratorFuelCellPowerModule::setStartUpElectricityProduced ( double  startUpElectricityProduced)
bool openstudio::model::GeneratorFuelCellPowerModule::setStartUpFuel ( double  startUpFuel)
bool openstudio::model::GeneratorFuelCellPowerModule::setStartUpTime ( double  startUpTime)
bool openstudio::model::GeneratorFuelCellPowerModule::setZone ( const ThermalZone zone)
double openstudio::model::GeneratorFuelCellPowerModule::shutDownElectricityConsumption ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::shutDownFuel ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::shutDownTime ( ) const
std::string openstudio::model::GeneratorFuelCellPowerModule::skinLossCalculationMode ( ) const
static std::vector<std::string> openstudio::model::GeneratorFuelCellPowerModule::skinLossCalculationModeValues ( )
static
boost::optional<CurveQuadratic> openstudio::model::GeneratorFuelCellPowerModule::skinLossQuadraticCurve ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::skinLossRadiativeFraction ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::skinLossUFactorTimesAreaTerm ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::stackHeatlosstoDilutionAir ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::startUpElectricityConsumption ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::startUpElectricityProduced ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::startUpFuel ( ) const
double openstudio::model::GeneratorFuelCellPowerModule::startUpTime ( ) const
boost::optional<ThermalZone> openstudio::model::GeneratorFuelCellPowerModule::zone ( ) const

Friends And Related Function Documentation