org.djunits.quantity.Area

All Implemented Interfaces:: Serializable, Comparable<Area>, Additive<Area>, Scalable<Area>, Value<Area>

public class Area extends Quantity<Area>

Area is a measure of a two-dimensional surface, expressed in square meters (m2).

Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djunits.org. The DJUNITS project is distributed under a three-clause BSD-style license.

Author:

Alexander Verbraeck

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

Area.Unit

Area.Unit encodes the area unit (length x length).
Field Summary

Fields

Modifier and Type

Field

Description

static final Area

NaN

Constant with value NaN.

static final Area

NEG_MAXVALUE

Constant with value -MAX_VALUE.

static final Area

NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

static final Area

ONE

Constant with value one.

static final Area

POS_MAXVALUE

Constant with value MAX_VALUE.

static final Area

POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

static final Area

ZERO

Constant with value zero.

Fields inherited from class org.djunits.quantity.def.Quantity
si
Constructor Summary

Constructors

Constructor

Description

Area(double valueInUnit, Area.Unit unit)

Instantiate a Area quantity expressed in the given unit.

Area(double value, Area.Unit displayUnit, boolean useSi)

Instantiate a Area quantity with an SI or base value and a display unit.
Method Summary

Modifier and Type

Method

Description

Dimensionless

divide(Area v)

Calculate the division of Area and Area, which results in a Dimensionless scalar.

Length

divide(Length v)

Calculate the division of Area and Length, which results in a Length scalar.

Volume

divide(LinearObjectDensity v)

Calculate the division of Area and LinearObjectDensity, which results in a Volume scalar.

LinearObjectDensity

divide(Volume v)

Calculate the division of Area and Volume, which results in a LinearObjectDensity scalar.

Area.Unit

getDisplayUnit()

Retrieve the unit of this Value.

Area

instantiateSi(double siValue, UnitInterface<Area> displayUnit)

Instantiate a quantity with an SI or base value, and a display unit.

Dimensionless

multiply(ArealObjectDensity v)

Calculate the multiplication of Area and ArealObjectDensity, which results in a Dimensionless scalar.

LuminousFlux

multiply(Illuminance v)

Calculate the multiplication of Area and Illuminance, which results in a LuminousFlux scalar.

Volume

multiply(Length v)

Calculate the multiplication of Area and Length, which results in a Volume scalar.

Length

multiply(LinearObjectDensity v)

Calculate the multiplication of Area and LinearObjectDensity, which results in a Length scalar.

Force

multiply(Pressure v)

Calculate the multiplication of Area and Pressure, which results in a Force scalar.

FlowVolume

multiply(Speed v)

Calculate the multiplication of Area and Speed, which results in a FlowVolume scalar.

static Area

of(double valueInUnit, String unitString)

Returns a Area based on a value and the textual representation of the unit, which can be localized.

static Area

of(double valueInUnit, Area.Unit unit)

Returns a Area based on a value expressed in the unit.

static Area

ofSi(double si)

Return a Area instance based on an SI value.

static Area

ofSi(double siValue, Area.Unit displayUnit)

Instantiate a Area quantity with an SI or base value and a display unit.

ArealObjectDensity

reciprocal()

Return the reciprocal of this quantity (1/q).

static Area

valueOf(String text)

Returns a Area representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.quantity.def.Quantity
abs, add, as, compareTo, divide, doubleValue, eq, eq0, equals, floatValue, format, format, format, ge, ge0, getInUnit, getInUnit, getName, gt, gt0, hashCode, instantiate, instantiateSi, interpolate, intValue, isRelative, le, le0, longValue, lt, lt0, max, mean, min, multiply, ne, ne0, negate, of, product, scaleBy, si, siUnit, subtract, sum, toString, valueOf

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.value.Scalable
divideBy

Methods inherited from interface org.djunits.value.Value
isAbsolute

Field Details
- ZERO
  
  public static final Area ZERO
  
  Constant with value zero.
- ONE
  
  public static final Area ONE
  
  Constant with value one.
- NaN
  
  public static final Area NaN
  
  Constant with value NaN.
- POSITIVE_INFINITY
  
  public static final Area POSITIVE_INFINITY
  
  Constant with value POSITIVE_INFINITY.
- NEGATIVE_INFINITY
  
  public static final Area NEGATIVE_INFINITY
  
  Constant with value NEGATIVE_INFINITY.
- POS_MAXVALUE
  
  public static final Area POS_MAXVALUE
  
  Constant with value MAX_VALUE.
- NEG_MAXVALUE
  
  public static final Area NEG_MAXVALUE
  
  Constant with value -MAX_VALUE.
Constructor Details
- Area
  
  public Area(double value, Area.Unit displayUnit, boolean useSi)
  
  Instantiate a Area quantity with an SI or base value and a display unit.
  
  Parameters:
  
  value - the quantity value expressed in the SI or base unit
  
  displayUnit - the display unit to use
  
  useSi - use SI value when true, use value in unit when false
- Area
  
  public Area(double valueInUnit, Area.Unit unit)
  
  Instantiate a Area quantity expressed in the given unit.
  
  Parameters:
  
  valueInUnit - the quantity value expressed in the given unit
  
  unit - the unit of the value, also acts as the display unit
Method Details
- ofSi
  
  public static Area ofSi(double si)
  
  Return a Area instance based on an SI value.
  
  Parameters:
  
  si - the si value
  
  Returns:
  
  the Area instance based on an SI value
- ofSi
  
  public static Area ofSi(double siValue, Area.Unit displayUnit)
  
  Instantiate a Area quantity with an SI or base value and a display unit.
  
  Parameters:
  
  siValue - the quantity value expressed in the SI or base unit
  
  displayUnit - the display unit to use
  
  Returns:
  
  the Area instance based on an SI value with the given display unit
- instantiateSi
  
  public Area instantiateSi(double siValue, UnitInterface<Area> displayUnit)
  
  Description copied from class: Quantity
  
  Instantiate a quantity with an SI or base value, and a display unit.
  
  Specified by:
  
  instantiateSi in class Quantity<Area>
  
  Parameters:
  
  siValue - the value expressed in the base (SI) unit
  
  displayUnit - the display unit to use for the quantity
  
  Returns:
  
  a quantity with the given SI or base value, and the given display unit
- valueOf
  
  public static Area valueOf(String text)
  
  Returns a Area 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.
  
  Parameters:
  
  text - the textual representation to parse into a Area
  
  Returns:
  
  the Scalar representation of the value in its unit
  
  Throws:
  
  IllegalArgumentException - when the text cannot be parsed
  
  NullPointerException - when the text argument is null
- of
  
  public static Area of(double valueInUnit, Area.Unit unit)
  
  Returns a Area based on a value expressed in the unit.
  
  Parameters:
  
  valueInUnit - the value, expressed in the given unit
  
  unit - the unit of the value, also acts as the display unit
  
  Returns:
  
  ab Area representation of the value in its unit
- of
  
  public static Area of(double valueInUnit, String unitString)
  
  Returns a Area based on a value and the textual representation of the unit, which can be localized.
  
  Parameters:
  
  valueInUnit - the value, expressed in the unit as given by unitString
  
  unitString - the textual representation of the unit
  
  Returns:
  
  the Scalar representation of the value in its unit
  
  Throws:
  
  IllegalArgumentException - when the unit cannot be parsed or is incorrect
  
  NullPointerException - when the unitString argument is null
- getDisplayUnit
  
  public Area.Unit getDisplayUnit()
  
  Description copied from interface: Value
  
  Retrieve the unit of this Value.
  
  Specified by:
  
  getDisplayUnit in interface Value<Area>
  
  Overrides:
  
  getDisplayUnit in class Quantity<Area>
  
  Returns:
  
  the unit of this Value
- divide
  
  public Dimensionless divide(Area v)
  
  Calculate the division of Area and Area, which results in a Dimensionless scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Area and Area
- multiply
  
  public Dimensionless multiply(ArealObjectDensity v)
  
  Calculate the multiplication of Area and ArealObjectDensity, which results in a Dimensionless scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a multiplication of Area and ArealObjectDensity
- multiply
  
  public Volume multiply(Length v)
  
  Calculate the multiplication of Area and Length, which results in a Volume scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a multiplication of Area and Length
- divide
  
  public Volume divide(LinearObjectDensity v)
  
  Calculate the division of Area and LinearObjectDensity, which results in a Volume scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Area and LinearObjectDensity
- divide
  
  public LinearObjectDensity divide(Volume v)
  
  Calculate the division of Area and Volume, which results in a LinearObjectDensity scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Area and Volume
- divide
  
  public Length divide(Length v)
  
  Calculate the division of Area and Length, which results in a Length scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Area and Length
- multiply
  
  public Length multiply(LinearObjectDensity v)
  
  Calculate the multiplication of Area and LinearObjectDensity, which results in a Length scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a multiplication of Area and LinearObjectDensity
- multiply
  
  public FlowVolume multiply(Speed v)
  
  Calculate the multiplication of Area and Speed, which results in a FlowVolume scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a multiplication of Area and Speed
- multiply
  
  public Force multiply(Pressure v)
  
  Calculate the multiplication of Area and Pressure, which results in a Force scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a multiplication of Area and Pressure
- multiply
  
  public LuminousFlux multiply(Illuminance v)
  
  Calculate the multiplication of Area and Illuminance, which results in a LuminousFlux scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a multiplication of Area and Illuminance
- reciprocal
  
  public ArealObjectDensity reciprocal()
  
  Description copied from class: Quantity
  
  Return the reciprocal of this quantity (1/q).
  
  Overrides:
  
  reciprocal in class Quantity<Area>
  
  Returns:
  
  the reciprocal of this quantity, with the correct SI units

Class Area

Nested Class Summary

Field Summary

Fields inherited from class org.djunits.quantity.def.Quantity

Constructor Summary

Method Summary

Methods inherited from class org.djunits.quantity.def.Quantity

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Methods inherited from interface org.djunits.value.Scalable

Methods inherited from interface org.djunits.value.Value

Field Details

ZERO

ONE

NaN

POSITIVE_INFINITY

NEGATIVE_INFINITY

POS_MAXVALUE

NEG_MAXVALUE

Constructor Details

Area

Area

Method Details

ofSi

ofSi

instantiateSi

valueOf

of

of

getDisplayUnit

divide

multiply

multiply

divide

divide

divide

multiply

multiply

multiply

multiply

reciprocal