org.djunits.unit

Class EnergyUnit

java.lang.Object

org.djunits.unit.Unit<U>

org.djunits.unit.LinearUnit<EnergyUnit>

org.djunits.unit.EnergyUnit

All Implemented Interfaces:

Serializable

public class EnergyUnit
extends LinearUnit<EnergyUnit>

The units of energy.

Copyright (c) 2015-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2019-03-02 19:06:46 +0100 (Sat, 02 Mar 2019) $, @version $Revision: 342 $, by $Author: averbraeck $, initial version May 15, 2014

Author:

Alexander Verbraeck

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static EnergyUnit	BTU_ISO British thermal unit (ISO).
static EnergyUnit	BTU_IT British thermal unit (International Table).
static EnergyUnit	CALORIE calorie.
static EnergyUnit	CALORIE_IT calorie (International Table).
static EnergyUnit	ELECTRONVOLT electronvolt.
static EnergyUnit	ERG erg (cgs).
static EnergyUnit	EXAELECTRONVOLT exa-electronvolt.
static EnergyUnit	FEMTOWATT_HOUR femtowatt-hour.
static EnergyUnit	FOOT_POUND_FORCE foot-pound force.
static EnergyUnit	GIGAELECTRONVOLT giga-electronvolt.
static EnergyUnit	GIGAJOULE gigajoule.
static EnergyUnit	GIGAWATT_HOUR gigawatt-hour.
static EnergyUnit	INCH_POUND_FORCE inch-pound force.
static EnergyUnit	JOULE Joule.
static EnergyUnit	KILOCALORIE kilocalorie.
static EnergyUnit	KILOELECTRONVOLT kilo-electronvolt.
static EnergyUnit	KILOJOULE kilojoule.
static EnergyUnit	KILOWATT_HOUR kilowatt-hour.
static EnergyUnit	MEGAELECTRONVOLT mega-electronvolt.
static EnergyUnit	MEGAJOULE megajoule.
static EnergyUnit	MEGAWATT_HOUR megawatt-hour.
static EnergyUnit	MICROELECTRONVOLT micro-electronvolt.
static EnergyUnit	MICROJOULE microjoule.
static EnergyUnit	MICROWATT_HOUR microwatt-hour.
static EnergyUnit	MILLIELECTRONVOLT milli-electronvolt.
static EnergyUnit	MILLIJOULE millijoule.
static EnergyUnit	MILLIWATT_HOUR milliwatt-hour.
static EnergyUnit	NANOJOULE nanojoule.
static EnergyUnit	NANOWATT_HOUR nanowatt-hour.
static EnergyUnit	PETAELECTRONVOLT peta-electronvolt.
static EnergyUnit	PETAJOULE petajoule.
static EnergyUnit	PETAWATT_HOUR petawatt-hour.
static EnergyUnit	PICOJOULE picojoule.
static EnergyUnit	PICOWATT_HOUR picowatt-hour.
static EnergyUnit	SI The SI unit for energy is Joule.
static EnergyUnit	STHENE_METER sthene-meter (mts).
static EnergyUnit	TERAELECTRONVOLT tera-electronvolt.
static EnergyUnit	TERAJOULE terajoule.
static EnergyUnit	TERAWATT_HOUR terawatt-hour.
static EnergyUnit	WATT_HOUR watt-hour.

Fields inherited from class org.djunits.unit.Unit

STANDARD_UNITS

Constructor Summary

Constructors

Constructor and Description
EnergyUnit(ForceUnit forceUnit, LengthUnit lengthUnit, String name, String abbreviation, UnitSystem unitSystem) Define a user-defined EnergyUnit based on a LengthUnit and a ForceUnit, e.g.
EnergyUnit(MassUnit massUnit, LengthUnit lengthUnit, DurationUnit durationUnit, String name, String abbreviation, UnitSystem unitSystem) Define a user-defined EnergyUnit based on its constituent base units, e.g.
EnergyUnit(String name, String abbreviation, UnitSystem unitSystem, EnergyUnit referenceUnit, double scaleFactorToReferenceUnit) Build a user-defined EnergyUnit with a conversion factor to another EnergyUnit.

Method Summary

Modifier and Type	Method and Description
DurationUnit	getDurationUnit()
LengthUnit	getLengthUnit()
MassUnit	getMassUnit()
String	getSICoefficientsString()
EnergyUnit	getStandardUnit()

Methods inherited from class org.djunits.unit.LinearUnit

equals, equalsIgnoreNaming, getScale, getScaleFactor, hashCode

Methods inherited from class org.djunits.unit.Unit

generateHashCode, getAbbreviation, getAbbreviationKey, getAllUnitsOfThisType, getDefaultLocaleAbbreviation, getDefaultLocaleName, getDefaultLocaleTextualRepresentation, getDefaultLocaleTextualRepresentations, getDefaultTextualRepresentation, getName, getSICoefficients, getTextualRepresentations, getUnits, getUnitSystem, isBaseSIUnit, isLocalizable, lookupOrCreateSIUnitWithSICoefficients, lookupOrCreateUnitWithSICoefficients, lookupUnitWithSICoefficients, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SI

public static final EnergyUnit SI

The SI unit for energy is Joule.

PICOJOULE

public static final EnergyUnit PICOJOULE

picojoule.

NANOJOULE

public static final EnergyUnit NANOJOULE

nanojoule.

MICROJOULE

public static final EnergyUnit MICROJOULE

microjoule.

MILLIJOULE

public static final EnergyUnit MILLIJOULE

millijoule.

JOULE

public static final EnergyUnit JOULE

Joule.

KILOJOULE

public static final EnergyUnit KILOJOULE

kilojoule.

MEGAJOULE

public static final EnergyUnit MEGAJOULE

megajoule.

GIGAJOULE

public static final EnergyUnit GIGAJOULE

gigajoule.

TERAJOULE

public static final EnergyUnit TERAJOULE

terajoule.

PETAJOULE

public static final EnergyUnit PETAJOULE

petajoule.

FOOT_POUND_FORCE

public static final EnergyUnit FOOT_POUND_FORCE

foot-pound force.

INCH_POUND_FORCE

public static final EnergyUnit INCH_POUND_FORCE

inch-pound force.

BTU_ISO

public static final EnergyUnit BTU_ISO

British thermal unit (ISO).

BTU_IT

public static final EnergyUnit BTU_IT

British thermal unit (International Table).

CALORIE_IT

public static final EnergyUnit CALORIE_IT

calorie (International Table).

CALORIE

public static final EnergyUnit CALORIE

calorie.

KILOCALORIE

public static final EnergyUnit KILOCALORIE

kilocalorie.

FEMTOWATT_HOUR

public static final EnergyUnit FEMTOWATT_HOUR

femtowatt-hour.

PICOWATT_HOUR

public static final EnergyUnit PICOWATT_HOUR

picowatt-hour.

NANOWATT_HOUR

public static final EnergyUnit NANOWATT_HOUR

nanowatt-hour.

MICROWATT_HOUR

public static final EnergyUnit MICROWATT_HOUR

microwatt-hour.

MILLIWATT_HOUR

public static final EnergyUnit MILLIWATT_HOUR

milliwatt-hour.

WATT_HOUR

public static final EnergyUnit WATT_HOUR

watt-hour.

KILOWATT_HOUR

public static final EnergyUnit KILOWATT_HOUR

kilowatt-hour.

MEGAWATT_HOUR

public static final EnergyUnit MEGAWATT_HOUR

megawatt-hour.

GIGAWATT_HOUR

public static final EnergyUnit GIGAWATT_HOUR

gigawatt-hour.

TERAWATT_HOUR

public static final EnergyUnit TERAWATT_HOUR

terawatt-hour.

PETAWATT_HOUR

public static final EnergyUnit PETAWATT_HOUR

petawatt-hour.

ELECTRONVOLT

public static final EnergyUnit ELECTRONVOLT

electronvolt.

MICROELECTRONVOLT

public static final EnergyUnit MICROELECTRONVOLT

micro-electronvolt.

MILLIELECTRONVOLT

public static final EnergyUnit MILLIELECTRONVOLT

milli-electronvolt.

KILOELECTRONVOLT

public static final EnergyUnit KILOELECTRONVOLT

kilo-electronvolt.

MEGAELECTRONVOLT

public static final EnergyUnit MEGAELECTRONVOLT

mega-electronvolt.

GIGAELECTRONVOLT

public static final EnergyUnit GIGAELECTRONVOLT

giga-electronvolt.

TERAELECTRONVOLT

public static final EnergyUnit TERAELECTRONVOLT

tera-electronvolt.

PETAELECTRONVOLT

public static final EnergyUnit PETAELECTRONVOLT

peta-electronvolt.

EXAELECTRONVOLT

public static final EnergyUnit EXAELECTRONVOLT

exa-electronvolt.

STHENE_METER

public static final EnergyUnit STHENE_METER

sthene-meter (mts).

ERG

public static final EnergyUnit ERG

erg (cgs).

Constructor Detail

EnergyUnit

public EnergyUnit(MassUnit massUnit,
                  LengthUnit lengthUnit,
                  DurationUnit durationUnit,
                  String name,
                  String abbreviation,
                  UnitSystem unitSystem)

Define a user-defined EnergyUnit based on its constituent base units, e.g. a J = km.m^2/s^2.

Parameters:

massUnit - MassUnit; the unit of mass for the energy unit, e.g., kilogram

lengthUnit - LengthUnit; the unit of length for the energy unit, e.g., meter

durationUnit - DurationUnit; the unit of time for the energy unit, e.g., second

name - String; the long name of the unit

abbreviation - String; the abbreviation of the unit

unitSystem - UnitSystem; the unit system, e.g. SI or Imperial

EnergyUnit

public EnergyUnit(ForceUnit forceUnit,
                  LengthUnit lengthUnit,
                  String name,
                  String abbreviation,
                  UnitSystem unitSystem)

Define a user-defined EnergyUnit based on a LengthUnit and a ForceUnit, e.g. a J = N.m.

Parameters:

forceUnit - ForceUnit; the unit of force for the energy unit, e.g., Newton

lengthUnit - LengthUnit; the unit of length for the energy unit, e.g., Meter

name - String; the long name of the unit

abbreviation - String; the abbreviation of the unit

unitSystem - UnitSystem; the unit system, e.g. SI or Imperial

EnergyUnit

public EnergyUnit(String name,
                  String abbreviation,
                  UnitSystem unitSystem,
                  EnergyUnit referenceUnit,
                  double scaleFactorToReferenceUnit)

Build a user-defined EnergyUnit with a conversion factor to another EnergyUnit.

Parameters:

name - String; the long name of the unit

abbreviation - String; the abbreviation of the unit

unitSystem - UnitSystem; the unit system, e.g. SI or Imperial

referenceUnit - EnergyUnit; the unit to convert to

scaleFactorToReferenceUnit - double; multiply a value in this unit by the factor to convert to the given reference unit

Method Detail

getMassUnit

public final MassUnit getMassUnit()

Returns:

massUnit

getLengthUnit

public final LengthUnit getLengthUnit()

Returns:

lengthUnit

getDurationUnit

public final DurationUnit getDurationUnit()

Returns:

durationUnit

getStandardUnit

public final EnergyUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<EnergyUnit>

Returns:

the SI standard unit for this unit, or the de facto standard unit if SI is not available

getSICoefficientsString

public final String getSICoefficientsString()

Specified by:

getSICoefficientsString in class Unit<EnergyUnit>

Returns:

the SI standard coefficients for this unit, e.g., kgm/s2 or m-2s2A or m^-2.s^2.A or m^-2s^2A (not necessarily normalized)