package org.djunits.quantity;
   
   import org.djunits.quantity.def.Quantity;
   import org.djunits.unit.AbstractUnit;
   import org.djunits.unit.UnitInterface;
   import org.djunits.unit.UnitRuntimeException;
   import org.djunits.unit.Unitless;
   import org.djunits.unit.scale.LinearScale;
   import org.djunits.unit.scale.Scale;
  import org.djunits.unit.si.SIPrefix;
  import org.djunits.unit.si.SIUnit;
  import org.djunits.unit.system.UnitSystem;
  
  /**
   * Volume is the amount of three-dimensional space occupied by matter, measured in cubic meters (m3).
   * <p>
   * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
   * for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
   * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
   * @author Alexander Verbraeck
   */
  public class Volume extends Quantity<Volume>
  {
      /** Constant with value zero. */
      public static final Volume ZERO = ofSi(0.0);
  
      /** Constant with value one. */
      public static final Volume ONE = ofSi(1.0);
  
      /** Constant with value NaN. */
      @SuppressWarnings("checkstyle:constantname")
      public static final Volume NaN = ofSi(Double.NaN);
  
      /** Constant with value POSITIVE_INFINITY. */
      public static final Volume POSITIVE_INFINITY = ofSi(Double.POSITIVE_INFINITY);
  
      /** Constant with value NEGATIVE_INFINITY. */
      public static final Volume NEGATIVE_INFINITY = ofSi(Double.NEGATIVE_INFINITY);
  
      /** Constant with value MAX_VALUE. */
      public static final Volume POS_MAXVALUE = ofSi(Double.MAX_VALUE);
  
      /** Constant with value -MAX_VALUE. */
      public static final Volume NEG_MAXVALUE = ofSi(-Double.MAX_VALUE);
  
      /** */
      private static final long serialVersionUID = 600L;
  
      /**
       * Instantiate a Volume quantity with an SI or base value and a display unit.
       * @param value the quantity value expressed in the SI or base unit
       * @param displayUnit the display unit to use
       * @param useSi use SI value when true, use value in unit when false
       */
      public Volume(final double value, final Volume.Unit displayUnit, final boolean useSi)
      {
          super(value, displayUnit, useSi);
      }
  
      /**
       * Instantiate a Volume quantity expressed in the given unit.
       * @param valueInUnit the quantity value expressed in the given unit
       * @param unit the unit of the value, also acts as the display unit
       */
      public Volume(final double valueInUnit, final Volume.Unit unit)
      {
          this(valueInUnit, unit, false);
      }
  
      /**
       * Return a Volume instance based on an SI value.
       * @param si the si value
       * @return the Volume instance based on an SI value
       */
      public static Volume ofSi(final double si)
      {
          return new Volume(si, Volume.Unit.SI, true);
      }
  
      /**
       * Instantiate a Volume quantity with an SI or base value and a display unit.
       * @param siValue the quantity value expressed in the SI or base unit
       * @param displayUnit the display unit to use
       * @return the Volume instance based on an SI value with the given display unit
       */
      public static Volume ofSi(final double siValue, final Volume.Unit displayUnit)
      {
          return new Volume(siValue, displayUnit, true);
      }
  
      @Override
      public Volume instantiateSi(final double siValue, final UnitInterface<Volume> displayUnit)
      {
          return new Volume(siValue, (Volume.Unit) displayUnit, true);
      }
  
      /**
       * Returns a Volume representation of a textual representation of a value with a unit. The String representation that can be
       * parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are allowed,
      * but not required, between the value and the unit.
      * @param text the textual representation to parse into a Volume
      * @return the Scalar representation of the value in its unit
      * @throws IllegalArgumentException when the text cannot be parsed
      * @throws NullPointerException when the text argument is null
      */
     public static Volume valueOf(final String text)
     {
         return Quantity.valueOf(text, ZERO);
     }
 
     /**
      * Returns a Volume based on a value expressed in the unit.
      * @param valueInUnit the value, expressed in the given unit
      * @param unit the unit of the value, also acts as the display unit
      * @return ab Volume representation of the value in its unit
      */
     public static Volume of(final double valueInUnit, final Volume.Unit unit)
     {
         return new Volume(valueInUnit, unit);
     }
 
     /**
      * Returns a Volume based on a value and the textual representation of the unit, which can be localized.
      * @param valueInUnit the value, expressed in the unit as given by unitString
      * @param unitString the textual representation of the unit
      * @return the Scalar representation of the value in its unit
      * @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
      * @throws NullPointerException when the unitString argument is null
      */
     public static Volume of(final double valueInUnit, final String unitString)
     {
         return Quantity.of(valueInUnit, unitString, ZERO);
     }
 
     @Override
     public Volume.Unit getDisplayUnit()
     {
         return (Volume.Unit) super.getDisplayUnit();
     }
 
     /**
      * Calculate the division of Volume and Volume, which results in a Dimensionless scalar.
      * @param v scalar
      * @return scalar as a division of Volume and Volume
      */
     public Dimensionless divide(final Volume v)
     {
         return new Dimensionless(this.si() / v.si(), Unitless.BASE);
     }
 
     /**
      * Calculate the multiplication of Volume and Density, which results in a Mass scalar.
      * @param v scalar
      * @return scalar as a multiplication of Volume and Density
      */
     public Mass multiply(final Density v)
     {
         return new Mass(this.si() * v.si(), Mass.Unit.SI);
     }
 
     /**
      * Calculate the multiplication of Volume and Pressure, which results in a Energy scalar.
      * @param v scalar
      * @return scalar as a multiplication of Volume and Pressure
      */
     public Energy multiply(final Pressure v)
     {
         return new Energy(this.si() * v.si(), Energy.Unit.SI);
     }
 
     /**
      * Calculate the division of Volume and Length, which results in a Area scalar.
      * @param v scalar
      * @return scalar as a division of Volume and Length
      */
     public Area divide(final Length v)
     {
         return new Area(this.si() / v.si(), Area.Unit.SI);
     }
 
     /**
      * Calculate the division of Volume and Area, which results in a Length scalar.
      * @param v scalar
      * @return scalar as a division of Volume and Area
      */
     public Length divide(final Area v)
     {
         return new Length(this.si() / v.si(), Length.Unit.SI);
     }
 
     /**
      * Calculate the multiplication of Volume and LinearObjectDensity, which results in a Area scalar.
      * @param v scalar
      * @return scalar as a multiplication of Volume and LinearObjectDensity
      */
     public Area multiply(final LinearObjectDensity v)
     {
         return new Area(this.si() * v.si(), Area.Unit.SI);
     }
 
     /**
      * Calculate the division of Volume and Duration, which results in a FlowVolume scalar.
      * @param v scalar
      * @return scalar as a division of Volume and Duration
      */
     public FlowVolume divide(final Duration v)
     {
         return new FlowVolume(this.si() / v.si(), FlowVolume.Unit.SI);
     }
 
     /**
      * Calculate the division of Volume and FlowVolume, which results in a Duration scalar.
      * @param v scalar
      * @return scalar as a division of Volume and FlowVolume
      */
     public Duration divide(final FlowVolume v)
     {
         return new Duration(this.si() / v.si(), Duration.Unit.SI);
     }
 
     @Override
     public VolumetricObjectDensity reciprocal()
     {
         return VolumetricObjectDensity.ofSi(1.0 / this.si());
     }
 
     /******************************************************************************************************/
     /********************************************** UNIT CLASS ********************************************/
     /******************************************************************************************************/
 
     /**
      * Volume.Unit encodes the volume unit (length x length x length).
      * <p>
      * Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved.
      * See for project information <a href="https://djunits.org" target="_blank">https://djunits.org</a>. The DJUNITS project is
      * distributed under a <a href="https://djunits.org/docs/license.html" target="_blank">three-clause BSD-style license</a>.
      * @author Alexander Verbraeck
      */
     @SuppressWarnings("checkstyle:constantname")
     public static class Unit extends AbstractUnit<Volume>
     {
         /** Constant for the cubic inch. */
         public static final double CONST_CUBIC_INCH = cubed(Length.Unit.CONST_IN);
 
         /** Constant for the cubic foot. */
         public static final double CONST_CUBIC_FOOT = cubed(Length.Unit.CONST_FT);
 
         /** Constant for the cubic yard. */
         public static final double CONST_CUBIC_YARD = cubed(Length.Unit.CONST_YD);
 
         /** Constant for the imperial gallon. */
         public static final double CONST_GALLON_IMP = 4.54609E-3;
 
         /** Constant for imperial fluid ounce. */
         public static final double CONST_OZ_IMP = CONST_GALLON_IMP / 160.0;
 
         /** Constant for US gallon. */
         public static final double CONST_GALLON_US = 231.0 * CONST_CUBIC_INCH;
 
         /** Constant for US fluid ounce. */
         public static final double CONST_OZ_US = CONST_GALLON_US / 128.0;
 
         /** The dimensions of Volume: m3. */
         public static final SIUnit SI_UNIT = SIUnit.of("m3");
 
         /** Cubic meter. */
         public static final Volume.Unit m3 = new Volume.Unit("m3", "cubic meter", 1.0, UnitSystem.SI_BASE);
 
         /** The SI or BASE unit. */
         public static final Volume.Unit SI = m3;
 
         /** mm^3. */
         public static final Volume.Unit mm3 = m3.deriveUnit("mm3", "cubic millimeter", 1.0E-9, UnitSystem.SI_BASE);
 
         /** cm^3. */
         public static final Volume.Unit cm3 = m3.deriveUnit("cm3", "cubic centimeter", 1.0E-6, UnitSystem.SI_BASE);
 
         /** dm^3. */
         public static final Volume.Unit dm3 = m3.deriveUnit("dm3", "cubic decimeter", 1.0E-3, UnitSystem.SI_BASE);
 
         /** dam^3. */
         public static final Volume.Unit dam3 = m3.deriveUnit("dam3", "cubic decameter", 1.0E3, UnitSystem.SI_BASE);
 
         /** hm^3. */
         public static final Volume.Unit hm3 = m3.deriveUnit("hm3", "cubic hectometer", 1.0E6, UnitSystem.SI_BASE);
 
         /** km^3. */
         public static final Volume.Unit km3 = m3.deriveUnit("km3", "cubic kilometer", 1.0E9, UnitSystem.SI_BASE);
 
         /** in^3. */
         public static final Volume.Unit in3 = m3.deriveUnit("in3", "cubic inch", CONST_CUBIC_INCH, UnitSystem.IMPERIAL);
 
         /** ft^3. */
         public static final Volume.Unit ft3 = m3.deriveUnit("ft3", "cubic foot", CONST_CUBIC_FOOT, UnitSystem.IMPERIAL);
 
         /** yd^3. */
         public static final Volume.Unit yd3 = m3.deriveUnit("yd3", "cubic yard", CONST_CUBIC_YARD, UnitSystem.IMPERIAL);
 
         /** mile^3. */
         public static final Volume.Unit mi3 =
                 m3.deriveUnit("mi3", "cubic mile", cubed(Length.Unit.CONST_MI), UnitSystem.IMPERIAL);
 
         /** Nautical mile^3. */
         public static final Volume.Unit NM3 =
                 m3.deriveUnit("NM3", "cubic Nautical Mile", cubed(Length.Unit.CONST_NM), UnitSystem.OTHER);
 
         /** liter. */
         public static final Volume.Unit L = dm3.deriveUnit("L", "liter", 1.0, UnitSystem.SI_ACCEPTED);
 
         /** gallon (US), fluids. */
         public static final Volume.Unit gal_US =
                 m3.deriveUnit("gal(US)", "gallon (US)", CONST_GALLON_US, UnitSystem.US_CUSTOMARY);
 
         /** gallon (imperial). */
         public static final Volume.Unit gal_imp =
                 m3.deriveUnit("gal(imp)", "gallon (imp)", CONST_GALLON_IMP, UnitSystem.IMPERIAL);
 
         /** quart (fluid US) = 1/4 US gallon. */
         public static final Volume.Unit qt_US = gal_US.deriveUnit("qt(US)", "quart (US)", 0.25, UnitSystem.US_CUSTOMARY);
 
         /** quart (imperial) = 1/4 imp gallon. */
         public static final Volume.Unit qt_imp = gal_imp.deriveUnit("qt(imp)", "quart (imp)", 0.25, UnitSystem.IMPERIAL);
 
         /** pint (fluid US) = 1/2 US quart. */
         public static final Volume.Unit pt_US = qt_US.deriveUnit("pt(US)", "pint (US)", 0.5, UnitSystem.US_CUSTOMARY);
 
         /** pint (imperial) = 1/2 imp quart. */
         public static final Volume.Unit pt_imp = qt_imp.deriveUnit("pt(imp)", "pint (imp)", 0.5, UnitSystem.IMPERIAL);
 
         /** ounce (fluid US) = 1/16 US pint. */
         public static final Volume.Unit fl_oz_US =
                 m3.deriveUnit("fl.oz(US)", "fluid ounce (US)", CONST_OZ_US, UnitSystem.US_CUSTOMARY);
 
         /** ounce (fluid imperial) = 1/20 imp pint. */
         public static final Volume.Unit fl_oz_imp =
                 m3.deriveUnit("fl.oz(imp)", "fluid ounce (imp)", CONST_OZ_IMP, UnitSystem.IMPERIAL);
 
         /** Cubic lightyear. */
         public static final Volume.Unit ly3 =
                 m3.deriveUnit("ly3", "cubic lightyear", cubed(Length.Unit.CONST_LY), UnitSystem.OTHER);
 
         /** Cubic Parsec. */
         public static final Volume.Unit pc3 =
                 m3.deriveUnit("pc3", "cubic Parsec", cubed(Length.Unit.CONST_PC), UnitSystem.OTHER);
 
         /**
          * Create a new Volume unit.
          * @param id the id or main abbreviation of the unit
          * @param name the full name of the unit
          * @param scaleFactorToBaseUnit the scale factor of the unit to convert it TO the base (SI) unit
          * @param unitSystem the unit system such as SI or IMPERIAL
          */
         public Unit(final String id, final String name, final double scaleFactorToBaseUnit, final UnitSystem unitSystem)
         {
             super(id, name, scaleFactorToBaseUnit, unitSystem);
         }
 
         /**
          * Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.
          * @param textualAbbreviation the textual abbreviation of the unit, which doubles as the id
          * @param displayAbbreviation the display abbreviation of the unit
          * @param name the full name of the unit
          * @param scale the scale to use to convert from this unit to the standard (e.g., SI, BASE) unit
          * @param unitSystem unit system, e.g. SI or Imperial
          * @param siPrefix the SI Prefix of this unit
          */
         public Unit(final String textualAbbreviation, final String displayAbbreviation, final String name, final Scale scale,
                 final UnitSystem unitSystem, final SIPrefix siPrefix)
         {
             super(textualAbbreviation, displayAbbreviation, name, scale, unitSystem, siPrefix);
         }
 
         @Override
         public SIUnit siUnit()
         {
             return SI_UNIT;
         }
 
         @Override
         public Unit getBaseUnit()
         {
             return SI;
         }
 
         @Override
         public Volume ofSi(final double si, final UnitInterface<Volume> displayUnit)
         {
             return new Volume(si, (Unit) displayUnit, true);
         }
 
         @Override
         public Volume.Unit deriveUnit(final String textualAbbreviation, final String displayAbbreviation, final String name,
                 final double scaleFactor, final UnitSystem unitSystem, final SIPrefix siPrefix)
         {
             if (getScale() instanceof LinearScale ls)
             {
                 return new Volume.Unit(textualAbbreviation, displayAbbreviation, name,
                         new LinearScale(ls.getScaleFactorToBaseUnit() * scaleFactor), unitSystem, siPrefix);
             }
             throw new UnitRuntimeException("Only possible to derive a unit from a unit with a linear scale");
         }
 
         @Override
         public Volume.Unit deriveUnit(final String abbreviation, final String name, final double scaleFactor,
                 final UnitSystem unitSystem)
         {
             return (Unit) super.deriveUnit(abbreviation, name, scaleFactor, unitSystem);
         }
 
         /**
          * Return the cubed value of the argument.
          * @param x the value to cube
          * @return x^3
          */
         private static double cubed(final double x)
         {
             return x * x * x;
         }
     }
 }