Package org.djunits.value.vdouble.scalar

Class Area

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>

org.djunits.value.vdouble.scalar.base.DoubleScalarRel<AreaUnit,Area>

org.djunits.value.vdouble.scalar.Area

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Area>, Relative<AreaUnit,Area>, Value<AreaUnit,Area>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2025-09-06T15:16:28.380798Z")
public class Area
extends DoubleScalarRel<AreaUnit,Area>

Easy access methods for the Area DoubleScalar, which is relative by definition.

Copyright (c) 2013-2025 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

• Serialized Form

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.value.vdouble.scalar.base.DoubleScalar

si

Constructor Summary

Constructors

Constructor	Description
Area(double value, AreaUnit unit)	Construct Area scalar with a unit.
Area(Area value)	Construct Area scalar.

Method Summary

Modifier and Type	Method	Description
final Dimensionless	divide(Area v)	Calculate the division of Area and Area, which results in a Dimensionless scalar.
static Area	divide(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)	Divide two scalars that result in a scalar of type Area.
final Length	divide(Length v)	Calculate the division of Area and Length, which results in a Length scalar.
final Volume	divide(LinearDensity v)	Calculate the division of Area and LinearDensity, which results in a Volume scalar.
final LinearDensity	divide(Volume v)	Calculate the division of Area and Volume, which results in a LinearDensity scalar.
final Area	instantiateRel(double value, AreaUnit unit)	Construct a new Relative Immutable DoubleScalar of the right type.
static Area	interpolate(Area zero, Area one, double ratio)	Interpolate between two values.
static Area	max(Area r1, Area r2)	Return the maximum value of two relative scalars.
static Area	max(Area r1, Area r2, Area... rn)	Return the maximum value of more than two relative scalars.
static Area	min(Area r1, Area r2)	Return the minimum value of two relative scalars.
static Area	min(Area r1, Area r2, Area... rn)	Return the minimum value of more than two relative scalars.
static Area	multiply(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)	Multiply two scalars that result in a scalar of type Area.
static Area	of(double value, String unitString)	Returns a Area based on a value and the textual representation of the unit, which can be localized.
static final Area	ofSI(double value)	Construct Area scalar based on an SI value.
SIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final LuminousFlux	times(Illuminance v)	Calculate the multiplication of Area and Illuminance, which results in a LuminousFlux scalar.
final Volume	times(Length v)	Calculate the multiplication of Area and Length, which results in a Volume scalar.
final Length	times(LinearDensity v)	Calculate the multiplication of Area and LinearDensity, which results in a Length scalar.
final Force	times(Pressure v)	Calculate the multiplication of Area and Pressure, which results in a Force scalar.
final FlowVolume	times(Speed v)	Calculate the multiplication of Area and Speed, which results in a FlowVolume scalar.
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.value.vdouble.scalar.base.DoubleScalarRel

abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString

Methods inherited from class org.djunits.value.base.Scalar

format, format, getDisplayUnit, setDisplayUnit

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.Value

isAbsolute, isRelative

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,
 AreaUnit unit)

Construct Area scalar with a unit.

Parameters:

value - the double value, expressed in the given unit

unit - unit for the double value

Area

public Area(Area value)

Construct Area scalar.

Parameters:

value - Scalar from which to construct this instance

Method Details

instantiateRel

public final Area instantiateRel(double value,
 AreaUnit unit)

Description copied from class: DoubleScalarRel

Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateRel in class DoubleScalarRel<AreaUnit,Area>

Parameters:

value - the double value

unit - the unit

Returns:

R a new relative instance of the DoubleScalar of the right type

ofSI

public static final Area ofSI(double value)

Construct Area scalar based on an SI value.

Parameters:

value - the double value in SI units

Returns:

the new scalar with the SI value

interpolate

public static Area interpolate(Area zero,
 Area one,
 double ratio)

Interpolate between two values. Note that the first value does not have to be smaller than the second.

Parameters:

zero - the value at a ratio of zero

one - the value at a ratio of one

ratio - the ratio between 0 and 1, inclusive

Returns:

a Area at the given ratio between 0 and 1

max

public static Area max(Area r1,
 Area r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the maximum value of two relative scalars

max

public static Area max(Area r1,
 Area r2,
 Area... rn)

Return the maximum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the maximum value of more than two relative scalars

min

public static Area min(Area r1,
 Area r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the minimum value of two relative scalars

min

public static Area min(Area r1,
 Area r2,
 Area... rn)

Return the minimum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the minimum value of more than two relative scalars

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 value,
 String unitString)

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

Parameters:

value - the value to use

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

divide

public final 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

times

public final Volume times(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 final Volume divide(LinearDensity v)

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

Parameters:

v - scalar

Returns:

scalar as a division of Area and LinearDensity

divide

public final LinearDensity divide(Volume v)

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

Parameters:

v - scalar

Returns:

scalar as a division of Area and Volume

divide

public final 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

times

public final Length times(LinearDensity v)

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

Parameters:

v - scalar

Returns:

scalar as a multiplication of Area and LinearDensity

times

public final FlowVolume times(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

times

public final Force times(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

times

public final LuminousFlux times(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 SIScalar reciprocal()

Description copied from class: DoubleScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Overrides:

reciprocal in class DoubleScalarRel<AreaUnit,Area>

Returns:

a new scalar instance with correct SI dimensions

multiply

public static Area multiply(DoubleScalarRel<?,?> scalar1,
 DoubleScalarRel<?,?> scalar2)

Multiply two scalars that result in a scalar of type Area.

Parameters:

scalar1 - the first scalar

scalar2 - the second scalar

Returns:

the multiplication of both scalars as an instance of Area

divide

public static Area divide(DoubleScalarRel<?,?> scalar1,
 DoubleScalarRel<?,?> scalar2)

Divide two scalars that result in a scalar of type Area.

Parameters:

scalar1 - the first scalar

scalar2 - the second scalar

Returns:

the division of scalar1 by scalar2 as an instance of Area