Units - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Science and Engineering : Units : Manipulating Units : Units/AddUnit

Units

  

AddUnit

  

add or modify a unit

 

Calling Sequence

Parameters

Description

Examples

Calling Sequence

AddUnit(unit, opts)

Parameters

unit

-

symbol; unit name

opts

-

equation(s) of the form option=value where option is one of 'abbreviation', 'abbreviations', 'check', 'context', 'conversion', 'default', 'plural', 'prefix', 'spelling', 'spellings', 'symbol', or 'symbols'; specify options for the unit

Description

• 

The AddUnit(unit, opts) function adds or redefines a unit in the current session.

• 

To add or redefine a unit in all future Maple sessions, add the AddUnit command to your Maple initialization file. For more information, see Create Maple Initialization File.

• 

No new unit name or unit symbol may evaluate to any of the symbols in the following list.

true

false

undefined

infinity

energy

default

symbolic

base

check

context

dimension

name

none

 

 

 

• 

The opts argument can contain one or more of the following equations that set unit options.

  

 

  

'abbreviation'=symbol

  

This option sets the default abbreviation of the unit for display. The special option value none indicates that there is no default abbreviation. If this option is not given, the default abbreviation is chosen from the 'abbreviations' option (if any).

  

It is invalid for the option 'abbreviation' to appear without a 'context' option.

  

 

  

'abbreviations'=symbol or set(symbol)

  

This option sets the list of abbreviations (other than the default which is set by the 'abbreviation' option) for the unit.

  

An abbreviation is similar to a symbol, except that it encompasses both the unit name and the context, whereas a unit symbol is valid for any context.

  

For example, the technical atmosphere (atmospheretechnical) has the abbreviation at, whereas the unit name atmosphere has the unit symbols atm and atmos. Thus, atm[technical] refers to technical atmospheres, but atstandard does not refer to standard atmospheres.

  

It is invalid for the option 'abbreviations' to appear without a 'context' option.

  

 

  

'check'=truefalse

  

This option determines whether the added unit name, symbol, and abbreviation are compared with existing unit names, symbols, abbreviations, and spellings. The default value of 'check' is true. An error is returned and the unit is not added if there is a conflict.

  

For example, if a user attempts to add a new unit with an abbreviation Ys or a unit with the symbol Ys and the context SI, it conflicts with the symbol for the yottasecond. Unless the 'check'=false option is included, the AddUnit routine returns an error and does not add the unit. However, a unit with the symbol Ys and a context different from SI can be added without conflict. In this case, Ys refers to the new unit and YsSI is required to refer to the yottasecond. A new unit with the name Ys does not conflict with the yottasecond. However, to refer to the new unit, the user must include its context, for example, Ysnew, because Ys refers to the yottasecond.

  

 

  

'context'=symbol

  

This option specifies the context of the unit.  In this way, two units with the same name but different values can be distinguished. This option is required if a 'conversion', 'abbreviation', or 'abbreviations' option is given or the unit is new.

  

 

  

'conversion'=algebraic

  

This is a conversion with respect to existing units. This option is required if the unit is new.

  

 

  

'default'=truefalse

  

For a unit with a context set as the default, the use of the unit name or an associated unit symbol without a context or modifier refers to its context.

  

The default value of 'default' is false. If no unit context is set as the default, the setting of this option to false is ignored.

  

This option must be used in conjunction with the 'context' option.

  

 

  

'plural'=symbol

  

This option sets the default unit plural spelling for display.  If this option is not given, the argument unit is used as the default plural spelling.

  

 

  

'prefix'=prefix_style

  

This option species what type of prefixes the given unit takes. This option can be set to false (explicitly indicating that the unit does not take prefixes), SI, IEC, SI_positive, SI_negative, or a set of symbols that is a subset of either SI prefixes or IEC prefixes.

  

The values SI_positive and SI_negative specify units that take only prefixes that are positive powers of ten or negative powers of ten, respectively.  For example, it is common to refer to

  

milliliters and centiliters but not kiloliters (cubic meters). Similarly, it is common to refer to kilotonnes and megatonnes but not millitonnes (kilograms).

  

 

  

'spelling'=symbol

  

This option sets the default unit spelling for display.  If this option is not given, the argument unit is used as the default spelling.

  

 

  

'spellings'=symbol or set(symbol)

  

To accommodate regionalized spellings of units, for example, meter versus metre, a facility has been included that allows the Units package to accept various spellings of units.  Any symbol given to the 'spelling' option is treated as unit.

  

For example, by default, the accepted alternate spellings of the meter are: metre, meters, and metres.

  

 

  

'symbol'=symbol

  

This option sets the default unit symbol for display.  If this option is not given, the default symbol (if any) will be chosen from the option 'symbols'.

  

The special option value none indicates that there is no default symbol.

  

 

  

'symbols'=symbol or set(symbol)

  

A unit symbol can be used in place of a unit name.  For units that take SI or IEC prefixes, any associated symbols take the associated symbol prefix.

  

For example, milliliter is equivalent to mL and Kibibyte is equivalent to KiB.

Examples

withUnits:

Add Polish nominative spellings of the meter, and the French spelling of the foot.

AddUnit'meter','spellings'='metr','metry'

AddUnit'foot','spellings'='pied'

convert1.0,'units','centimetry'2,'pied'2

0.001076391042

(1)

The default spellings of the meter and liter are American.   This changes them to the international spelling.

AddUnit'metre','spelling'='metre','plural'='metres'

AddUnit'litre','spelling'='litre','plural'='litres'

convert'L','m'3,'conversion_table','output'='grid'

To:Lm3Unit NameSymbollitresL 111000cubic metresm3 10001

(2)

See Also

convert

Create Maple Initialization File

Units

Units/Commands

Units/Index

Units[AddBaseUnit]

Units[GetUnit]

Units[GetUnits]

Units[HasUnit]

 


Download Help Document

Was this information helpful?



Please add your Comment (Optional)
E-mail Address (Optional)
What is ? This question helps us to combat spam