1 package org.djunits.value.vdouble.scalar;
2
3 import java.util.Locale;
4
5 import org.djunits.unit.DensityUnit;
6 import org.djunits.unit.DimensionlessUnit;
7 import org.djunits.unit.FlowMassUnit;
8 import org.djunits.unit.MassUnit;
9 import org.djunits.value.vdouble.scalar.base.DoubleScalar;
10 import org.djunits.value.vdouble.scalar.base.DoubleScalarRel;
11 import org.djutils.base.NumberParser;
12 import org.djutils.exceptions.Throw;
13
14 import jakarta.annotation.Generated;
15
16
17
18
19
20
21
22
23
24
25 @Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2023-07-23T14:06:38.224104100Z")
26 public class Density extends DoubleScalarRel<DensityUnit, Density>
27 {
28
29 private static final long serialVersionUID = 20150905L;
30
31
32 public static final Density ZERO = new Density(0.0, DensityUnit.SI);
33
34
35 public static final Density ONE = new Density(1.0, DensityUnit.SI);
36
37
38 @SuppressWarnings("checkstyle:constantname")
39 public static final Density NaN = new Density(Double.NaN, DensityUnit.SI);
40
41
42 public static final Density POSITIVE_INFINITY = new Density(Double.POSITIVE_INFINITY, DensityUnit.SI);
43
44
45 public static final Density NEGATIVE_INFINITY = new Density(Double.NEGATIVE_INFINITY, DensityUnit.SI);
46
47
48 public static final Density POS_MAXVALUE = new Density(Double.MAX_VALUE, DensityUnit.SI);
49
50
51 public static final Density NEG_MAXVALUE = new Density(-Double.MAX_VALUE, DensityUnit.SI);
52
53
54
55
56
57
58 public Density(final double value, final DensityUnit unit)
59 {
60 super(value, unit);
61 }
62
63
64
65
66
67 public Density(final Density value)
68 {
69 super(value);
70 }
71
72 @Override
73 public final Density instantiateRel(final double value, final DensityUnit unit)
74 {
75 return new Density(value, unit);
76 }
77
78
79
80
81
82
83 public static final Density instantiateSI(final double value)
84 {
85 return new Density(value, DensityUnit.SI);
86 }
87
88
89
90
91
92
93
94
95 public static Density interpolate(final Density zero, final Density one, final double ratio)
96 {
97 return new Density(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
98 zero.getDisplayUnit());
99 }
100
101
102
103
104
105
106
107 public static Density max(final Density r1, final Density r2)
108 {
109 return r1.gt(r2) ? r1 : r2;
110 }
111
112
113
114
115
116
117
118
119 public static Density max(final Density r1, final Density r2, final Density... rn)
120 {
121 Density maxr = r1.gt(r2) ? r1 : r2;
122 for (Density r : rn)
123 {
124 if (r.gt(maxr))
125 {
126 maxr = r;
127 }
128 }
129 return maxr;
130 }
131
132
133
134
135
136
137
138 public static Density min(final Density r1, final Density r2)
139 {
140 return r1.lt(r2) ? r1 : r2;
141 }
142
143
144
145
146
147
148
149
150 public static Density min(final Density r1, final Density r2, final Density... rn)
151 {
152 Density minr = r1.lt(r2) ? r1 : r2;
153 for (Density r : rn)
154 {
155 if (r.lt(minr))
156 {
157 minr = r;
158 }
159 }
160 return minr;
161 }
162
163
164
165
166
167
168
169
170
171
172 public static Density valueOf(final String text)
173 {
174 Throw.whenNull(text, "Error parsing Density: text to parse is null");
175 Throw.when(text.length() == 0, IllegalArgumentException.class, "Error parsing Density: empty text to parse");
176 try
177 {
178 NumberParser numberParser = new NumberParser().lenient().trailing();
179 double d = numberParser.parseDouble(text);
180 String unitString = text.substring(numberParser.getTrailingPosition()).trim();
181 DensityUnit unit = DensityUnit.BASE.getUnitByAbbreviation(unitString);
182 if (unit == null)
183 throw new IllegalArgumentException("Unit " + unitString + " not found");
184 return new Density(d, unit);
185 }
186 catch (Exception exception)
187 {
188 throw new IllegalArgumentException(
189 "Error parsing Density from " + text + " using Locale " + Locale.getDefault(Locale.Category.FORMAT),
190 exception);
191 }
192 }
193
194
195
196
197
198
199
200
201
202 public static Density of(final double value, final String unitString)
203 {
204 Throw.whenNull(unitString, "Error parsing Density: unitString is null");
205 Throw.when(unitString.length() == 0, IllegalArgumentException.class, "Error parsing Density: empty unitString");
206 DensityUnit unit = DensityUnit.BASE.getUnitByAbbreviation(unitString);
207 if (unit != null)
208 {
209 return new Density(value, unit);
210 }
211 throw new IllegalArgumentException("Error parsing Density with unit " + unitString);
212 }
213
214
215
216
217
218
219 public final Dimensionless divide(final Density v)
220 {
221 return new Dimensionless(this.si / v.si, DimensionlessUnit.SI);
222 }
223
224
225
226
227
228
229 public final Mass times(final Volume v)
230 {
231 return new Mass(this.si * v.si, MassUnit.SI);
232 }
233
234
235
236
237
238
239 public final FlowMass times(final FlowVolume v)
240 {
241 return new FlowMass(this.si * v.si, FlowMassUnit.SI);
242 }
243
244 @Override
245 public SIScalar reciprocal()
246 {
247 return DoubleScalar.divide(Dimensionless.ONE, this);
248 }
249
250 }