View Javadoc
1   package org.djunits.value.vdouble.scalar;
2   
3   import java.util.Locale;
4   
5   import org.djunits.unit.AccelerationUnit;
6   import org.djunits.unit.AreaUnit;
7   import org.djunits.unit.DimensionlessUnit;
8   import org.djunits.unit.EnergyUnit;
9   import org.djunits.unit.ForceUnit;
10  import org.djunits.unit.LinearDensityUnit;
11  import org.djunits.unit.MassUnit;
12  import org.djunits.unit.PowerUnit;
13  import org.djunits.unit.PressureUnit;
14  import org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel;
15  import org.djunits.value.vdouble.scalar.base.DoubleScalar;
16  import org.djutils.base.NumberParser;
17  import org.djutils.exceptions.Throw;
18  
19  import jakarta.annotation.Generated;
20  
21  /**
22   * Easy access methods for the Force DoubleScalar, which is relative by definition.
23   * <p>
24   * Copyright (c) 2013-2023 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
25   * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
26   * </p>
27   * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
28   * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
29   */
30  @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-04-30T13:59:27.633664900Z")
31  public class Force extends AbstractDoubleScalarRel<ForceUnit, Force>
32  {
33      /** */
34      private static final long serialVersionUID = 20150905L;
35  
36      /** Constant with value zero. */
37      public static final Force ZERO = new Force(0.0, ForceUnit.SI);
38  
39      /** Constant with value one. */
40      public static final Force ONE = new Force(1.0, ForceUnit.SI);
41  
42      /** Constant with value NaN. */
43      @SuppressWarnings("checkstyle:constantname")
44      public static final Force NaN = new Force(Double.NaN, ForceUnit.SI);
45  
46      /** Constant with value POSITIVE_INFINITY. */
47      public static final Force POSITIVE_INFINITY = new Force(Double.POSITIVE_INFINITY, ForceUnit.SI);
48  
49      /** Constant with value NEGATIVE_INFINITY. */
50      public static final Force NEGATIVE_INFINITY = new Force(Double.NEGATIVE_INFINITY, ForceUnit.SI);
51  
52      /** Constant with value MAX_VALUE. */
53      public static final Force POS_MAXVALUE = new Force(Double.MAX_VALUE, ForceUnit.SI);
54  
55      /** Constant with value -MAX_VALUE. */
56      public static final Force NEG_MAXVALUE = new Force(-Double.MAX_VALUE, ForceUnit.SI);
57  
58      /**
59       * Construct Force scalar.
60       * @param value double; the double value
61       * @param unit ForceUnit; unit for the double value
62       */
63      public Force(final double value, final ForceUnit unit)
64      {
65          super(value, unit);
66      }
67  
68      /**
69       * Construct Force scalar.
70       * @param value Force; Scalar from which to construct this instance
71       */
72      public Force(final Force value)
73      {
74          super(value);
75      }
76  
77      /** {@inheritDoc} */
78      @Override
79      public final Force instantiateRel(final double value, final ForceUnit unit)
80      {
81          return new Force(value, unit);
82      }
83  
84      /**
85       * Construct Force scalar.
86       * @param value double; the double value in SI units
87       * @return Force; the new scalar with the SI value
88       */
89      public static final Force instantiateSI(final double value)
90      {
91          return new Force(value, ForceUnit.SI);
92      }
93  
94      /**
95       * Interpolate between two values.
96       * @param zero Force; the low value
97       * @param one Force; the high value
98       * @param ratio double; the ratio between 0 and 1, inclusive
99       * @return Force; a Scalar at the ratio between
100      */
101     public static Force interpolate(final Force zero, final Force one, final double ratio)
102     {
103         return new Force(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio, zero.getDisplayUnit());
104     }
105 
106     /**
107      * Return the maximum value of two relative scalars.
108      * @param r1 Force; the first scalar
109      * @param r2 Force; the second scalar
110      * @return Force; the maximum value of two relative scalars
111      */
112     public static Force max(final Force r1, final Force r2)
113     {
114         return r1.gt(r2) ? r1 : r2;
115     }
116 
117     /**
118      * Return the maximum value of more than two relative scalars.
119      * @param r1 Force; the first scalar
120      * @param r2 Force; the second scalar
121      * @param rn Force...; the other scalars
122      * @return Force; the maximum value of more than two relative scalars
123      */
124     public static Force max(final Force r1, final Force r2, final Force... rn)
125     {
126         Force maxr = r1.gt(r2) ? r1 : r2;
127         for (Force r : rn)
128         {
129             if (r.gt(maxr))
130             {
131                 maxr = r;
132             }
133         }
134         return maxr;
135     }
136 
137     /**
138      * Return the minimum value of two relative scalars.
139      * @param r1 Force; the first scalar
140      * @param r2 Force; the second scalar
141      * @return Force; the minimum value of two relative scalars
142      */
143     public static Force min(final Force r1, final Force r2)
144     {
145         return r1.lt(r2) ? r1 : r2;
146     }
147 
148     /**
149      * Return the minimum value of more than two relative scalars.
150      * @param r1 Force; the first scalar
151      * @param r2 Force; the second scalar
152      * @param rn Force...; the other scalars
153      * @return Force; the minimum value of more than two relative scalars
154      */
155     public static Force min(final Force r1, final Force r2, final Force... rn)
156     {
157         Force minr = r1.lt(r2) ? r1 : r2;
158         for (Force r : rn)
159         {
160             if (r.lt(minr))
161             {
162                 minr = r;
163             }
164         }
165         return minr;
166     }
167 
168     /**
169      * Returns a Force representation of a textual representation of a value with a unit. The String representation that can be
170      * parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are allowed,
171      * but not required, between the value and the unit.
172      * @param text String; the textual representation to parse into a Force
173      * @return Force; the Scalar representation of the value in its unit
174      * @throws IllegalArgumentException when the text cannot be parsed
175      * @throws NullPointerException when the text argument is null
176      */
177     public static Force valueOf(final String text)
178     {
179         Throw.whenNull(text, "Error parsing Force: text to parse is null");
180         Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing Force: empty text to parse");
181         try
182         {
183             NumberParser numberParser = new NumberParser().lenient().trailing();
184             double d = numberParser.parseDouble(text);
185             String unitString = text.substring(numberParser.getTrailingPosition()).trim();
186             ForceUnit unit = ForceUnit.BASE.getUnitByAbbreviation(unitString);
187             if (unit == null)
188                 throw new IllegalArgumentException("Unit " + unitString + " not found");
189             return new Force(d, unit);
190         }
191         catch (Exception exception)
192         {
193             throw new IllegalArgumentException(
194                     "Error parsing Force from " + text + " using Locale " + Locale.getDefault(Locale.Category.FORMAT),
195                     exception);
196         }
197     }
198 
199     /**
200      * Returns a Force based on a value and the textual representation of the unit, which can be localized.
201      * @param value double; the value to use
202      * @param unitString String; the textual representation of the unit
203      * @return Force; the Scalar representation of the value in its unit
204      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
205      * @throws NullPointerException when the unitString argument is null
206      */
207     public static Force of(final double value, final String unitString)
208     {
209         Throw.whenNull(unitString, "Error parsing Force: unitString is null");
210         Throw.when(unitString.length() == 0, IllegalArgumentException.class, "Error parsing Force: empty unitString");
211         ForceUnit unit = ForceUnit.BASE.getUnitByAbbreviation(unitString);
212         if (unit != null)
213         {
214             return new Force(value, unit);
215         }
216         throw new IllegalArgumentException("Error parsing Force with unit " + unitString);
217     }
218 
219     /**
220      * Calculate the division of Force and Force, which results in a Dimensionless scalar.
221      * @param v Force; scalar
222      * @return Dimensionless; scalar as a division of Force and Force
223      */
224     public final Dimensionless divide(final Force v)
225     {
226         return new Dimensionless(this.si / v.si, DimensionlessUnit.SI);
227     }
228 
229     /**
230      * Calculate the multiplication of Force and Length, which results in a Energy scalar.
231      * @param v Force; scalar
232      * @return Energy; scalar as a multiplication of Force and Length
233      */
234     public final Energy times(final Length v)
235     {
236         return new Energy(this.si * v.si, EnergyUnit.SI);
237     }
238 
239     /**
240      * Calculate the division of Force and LinearDensity, which results in a Energy scalar.
241      * @param v Force; scalar
242      * @return Energy; scalar as a division of Force and LinearDensity
243      */
244     public final Energy divide(final LinearDensity v)
245     {
246         return new Energy(this.si / v.si, EnergyUnit.SI);
247     }
248 
249     /**
250      * Calculate the division of Force and Energy, which results in a LinearDensity scalar.
251      * @param v Force; scalar
252      * @return LinearDensity; scalar as a division of Force and Energy
253      */
254     public final LinearDensity divide(final Energy v)
255     {
256         return new LinearDensity(this.si / v.si, LinearDensityUnit.SI);
257     }
258 
259     /**
260      * Calculate the multiplication of Force and Speed, which results in a Power scalar.
261      * @param v Force; scalar
262      * @return Power; scalar as a multiplication of Force and Speed
263      */
264     public final Power times(final Speed v)
265     {
266         return new Power(this.si * v.si, PowerUnit.SI);
267     }
268 
269     /**
270      * Calculate the division of Force and Mass, which results in a Acceleration scalar.
271      * @param v Force; scalar
272      * @return Acceleration; scalar as a division of Force and Mass
273      */
274     public final Acceleration divide(final Mass v)
275     {
276         return new Acceleration(this.si / v.si, AccelerationUnit.SI);
277     }
278 
279     /**
280      * Calculate the division of Force and Acceleration, which results in a Mass scalar.
281      * @param v Force; scalar
282      * @return Mass; scalar as a division of Force and Acceleration
283      */
284     public final Mass divide(final Acceleration v)
285     {
286         return new Mass(this.si / v.si, MassUnit.SI);
287     }
288 
289     /**
290      * Calculate the division of Force and Area, which results in a Pressure scalar.
291      * @param v Force; scalar
292      * @return Pressure; scalar as a division of Force and Area
293      */
294     public final Pressure divide(final Area v)
295     {
296         return new Pressure(this.si / v.si, PressureUnit.SI);
297     }
298 
299     /**
300      * Calculate the division of Force and Pressure, which results in a Area scalar.
301      * @param v Force; scalar
302      * @return Area; scalar as a division of Force and Pressure
303      */
304     public final Area divide(final Pressure v)
305     {
306         return new Area(this.si / v.si, AreaUnit.SI);
307     }
308 
309     /** {@inheritDoc} */
310     @Override
311     public SIScalar reciprocal()
312     {
313         return DoubleScalar.divide(Dimensionless.ONE, this);
314     }
315 
316 }