Package etomica.units

Class CompoundUnit

java.lang.Object

etomica.units.CompoundUnit

All Implemented Interfaces:

Unit

Direct Known Subclasses:

UnitRatio

public class CompoundUnit
extends java.lang.Object
implements Unit

Unit formed from other units raised to specified powers. Used to construct unit when desired unit is not specifically implemented in an existing class. For example, a surface-tension unit in N/m could be created by constructing this class as

 new CompoundUnit(new Unit[] {Newton.UNIT, Meter.UNIT}, new double[] {1.0,-1.0});
 

Constructor Summary

Constructors

Constructor	Description
CompoundUnit(Unit[] units, double[] exponents)	Constructs unit with default name and abbreviation constructed from given units and exponents
CompoundUnit(Unit[] units, double[] exponents, java.lang.String name, java.lang.String symbol)

Method Summary

Modifier and Type	Method	Description
Dimension	dimension()	Returns the dimension of the unit.
double	fromSim(double x)	Takes the given value in simulation units and converts it to class units (considering prefix).
boolean	prefixAllowed()	Indicates if the unit is appropriate for use with a prefix.
java.lang.String	symbol()	Returns the symbol of unit, such as "g" for grams.
double	toSim(double x)	Takes the given value in class units (considering prefix) and converts it to simulation units.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompoundUnit

public CompoundUnit(Unit[] units,
                    double[] exponents)

Constructs unit with default name and abbreviation constructed from given units and exponents

Parameters:

units - array of units used to specify this unit

exponents - array exponents associated with each unit.

Throws:

java.lang.IllegalArgumentException - if argument arrays are of different length

CompoundUnit

public CompoundUnit(Unit[] units,
                    double[] exponents,
                    java.lang.String name,
                    java.lang.String symbol)

Parameters:

units - list of units used to specify this unit

exponents - exponents associated with each unit

name - a common name used to reference this unit (e.g., Newton)

symbol - an abbreviated name used to reference this unit (e.g., N)

Throws:

java.lang.IllegalArgumentException - if units and exponents arrays are of different length

Method Detail

dimension

public Dimension dimension()

Description copied from interface: Unit

Returns the dimension of the unit. For example, the dimension of grams is mass.

Specified by:

dimension in interface Unit

toSim

public double toSim(double x)

Description copied from interface: Unit

Takes the given value in class units (considering prefix) and converts it to simulation units.

Specified by:

toSim in interface Unit

Parameters:

x - a value in units of the class

Returns:

the value converted to simulation units

fromSim

public double fromSim(double x)

Description copied from interface: Unit

Takes the given value in simulation units and converts it to class units (considering prefix).

Specified by:

fromSim in interface Unit

Parameters:

x - a value in simulation units

Returns:

the value converted to units of the class

symbol

public java.lang.String symbol()

Description copied from interface: Unit

Returns the symbol of unit, such as "g" for grams.

Specified by:

symbol in interface Unit

prefixAllowed

public boolean prefixAllowed()

Description copied from interface: Unit

Indicates if the unit is appropriate for use with a prefix.

Specified by:

prefixAllowed in interface Unit