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