EC Namespace Reference

Functions
double	getDriveLineEff (double &trainSpeed, int notchNumberIndex, double powerAtWheelProportion, TrainTypes::PowerType powerType, TrainTypes::LocomotivePowerMethod hybridMethod)
	Gets the drive line efficiency based on train speed, notch number index, power proportion at wheel, power type, and hybrid method.
double	getDCBusToTankEff (double powerAtWheelProportion, TrainTypes::PowerType powerType, TrainTypes::LocomotivePowerMethod hybridMethod)
	Gets the DC bus-to-tank efficiency based on power proportion at wheel, power type, and hybrid method.
double	getWheelToDCBusEff (double &trainSpeed)
	Gets the wheel-to-DC bus efficiency based on train speed.
double	getGeneratorEff (TrainTypes::PowerType powerType, double powerAtWheelProportion)
	Gets the generator efficiency based on power type and power at wheel proportion.
double	getBatteryEff (TrainTypes::PowerType powerType)
	Gets the battery efficiency based on power type.
std::pair< double, double >	getMaxEffeciencyRange (TrainTypes::PowerType powerType)
	Gets the maximum efficiency range for a given power type.
double	getRequiredGeneratorPowerForRecharge (double batterySOC)
	Gets the required generator power percentage for recharging the battery based on battery state of charge.
double	getEmissions (double fuelConsumption)
	Gets the CO2 emissions based on fuel consumption.
double	getLocomotivePowerReductionFactor (TrainTypes::PowerType powerType)
	Gets the power reduction factor for a given power type.
double	getFuelFromEC (TrainTypes::PowerType powerType, double &EC_KWh)
	Gets the fuel consumption in liters for a given energy consumption and power type.
double	getFuelFromEC (TrainTypes::CarType carType, double &EC_KWh)
	Gets the fuel consumption in liters for a given energy consumption and car type.
double	getFuelConversionFactor (TrainTypes::PowerType powerType)
	Gets the fuel conversion factor for a given power type.
double	getFuelConversionFactor (TrainTypes::CarType carType)
	Gets the fuel conversion factor for a given car type.

Function Documentation

getBatteryEff()

double EC::getBatteryEff

(

TrainTypes::PowerType

powerType

)

Gets the battery efficiency based on power type.

Parameters

powerType

Type of the power.

Returns

The battery efficiency.

getDCBusToTankEff()

double EC::getDCBusToTankEff	(	double	powerAtWheelProportion,
		TrainTypes::PowerType	powerType,
		TrainTypes::LocomotivePowerMethod	hybridMethod
	)

Gets the DC bus-to-tank efficiency based on power proportion at wheel, power type, and hybrid method.

Parameters

powerAtWheelProportion	The power required for the time step of the train at the wheel.
powerType	Type of the power.
hybridMethod	The hybrid method used in the locomotive.

Returns

The DC bus-to-tank efficiency.

getDriveLineEff()

double EC::getDriveLineEff	(	double &	trainSpeed,
		int	notchNumberIndex,
		double	powerAtWheelProportion,
		TrainTypes::PowerType	powerType,
		TrainTypes::LocomotivePowerMethod	hybridMethod
	)

Gets the drive line efficiency based on train speed, notch number index, power proportion at wheel, power type, and hybrid method.

Parameters

trainSpeed	The train speed in m/s.
notchNumberIndex	Zero-based index of the notch number.
powerAtWheelProportion	The power required for the time step of the train at the wheel.
powerType	Type of the power.
hybridMethod	The hybrid method used in the locomotive.

Returns

The drive line efficiency.

getEmissions()

double EC::getEmissions

(

double

fuelConsumption

)

Gets the CO2 emissions based on fuel consumption.

Parameters

fuelConsumption

The fuel consumption.

Returns

The CO2 emissions.

getFuelConversionFactor() [1/2]

double EC::getFuelConversionFactor

(

TrainTypes::CarType

carType

)

Gets the fuel conversion factor for a given car type.

Parameters

carType

Type of the car.

Returns

The fuel conversion factor.

getFuelConversionFactor() [2/2]

double EC::getFuelConversionFactor

(

TrainTypes::PowerType

powerType

)

Gets the fuel conversion factor for a given power type.

Parameters

powerType

Type of the power.

Returns

The fuel conversion factor.

getFuelFromEC() [1/2]

double EC::getFuelFromEC	(	TrainTypes::CarType	carType,
		double &	EC_KWh
	)

Gets the fuel consumption in liters for a given energy consumption and car type.

Parameters

carType	Type of the car.
EC_KWh	The energy consumption in kWh.

Returns

The fuel consumption in liters.

getFuelFromEC() [2/2]

double EC::getFuelFromEC	(	TrainTypes::PowerType	powerType,
		double &	EC_KWh
	)

Gets the fuel consumption in liters for a given energy consumption and power type.

Parameters

powerType	Type of the power.
EC_KWh	The energy consumption in kWh.

Returns

The fuel consumption in liters.

getGeneratorEff()

double EC::getGeneratorEff	(	TrainTypes::PowerType	powerType,
		double	powerAtWheelProportion
	)

Gets the generator efficiency based on power type and power at wheel proportion.

Parameters

powerType	Type of the power.
powerAtWheelProportion	The power required for the time step of the train at the wheel.

Returns

The generator efficiency.

getLocomotivePowerReductionFactor()

double EC::getLocomotivePowerReductionFactor

(

TrainTypes::PowerType

powerType

)

Gets the power reduction factor for a given power type.

Parameters

powerType

Type of the power.

Returns

The power reduction factor.

getMaxEffeciencyRange()

std::pair< double, double > EC::getMaxEffeciencyRange

(

TrainTypes::PowerType

powerType

)

Gets the maximum efficiency range for a given power type.

Parameters

powerType

Type of the power.

Returns

The maximum efficiency range (pair of values).

getRequiredGeneratorPowerForRecharge()

double EC::getRequiredGeneratorPowerForRecharge

(

double

batterySOC

)

Gets the required generator power percentage for recharging the battery based on battery state of charge.

Parameters

batterySOC

The battery state of charge.

Returns

The required generator power percentage.

getWheelToDCBusEff()

double EC::getWheelToDCBusEff

(

double &

trainSpeed

)

Gets the wheel-to-DC bus efficiency based on train speed.

Parameters

trainSpeed

The train speed in m/s.

Returns

The wheel-to-DC bus efficiency.