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 * Area is a measure of a two-dimensional surface, expressed in square meters (m2).
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 Area extends Quantity<Area>
22 {
23 /** Constant with value zero. */
24 public static final Area ZERO = Area.ofSi(0.0);
25
26 /** Constant with value one. */
27 public static final Area ONE = Area.ofSi(1.0);
28
29 /** Constant with value NaN. */
30 @SuppressWarnings("checkstyle:constantname")
31 public static final Area NaN = Area.ofSi(Double.NaN);
32
33 /** Constant with value POSITIVE_INFINITY. */
34 public static final Area POSITIVE_INFINITY = Area.ofSi(Double.POSITIVE_INFINITY);
35
36 /** Constant with value NEGATIVE_INFINITY. */
37 public static final Area NEGATIVE_INFINITY = Area.ofSi(Double.NEGATIVE_INFINITY);
38
39 /** Constant with value MAX_VALUE. */
40 public static final Area POS_MAXVALUE = Area.ofSi(Double.MAX_VALUE);
41
42 /** Constant with value -MAX_VALUE. */
43 public static final Area NEG_MAXVALUE = Area.ofSi(-Double.MAX_VALUE);
44
45 /** */
46 private static final long serialVersionUID = 600L;
47
48 /**
49 * Instantiate a Area 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 Area(final double valueInUnit, final Area.Unit unit)
54 {
55 super(valueInUnit, unit);
56 }
57
58 /**
59 * Instantiate a Area 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 Area(final double valueInUnit, final String abbreviation)
64 {
65 this(valueInUnit, Units.resolve(Area.Unit.class, abbreviation));
66 }
67
68 /**
69 * Construct Area quantity.
70 * @param value Scalar from which to construct this instance
71 */
72 public Area(final Area value)
73 {
74 super(value.si(), Area.Unit.SI);
75 setDisplayUnit(value.getDisplayUnit());
76 }
77
78 /**
79 * Return a Area instance based on an SI value.
80 * @param si the si value
81 * @return the Area instance based on an SI value
82 */
83 public static Area ofSi(final double si)
84 {
85 return new Area(si, Area.Unit.SI);
86 }
87
88 @Override
89 public Area instantiateSi(final double si)
90 {
91 return ofSi(si);
92 }
93
94 @Override
95 public SIUnit siUnit()
96 {
97 return Area.Unit.SI_UNIT;
98 }
99
100 /**
101 * Returns a Area representation of a textual representation of a value with a unit. The String representation that can be
102 * parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are allowed,
103 * but not required, between the value and the unit.
104 * @param text the textual representation to parse into a Area
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 Area valueOf(final String text)
110 {
111 return Quantity.valueOf(text, ZERO);
112 }
113
114 /**
115 * Returns a Area 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 Area of(final double valueInUnit, final String unitString)
123 {
124 return Quantity.of(valueInUnit, unitString, ZERO);
125 }
126
127 @Override
128 public Area.Unit getDisplayUnit()
129 {
130 return (Area.Unit) super.getDisplayUnit();
131 }
132
133 /**
134 * Calculate the division of Area and Area, which results in a Dimensionless scalar.
135 * @param v scalar
136 * @return scalar as a division of Area and Area
137 */
138 public final Dimensionless divide(final Area v)
139 {
140 return new Dimensionless(this.si() / v.si(), Unitless.BASE);
141 }
142
143 /**
144 * Calculate the multiplication of Area and ArealObjectDensity, which results in a Dimensionless scalar.
145 * @param v scalar
146 * @return scalar as a multiplication of Area and ArealObjectDensity
147 */
148 public final Dimensionless multiply(final ArealObjectDensity v)
149 {
150 return new Dimensionless(this.si() * v.si(), Unitless.BASE);
151 }
152
153 /**
154 * Calculate the multiplication of Area and Length, which results in a Volume scalar.
155 * @param v scalar
156 * @return scalar as a multiplication of Area and Length
157 */
158 public final Volume multiply(final Length v)
159 {
160 return new Volume(this.si() * v.si(), Volume.Unit.SI);
161 }
162
163 /**
164 * Calculate the division of Area and LinearObjectDensity, which results in a Volume scalar.
165 * @param v scalar
166 * @return scalar as a division of Area and LinearObjectDensity
167 */
168 public final Volume divide(final LinearObjectDensity v)
169 {
170 return new Volume(this.si() / v.si(), Volume.Unit.SI);
171 }
172
173 /**
174 * Calculate the division of Area and Volume, which results in a LinearObjectDensity scalar.
175 * @param v scalar
176 * @return scalar as a division of Area and Volume
177 */
178 public final LinearObjectDensity divide(final Volume v)
179 {
180 return new LinearObjectDensity(this.si() / v.si(), LinearObjectDensity.Unit.SI);
181 }
182
183 /**
184 * Calculate the division of Area and Length, which results in a Length scalar.
185 * @param v scalar
186 * @return scalar as a division of Area and Length
187 */
188 public final Length divide(final Length v)
189 {
190 return new Length(this.si() / v.si(), Length.Unit.SI);
191 }
192
193 /**
194 * Calculate the multiplication of Area and LinearObjectDensity, which results in a Length scalar.
195 * @param v scalar
196 * @return scalar as a multiplication of Area and LinearObjectDensity
197 */
198 public final Length multiply(final LinearObjectDensity v)
199 {
200 return new Length(this.si() * v.si(), Length.Unit.SI);
201 }
202
203 /**
204 * Calculate the multiplication of Area and Speed, which results in a FlowVolume scalar.
205 * @param v scalar
206 * @return scalar as a multiplication of Area and Speed
207 */
208 public final FlowVolume multiply(final Speed v)
209 {
210 return new FlowVolume(this.si() * v.si(), FlowVolume.Unit.SI);
211 }
212
213 /**
214 * Calculate the multiplication of Area and Pressure, which results in a Force scalar.
215 * @param v scalar
216 * @return scalar as a multiplication of Area and Pressure
217 */
218 public final Force multiply(final Pressure v)
219 {
220 return new Force(this.si() * v.si(), Force.Unit.SI);
221 }
222
223 /**
224 * Calculate the multiplication of Area and Illuminance, which results in a LuminousFlux scalar.
225 * @param v scalar
226 * @return scalar as a multiplication of Area and Illuminance
227 */
228 public final LuminousFlux multiply(final Illuminance v)
229 {
230 return new LuminousFlux(this.si() * v.si(), LuminousFlux.Unit.SI);
231 }
232
233 @Override
234 public ArealObjectDensity reciprocal()
235 {
236 return ArealObjectDensity.ofSi(1.0 / this.si());
237 }
238
239 /******************************************************************************************************/
240 /********************************************** UNIT CLASS ********************************************/
241 /******************************************************************************************************/
242
243 /**
244 * Area.Unit encodes the area unit (length x length).
245 * <p>
246 * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
247 * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
248 * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
249 * @author Alexander Verbraeck
250 */
251 @SuppressWarnings("checkstyle:constantname")
252 public static class Unit extends AbstractUnit<Area.Unit, Area>
253 {
254 /** The dimensions of Area: m2. */
255 public static final SIUnit SI_UNIT = SIUnit.of("m2");
256
257 /** Square meter. */
258 public static final Area.Unit m2 = new Area.Unit("m2", "square meter", 1.0, UnitSystem.SI_BASE);
259
260 /** The SI or BASE unit. */
261 public static final Area.Unit SI = m2;
262
263 /** Square kilometer. */
264 public static final Area.Unit km2 = m2.deriveUnit("km2", "square kilometer", 1.0E6, UnitSystem.SI_BASE);
265
266 /** Square hectometer. */
267 public static final Area.Unit hm2 = m2.deriveUnit("hm2", "square hectometer", 1.0E4, UnitSystem.SI_BASE);
268
269 /** Square decameter. */
270 public static final Area.Unit dam2 = m2.deriveUnit("dam2", "square decameter", 1.0E2, UnitSystem.SI_BASE);
271
272 /** Square decimeter. */
273 public static final Area.Unit dm2 = m2.deriveUnit("dm2", "square decimeter", 1.0E-2, UnitSystem.SI_BASE);
274
275 /** Square centimeter. */
276 public static final Area.Unit cm2 = m2.deriveUnit("cm2", "square centimeter", 1.0E-4, UnitSystem.SI_BASE);
277
278 /** Square millimeter. */
279 public static final Area.Unit mm2 = m2.deriveUnit("mm2", "square millimeter", 1.0E-6, UnitSystem.SI_BASE);
280
281 /** Square micrometer. */
282 public static final Area.Unit mum2 =
283 m2.deriveUnit("mum2", "\u03BCm2", "square micrometer", 1.0E-12, UnitSystem.SI_BASE);
284
285 /** Square nanometer. */
286 public static final Area.Unit nm2 = m2.deriveUnit("nm2", "square nanometer", 1.0E-18, UnitSystem.SI_BASE);
287
288 /** Square picometer. */
289 public static final Area.Unit pm2 = m2.deriveUnit("pm2", "square picometer", 1.0E-24, UnitSystem.SI_BASE);
290
291 /** Square femtometer. */
292 public static final Area.Unit fm2 = m2.deriveUnit("fm2", "square femtometer", 1.0E-30, UnitSystem.SI_BASE);
293
294 /** Square attometer. */
295 public static final Area.Unit am2 = m2.deriveUnit("am2", "square attometer", 1.0E-36, UnitSystem.SI_BASE);
296
297 /** centiare. */
298 public static final Area.Unit ca = new Area.Unit("ca", "centiare", 1.0, UnitSystem.OTHER);
299
300 /** are. */
301 public static final Area.Unit a = new Area.Unit("a", "are", 100.0, UnitSystem.OTHER);
302
303 /** hectare. */
304 public static final Area.Unit ha = new Area.Unit("ha", "hectare", 100.0 * 100.0, UnitSystem.OTHER);
305
306 /** mile2. */
307 public static final Area.Unit mi2 =
308 new Area.Unit("mi2", "square mile", Length.Unit.CONST_MI * Length.Unit.CONST_MI, UnitSystem.IMPERIAL);
309
310 /** Nautical mile2. */
311 public static final Area.Unit NM2 =
312 new Area.Unit("NM2", "square nautical mile", Length.Unit.CONST_NM * Length.Unit.CONST_NM, UnitSystem.OTHER);
313
314 /** ft2. */
315 public static final Area.Unit ft2 =
316 new Area.Unit("ft2", "square foot", Length.Unit.CONST_FT * Length.Unit.CONST_FT, UnitSystem.IMPERIAL);
317
318 /** in2. */
319 public static final Area.Unit in2 =
320 new Area.Unit("in2", "square inch", Length.Unit.CONST_IN * Length.Unit.CONST_IN, UnitSystem.IMPERIAL);
321
322 /** yd2. */
323 public static final Area.Unit yd2 =
324 new Area.Unit("yd2", "square yard", Length.Unit.CONST_YD * Length.Unit.CONST_YD, UnitSystem.IMPERIAL);
325
326 /** acre (international) defined as 1/640 square mile or 4840 square yards. */
327 public static final Area.Unit ac =
328 new Area.Unit("ac", "acre", Length.Unit.CONST_MI * Length.Unit.CONST_MI / 640.0, UnitSystem.IMPERIAL);
329
330 /**
331 * Create a new Area unit.
332 * @param id the id or main abbreviation of the unit
333 * @param name the full name of the unit
334 * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
335 * @param unitSystem the unit system such as SI or IMPERIAL
336 */
337 public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
338 {
339 super(id, name, new LinearScale(scaleFactorToBaseUnit), unitSystem);
340 }
341
342 /**
343 * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
344 * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
345 * @param displayAbbreviation the display abbreviation of the unit
346 * @param name the full name of the unit
347 * @param scale the scale to use to convert between this unit and the standard (e.g., SI, BASE) unit
348 * @param unitSystem unit system, e.g. SI or Imperial
349 */
350 public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
351 final UnitSystem unitSystem)
352 {
353 super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem);
354 }
355
356 @Override
357 public SIUnit siUnit()
358 {
359 return SI_UNIT;
360 }
361
362 @Override
363 public Unit getBaseUnit()
364 {
365 return SI;
366 }
367
368 @Override
369 public Area ofSi(final double si)
370 {
371 return Area.ofSi(si);
372 }
373
374 @Override
375 public Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
376 final double scaleFactor, final UnitSystem unitSystem)
377 {
378 if (getScale() instanceof LinearScale ls)
379 {
380 return new Area.Unit(textualAbbreviation, displayAbbreviation, name,
381 new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem);
382 }
383 throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
384 }
385
386 }
387 }