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