openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery Class Reference

#include <ElectricLoadCenterStorageLiIonNMCBattery.hpp>

Inheritance diagram for openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery:

Public Member Functions
Constructors and Destructors
	ElectricLoadCenterStorageLiIonNMCBattery (const Model &model)
	ElectricLoadCenterStorageLiIonNMCBattery (const Model &model, const int numberofCellsinSeries, const int numberofStringsinParallel, const double batteryMass, const double batterySurfaceArea)
virtual	~ElectricLoadCenterStorageLiIonNMCBattery ()
Getters
Schedule	availabilitySchedule () const
double	radiativeFraction () const
std::string	lifetimeModel () const
int	numberofCellsinSeries () const
int	numberofStringsinParallel () const
double	initialFractionalStateofCharge () const
double	dctoDCChargingEfficiency () const
double	batteryMass () const
double	batterySurfaceArea () const
double	batterySpecificHeatCapacity () const
double	heatTransferCoefficientBetweenBatteryandAmbient () const
double	fullyChargedCellVoltage () const
double	cellVoltageatEndofExponentialZone () const
double	cellVoltageatEndofNominalZone () const
double	defaultNominalCellVoltage () const
double	fullyChargedCellCapacity () const
double	fractionofCellCapacityRemovedattheEndofExponentialZone () const
double	fractionofCellCapacityRemovedattheEndofNominalZone () const
double	chargeRateatWhichVoltagevsCapacityCurveWasGenerated () const
double	batteryCellInternalElectricalResistance () const
Setters
bool	setAvailabilitySchedule (Schedule &schedule)
bool	setRadiativeFraction (double radiativeFraction)
bool	setLifetimeModel (const std::string &lifetimeModel)
bool	setNumberofCellsinSeries (int numberofCellsinSeries)
bool	setNumberofStringsinParallel (int numberofStringsinParallel)
bool	setInitialFractionalStateofCharge (double initialFractionalStateofCharge)
bool	setDCtoDCChargingEfficiency (double dctoDCChargingEfficiency)
bool	setBatteryMass (double batteryMass)
bool	setBatterySurfaceArea (double batterySurfaceArea)
bool	setBatterySpecificHeatCapacity (double batterySpecificHeatCapacity)
bool	setHeatTransferCoefficientBetweenBatteryandAmbient (double heatTransferCoefficientBetweenBatteryandAmbient)
bool	setFullyChargedCellVoltage (double fullyChargedCellCapacity)
bool	setCellVoltageatEndofExponentialZone (double cellVoltageatEndofExponentialZone)
bool	setCellVoltageatEndofNominalZone (double cellVoltageatEndofNominalZone)
bool	setDefaultNominalCellVoltage (double defaultNominalCellVoltage)
bool	setFullyChargedCellCapacity (double fullyChargedCellCapacity)
bool	setFractionofCellCapacityRemovedattheEndofExponentialZone (double fractionofCellCapacityRemovedattheEndofExponentialZone)
bool	setFractionofCellCapacityRemovedattheEndofNominalZone (double fractionofCellCapacityRemovedattheEndofNominalZone)
bool	setChargeRateatWhichVoltagevsCapacityCurveWasGenerated (double chargeRateatWhichVoltagevsCapacityCurveWasGenerated)
bool	setBatteryCellInternalElectricalResistance (double batteryCellInternalElectricalResistance)
Public Member Functions inherited from openstudio::model::ElectricalStorage
	ElectricalStorage (IddObjectType type, const Model &model)
boost::optional < ElectricLoadCenterDistribution >	electricLoadCenterDistribution () const
virtual void	resetThermalZone ()
virtual bool	setThermalZone (const ThermalZone &thermalZone)
virtual boost::optional < ThermalZone >	thermalZone () const
virtual	~ElectricalStorage ()
Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType >	allowableChildTypes () const
	Returns a vector of allowable children types. More...
std::vector< ModelObject >	children () const
	Return direct child objects in the Model. More...
virtual	~ParentObject ()
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...
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 ()
static std::vector< std::string >	lifetimeModelValues ()

Related Functions
(Note that these are not member functions.)
typedef std::vector < ElectricLoadCenterStorageLiIonNMCBattery >	ElectricLoadCenterStorageLiIonNMCBatteryVector
typedef boost::optional < ElectricLoadCenterStorageLiIonNMCBattery >	OptionalElectricLoadCenterStorageLiIonNMCBattery
Related Functions inherited from openstudio::model::ParentObject
std::vector< ModelObject >	getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true)
	Returns object and all other objects accessible by calling children() on encountered ParentObjects . More...
std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More...
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
Protected Member Functions inherited from openstudio::model::ParentObject
	ParentObject (IddObjectType type, const Model &model)
	Constructs a new ParentObject object in the model. More...
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

ElectricLoadCenterStorageLiIonNMCBattery is a ElectricalStorage that wraps the OpenStudio IDD object 'OS:ElectricLoadCenter:Storage:LiIonNMCBattery'.

Constructor & Destructor Documentation

openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::ElectricLoadCenterStorageLiIonNMCBattery ( const Model &  model )

explicit

openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::ElectricLoadCenterStorageLiIonNMCBattery ( const Model &  model, const int  numberofCellsinSeries, const int  numberofStringsinParallel, const double  batteryMass, const double  batterySurfaceArea  )

explicit

virtual openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::~ElectricLoadCenterStorageLiIonNMCBattery ( )

inlinevirtual

Member Function Documentation

Schedule openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::availabilitySchedule

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::batteryCellInternalElectricalResistance

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::batteryMass

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::batterySpecificHeatCapacity

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::batterySurfaceArea

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::cellVoltageatEndofExponentialZone

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::cellVoltageatEndofNominalZone

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::chargeRateatWhichVoltagevsCapacityCurveWasGenerated

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::dctoDCChargingEfficiency

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::defaultNominalCellVoltage

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::fractionofCellCapacityRemovedattheEndofExponentialZone

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::fractionofCellCapacityRemovedattheEndofNominalZone

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::fullyChargedCellCapacity

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::fullyChargedCellVoltage

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::heatTransferCoefficientBetweenBatteryandAmbient

(

)

const

static IddObjectType openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::iddObjectType ( )

static

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::initialFractionalStateofCharge

(

)

const

std::string openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::lifetimeModel

(

)

const

static std::vector<std::string> openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::lifetimeModelValues ( )

static

int openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::numberofCellsinSeries

(

)

const

int openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::numberofStringsinParallel

(

)

const

double openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::radiativeFraction

(

)

const

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setAvailabilitySchedule

(

Schedule &

schedule

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setBatteryCellInternalElectricalResistance

(

double

batteryCellInternalElectricalResistance

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setBatteryMass

(

double

batteryMass

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setBatterySpecificHeatCapacity

(

double

batterySpecificHeatCapacity

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setBatterySurfaceArea

(

double

batterySurfaceArea

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setCellVoltageatEndofExponentialZone

(

double

cellVoltageatEndofExponentialZone

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setCellVoltageatEndofNominalZone

(

double

cellVoltageatEndofNominalZone

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setChargeRateatWhichVoltagevsCapacityCurveWasGenerated

(

double

chargeRateatWhichVoltagevsCapacityCurveWasGenerated

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setDCtoDCChargingEfficiency

(

double

dctoDCChargingEfficiency

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setDefaultNominalCellVoltage

(

double

defaultNominalCellVoltage

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setFractionofCellCapacityRemovedattheEndofExponentialZone

(

double

fractionofCellCapacityRemovedattheEndofExponentialZone

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setFractionofCellCapacityRemovedattheEndofNominalZone

(

double

fractionofCellCapacityRemovedattheEndofNominalZone

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setFullyChargedCellCapacity

(

double

fullyChargedCellCapacity

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setFullyChargedCellVoltage

(

double

fullyChargedCellCapacity

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setHeatTransferCoefficientBetweenBatteryandAmbient

(

double

heatTransferCoefficientBetweenBatteryandAmbient

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setInitialFractionalStateofCharge

(

double

initialFractionalStateofCharge

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setLifetimeModel

(

const std::string &

lifetimeModel

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setNumberofCellsinSeries

(

int

numberofCellsinSeries

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setNumberofStringsinParallel

(

int

numberofStringsinParallel

)

bool openstudio::model::ElectricLoadCenterStorageLiIonNMCBattery::setRadiativeFraction

(

double

radiativeFraction

)

Friends And Related Function Documentation

typedef std::vector<ElectricLoadCenterStorageLiIonNMCBattery> ElectricLoadCenterStorageLiIonNMCBatteryVector

related

typedef boost::optional<ElectricLoadCenterStorageLiIonNMCBattery> OptionalElectricLoadCenterStorageLiIonNMCBattery

related