1 package org.djunits.quantity;
2
3 import org.djunits.quantity.def.Quantity;
4 import org.djunits.unit.AbstractUnit;
5 import org.djunits.unit.UnitRuntimeException;
6 import org.djunits.unit.Unitless;
7 import org.djunits.unit.Units;
8 import org.djunits.unit.scale.LinearScale;
9 import org.djunits.unit.scale.Scale;
10 import org.djunits.unit.si.SIUnit;
11 import org.djunits.unit.system.UnitSystem;
12
13 /**
14 * Acceleration is the rate of change of velocity over time, measured in meters per second squared (m/s2).
15 * <p>
16 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
17 * for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
18 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
19 * @author Alexander Verbraeck
20 */
21 public class Acceleration extends Quantity<Acceleration>
22 {
23 /** Constant with value zero. */
24 public static final Acceleration ZERO = Acceleration.ofSi(0.0);
25
26 /** Constant with value one. */
27 public static final Acceleration ONE = Acceleration.ofSi(1.0);
28
29 /** Constant with value NaN. */
30 @SuppressWarnings("checkstyle:constantname")
31 public static final Acceleration NaN = Acceleration.ofSi(Double.NaN);
32
33 /** Constant with value POSITIVE_INFINITY. */
34 public static final Acceleration POSITIVE_INFINITY = Acceleration.ofSi(Double.POSITIVE_INFINITY);
35
36 /** Constant with value NEGATIVE_INFINITY. */
37 public static final Acceleration NEGATIVE_INFINITY = Acceleration.ofSi(Double.NEGATIVE_INFINITY);
38
39 /** Constant with value MAX_VALUE. */
40 public static final Acceleration POS_MAXVALUE = Acceleration.ofSi(Double.MAX_VALUE);
41
42 /** Constant with value -MAX_VALUE. */
43 public static final Acceleration NEG_MAXVALUE = Acceleration.ofSi(-Double.MAX_VALUE);
44
45 /** */
46 private static final long serialVersionUID = 600L;
47
48 /**
49 * Instantiate a Acceleration quantity with a unit.
50 * @param valueInUnit the value, expressed in the unit
51 * @param unit the unit in which the value is expressed
52 */
53 public Acceleration(final double valueInUnit, final Acceleration.Unit unit)
54 {
55 super(valueInUnit, unit);
56 }
57
58 /**
59 * Instantiate a Acceleration quantity with a unit, expressed as a String.
60 * @param valueInUnit the value, expressed in the unit
61 * @param abbreviation the String abbreviation of the unit in which the value is expressed
62 */
63 public Acceleration(final double valueInUnit, final String abbreviation)
64 {
65 this(valueInUnit, Units.resolve(Acceleration.Unit.class, abbreviation));
66 }
67
68 /**
69 * Construct Acceleration quantity.
70 * @param value Scalar from which to construct this instance
71 */
72 public Acceleration(final Acceleration value)
73 {
74 super(value.si(), Acceleration.Unit.SI);
75 setDisplayUnit(value.getDisplayUnit());
76 }
77
78 /**
79 * Return a Acceleration instance based on an SI value.
80 * @param si the si value
81 * @return the Acceleration instance based on an SI value
82 */
83 public static Acceleration ofSi(final double si)
84 {
85 return new Acceleration(si, Acceleration.Unit.SI);
86 }
87
88 @Override
89 public Acceleration instantiateSi(final double si)
90 {
91 return ofSi(si);
92 }
93
94 @Override
95 public SIUnit siUnit()
96 {
97 return Acceleration.Unit.SI_UNIT;
98 }
99
100 /**
101 * Returns a Acceleration representation of a textual representation of a value with a unit. The String representation that
102 * can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are
103 * allowed, but not required, between the value and the unit.
104 * @param text the textual representation to parse into a Acceleration
105 * @return the Scalar representation of the value in its unit
106 * @throws IllegalArgumentException when the text cannot be parsed
107 * @throws NullPointerException when the text argument is null
108 */
109 public static Acceleration valueOf(final String text)
110 {
111 return Quantity.valueOf(text, ZERO);
112 }
113
114 /**
115 * Returns a Acceleration based on a value and the textual representation of the unit, which can be localized.
116 * @param valueInUnit the value, expressed in the unit as given by unitString
117 * @param unitString the textual representation of the unit
118 * @return the Scalar representation of the value in its unit
119 * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
120 * @throws NullPointerException when the unitString argument is null
121 */
122 public static Acceleration of(final double valueInUnit, final String unitString)
123 {
124 return Quantity.of(valueInUnit, unitString, ZERO);
125 }
126
127 @Override
128 public Acceleration.Unit getDisplayUnit()
129 {
130 return (Acceleration.Unit) super.getDisplayUnit();
131 }
132
133 /**
134 * Calculate the division of Acceleration and Acceleration, which results in a Dimensionless scalar.
135 * @param v scalar
136 * @return scalar as a division of Acceleration and Acceleration
137 */
138 public final Dimensionless divide(final Acceleration v)
139 {
140 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
141 }
142
143 /**
144 * Calculate the multiplication of Acceleration and Mass, which results in a Force scalar.
145 * @param v scalar
146 * @return scalar as a multiplication of Acceleration and Mass
147 */
148 public final Force multiply(final Mass v)
149 {
150 return new Force(this.si() * v.si(), Force.Unit.SI);
151 }
152
153 /**
154 * Calculate the multiplication of Acceleration and Duration, which results in a Speed scalar.
155 * @param v scalar
156 * @return scalar as a multiplication of Acceleration and Duration
157 */
158 public final Speed multiply(final Duration v)
159 {
160 return new Speed(this.si() * v.si(), Speed.Unit.SI);
161 }
162
163 /**
164 * Calculate the division of Acceleration and Frequency, which results in a Speed scalar.
165 * @param v scalar
166 * @return scalar as a division of Acceleration and Frequency
167 */
168 public final Speed divide(final Frequency v)
169 {
170 return new Speed(this.si() / v.si(), Speed.Unit.SI);
171 }
172
173 /**
174 * Calculate the division of Acceleration and Speed, which results in a Frequency scalar.
175 * @param v scalar
176 * @return scalar as a division of Acceleration and Speed
177 */
178 public final Frequency divide(final Speed v)
179 {
180 return new Frequency(this.si() / v.si(), Frequency.Unit.SI);
181 }
182
183 /**
184 * Calculate the multiplication of Acceleration and Momentum, which results in a Power scalar.
185 * @param v scalar
186 * @return scalar as a multiplication of Acceleration and Momentum
187 */
188 public final Power multiply(final Momentum v)
189 {
190 return new Power(this.si() * v.si(), Power.Unit.SI);
191 }
192
193 /******************************************************************************************************/
194 /********************************************** UNIT CLASS ********************************************/
195 /******************************************************************************************************/
196
197 /**
198 * Acceleration.Unit encodes the units of acceleration.
199 * <p>
200 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
201 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
202 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
203 * @author Alexander Verbraeck
204 */
205 @SuppressWarnings("checkstyle:constantname")
206 public static class Unit extends AbstractUnit<Acceleration.Unit, Acceleration>
207 {
208 /** Constant for standard gravity. */
209 public static final double CONST_GRAVITY = 9.80665;
210
211 /** The dimensions of Acceleration: m/s2. */
212 public static final SIUnit SI_UNIT = SIUnit.of("m/s2");
213
214 /** m/s2. */
215 public static final Acceleration.Unit m_s2 =
216 new Acceleration.Unit("m/s2", "meter per second squared", 1.0, UnitSystem.SI_DERIVED);
217
218 /** The SI or BASE unit. */
219 public static final Acceleration.Unit SI = m_s2;
220
221 /** km/h2. */
222 public static final Acceleration.Unit km_h2 = new Acceleration.Unit("km/h2", "kilometer per hour squared",
223 1000.0 / (3600.0 * 3600.0), UnitSystem.SI_ACCEPTED);
224
225 /** ft/s2. */
226 public static final Acceleration.Unit ft_s2 =
227 new Acceleration.Unit("ft/s2", "foot per second squared", Length.Unit.CONST_FT, UnitSystem.IMPERIAL);
228
229 /** in/s2. */
230 public static final Acceleration.Unit in_s2 =
231 new Acceleration.Unit("in/s2", "inch per second squared", Length.Unit.CONST_IN, UnitSystem.IMPERIAL);
232
233 /** mi/h2. */
234 public static final Acceleration.Unit mi_h2 = new Acceleration.Unit("mi/h2", "mile per hour squared",
235 Length.Unit.CONST_MI / (3600.0 * 3600.0), UnitSystem.IMPERIAL);
236
237 /** mi/s2. */
238 public static final Acceleration.Unit mi_s2 =
239 new Acceleration.Unit("mi/s2", "mile per second squared", Length.Unit.CONST_MI, UnitSystem.IMPERIAL);
240
241 /** kt/s = Nautical Mile / h / s. */
242 public static final Acceleration.Unit kt_s =
243 new Acceleration.Unit("kt/s", "knot per second", Length.Unit.CONST_NM / 3600.0, UnitSystem.OTHER);
244
245 /** mi/h/s. */
246 public static final Acceleration.Unit mi_h_s =
247 new Acceleration.Unit("mi/h/s", "mile per hour per second", Length.Unit.CONST_MI / 3600.0, UnitSystem.IMPERIAL);
248
249 /** The standard gravity. */
250 public static final Acceleration.Unit g =
251 new Acceleration.Unit("g", "standard gravity", CONST_GRAVITY, UnitSystem.OTHER);
252
253 /** Gal or cm/s. */
254 public static final Acceleration.Unit Gal = new Acceleration.Unit("Gal", "gal", 0.01, UnitSystem.CGS);
255
256 /**
257 * Create a new Acceleration unit.
258 * @param id the id or main abbreviation of the unit
259 * @param name the full name of the unit
260 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
261 * @param unitSystem the unit system such as SI or IMPERIAL
262 */
263 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
264 {
265 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
266 }
267
268 /**
269 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
270 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
271 * @param displayAbbreviation the display abbreviation of the unit
272 * @param name the full name of the unit
273 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
274 * @param unitSystem unit system, e.g. SI or Imperial
275 */
276 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
277 final UnitSystem unitSystem)
278 {
279 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
280 }
281
282 @Override
283 public SIUnit siUnit()
284 {
285 return SI_UNIT;
286 }
287
288 @Override
289 public Unit getBaseUnit()
290 {
291 return SI;
292 }
293
294 @Override
295 public Acceleration ofSi(final double si)
296 {
297 return Acceleration.ofSi(si);
298 }
299
300 @Override
301 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
302 final double scaleFactor, final UnitSystem unitSystem)
303 {
304 if (getScale() instanceof LinearScale ls)
305 {
306 return new Acceleration.Unit(textualAbbreviation, displayAbbreviation, name,
307 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
308 }
309 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
310 }
311
312 }
313 }