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