001/* 002 * ============================================================================ 003 * Copyright © 2002-2023 by Thomas Thrien. 004 * All Rights Reserved. 005 * ============================================================================ 006 * Licensed to the public under the agreements of the GNU Lesser General Public 007 * License, version 3.0 (the "License"). You may obtain a copy of the License at 008 * 009 * http://www.gnu.org/licenses/lgpl.html 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 013 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 014 * License for the specific language governing permissions and limitations 015 * under the License. 016 */ 017 018package org.tquadrat.foundation.value; 019 020import static java.lang.String.format; 021import static java.util.Arrays.stream; 022import static org.apiguardian.api.API.Status.STABLE; 023import static org.tquadrat.foundation.lang.Objects.requireNotEmptyArgument; 024 025import java.math.BigDecimal; 026 027import org.apiguardian.api.API; 028import org.tquadrat.foundation.annotation.ClassVersion; 029import org.tquadrat.foundation.value.api.DimensionWithLinearConversion; 030 031/** 032 * The various instances of energy … 033 * 034 * @extauthor Thomas Thrien - thomas.thrien@tquadrat.org 035 * @version $Id: Energy.java 1077 2023-10-14 23:00:23Z tquadrat $ 036 * @since 0.3.0 037 * 038 * @UMLGraph.link 039 */ 040@ClassVersion( sourceVersion = "$Id: Energy.java 1077 2023-10-14 23:00:23Z tquadrat $" ) 041@API( status = STABLE, since = "0.3.0" ) 042public enum Energy implements DimensionWithLinearConversion 043{ 044 /*------------------*\ 045 ====** Enum Declaration **================================================= 046 \*------------------*/ 047 /** 048 * An electron volt. 049 */ 050 ELECTRONVOLT( new BigDecimal( "1.602176634E-19"), "eV" ), 051 052 /** 053 * An erg. 054 */ 055 ERG( new BigDecimal( "1E-7"), "erg" ), 056 057 /** 058 * A Joule. 059 */ 060 JOULE( BigDecimal.ONE, "J", 1 ), 061 062 /** 063 * A calorie. 064 */ 065 CALORIE( new BigDecimal( "4.1868" ), "cal" ), 066 067 /** 068 * A kilo Joule. 069 */ 070 KILOJOULE( new BigDecimal( "1000" ), "kJ", 1 ), 071 072 /** 073 * A British Thermal Unit (BTU). 074 */ 075 BTU( new BigDecimal( "1055.05585262" ), "BTU" ), 076 077 /** 078 * A kilo calorie. 079 */ 080 KILOCALORIE( new BigDecimal( "4186.8" ), "kcal" ), 081 082 /** 083 * A kilopond meter. 084 */ 085 KILOPONDMETER( new BigDecimal( "9.80665" ), "kpm" ), 086 087 /** 088 * A Mega Joule. 089 */ 090 MEGAJOULE( new BigDecimal( "1E+6" ), "MJ" ), 091 092 /** 093 * A kilo Watt per hour. 094 */ 095 KILOWATT_HOUR( new BigDecimal( "3.6E+6" ), "kWh" ), 096 097 /** 098 * <p>{@summary The energy equivalent of one kg TNT}. This is usually used 099 * to rate the power of (nuclear) bombs or other explosives.</p> 100 */ 101 KILOGRAM_TNT( new BigDecimal( "4.184E+6" ), "kg(TNT)" ), 102 103 /** 104 * A Giga Joule. 105 */ 106 GIGAJOULE( new BigDecimal( "1E+9" ), "GJ" ), 107 108 /** 109 * A Mega Joule. 110 */ 111 TERAJOULE( new BigDecimal( "1E+12" ), "TJ" ), 112 113 /** 114 * <p>{@summary The energy equivalent of one thousand tons of TNT}. This 115 * is usually used to rate the power of (nuclear) bombs or other 116 * explosives.</p> 117 */ 118 KILOTON_TNT( new BigDecimal( "4.184E+12" ), "kT(TNT)" ), 119 120 /** 121 * <p>{@summary The energy equivalent of one million tons of TNT}. This is 122 * usually used to rate the power of (nuclear) bombs or other 123 * explosives.</p> 124 */ 125 MEGATON_TNT( new BigDecimal( "4.184E+15" ), "MT(TNT)" ), 126 127 /** 128 * A quad. 129 */ 130 QUAD( new BigDecimal( "1055.05585262E+15" ), "quad" ), 131 132 /** 133 * <p>{@summary A foe (or a 'bethe').}</p> 134 * <p>A {@code foe} is used to express the large amount of energy released 135 * by a supernova. An acronym for "[ten to the power of] fifty-one 136 * ergs", the term was introduced by Gerald E. Brown of Stony Brook 137 * University in his work with Hans Bethe, because <cite>"it came up 138 * often enough in our work"</cite>.</p> 139 * <p>Without mentioning the foe, Steven Weinberg proposed in 2006 "a 140 * new unit called the bethe ({@code B})" with the same value, to 141 * "<i>replace</i>" it.</p> 142 * <p>This unit of measure is convenient because a supernova typically 143 * releases about one {@code foe} of observable energy in a very short 144 * period (which can be measured in seconds).</p> 145 */ 146 FOE( new BigDecimal( "1E+44" ), "foe" ), 147 148 /** 149 * <p>{@summary A bethe.}</p> 150 * <p>This is the same as 151 * {@link #FOE foe}.</p> 152 */ 153 BETHE( new BigDecimal( "1E+44" ), "B" ); 154 155 /*------------*\ 156 ====** Attributes **======================================================= 157 \*------------*/ 158 /** 159 * The factor. 160 */ 161 private final BigDecimal m_Factor; 162 163 /** 164 * The default precision. 165 */ 166 private final int m_Precision; 167 168 /** 169 * The unit string. 170 */ 171 private final String m_UnitSymbol; 172 173 /*--------------*\ 174 ====** Constructors **===================================================== 175 \*--------------*/ 176 /** 177 * Creates a new {@code Length} instance, with a default precision of zero 178 * mantissa digits. 179 * 180 * @param factor The factor. 181 * @param unitSymbol The unit symbol String. 182 */ 183 private Energy( final BigDecimal factor, final String unitSymbol ) 184 { 185 this( factor, unitSymbol, 0 ); 186 } // Energy() 187 188 /** 189 * Creates a new {@code Length} instance. 190 * 191 * @param factor The factor. 192 * @param unitSymbol The unit symbol String. 193 * @param precision The default precision. 194 */ 195 private Energy( final BigDecimal factor, final String unitSymbol, final int precision ) 196 { 197 m_Factor = factor.stripTrailingZeros(); 198 m_UnitSymbol = unitSymbol; 199 m_Precision = precision; 200 } // Energy() 201 202 /*---------*\ 203 ====** Methods **========================================================== 204 \*---------*/ 205 /** 206 * {@inheritDoc} 207 */ 208 @Override 209 @SuppressWarnings( "unchecked" ) 210 public final Energy baseUnit() { return JOULE; } 211 212 /** 213 * {@inheritDoc} 214 */ 215 @Override 216 public final BigDecimal factor() { return m_Factor; } 217 218 /** 219 * Returns the {@code Energy} instance for the given unit symbol. 220 * 221 * @param unitSymbol The unit symbol. 222 * @return The respective instance. 223 * @throws IllegalArgumentException The given unit is unknown. 224 */ 225 public static final Energy forUnit( final String unitSymbol ) throws IllegalArgumentException 226 { 227 requireNotEmptyArgument( unitSymbol, "unitSymbol" ); 228 229 final var retValue = stream( values() ) 230 .filter( v -> v.unitSymbol().equals( unitSymbol ) ) 231 .findFirst() 232 .orElseThrow( () -> new IllegalArgumentException( format( MSG_UnknownUnit, unitSymbol ) ) ); 233 234 //---* Done *---------------------------------------------------------- 235 return retValue; 236 } // forUnit() 237 238 /** 239 * {@inheritDoc} 240 */ 241 @Override 242 public final int getPrecision() { return m_Precision; } 243 244 /** 245 * {@inheritDoc} 246 */ 247 @Override 248 public final String unitSymbol() { return m_UnitSymbol; } 249} 250// enum Energy 251 252/* 253 * End of File 254 */