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