aim2dat.units.quantities¶

Module containing quantity classes.

Classes¶

`Energy`	Energy units.
`Force`	Force units.
`Frequency`	Frequency units.
`Length`	Length units.
`Pressure`	Pressure units.
`Wavevector`	Wavevector units.

Module Contents¶

class aim2dat.units.quantities.Energy(constants: str | dict = 'CODATA_2022', base_unit: str = None)[source]¶

Bases: _BaseQuantity

Energy units.

Overview

Properties¶
`available_units`	List of all available units.

Methods¶
`get_unit`(unit)	Return the value of the unit.

property available_units : list[str]¶: List of all available units.

get_unit(unit: str) → float¶

Return the value of the unit.

Parameters:¶: unit (str) – Physical unit.
Returns:¶: float – Value of the unit.

class aim2dat.units.quantities.Force(constants: str | dict = 'CODATA_2022', base_unit: str = None)[source]¶

Bases: _BaseQuantity

Force units.

Overview

Properties¶
`available_units`	List of all available units.

Methods¶
`get_unit`(unit)	Return the value of the unit.

property available_units : list[str]¶: List of all available units.

get_unit(unit: str) → float¶

Return the value of the unit.

Parameters:¶: unit (str) – Physical unit.
Returns:¶: float – Value of the unit.

class aim2dat.units.quantities.Frequency(constants: str | dict = 'CODATA_2022', base_unit: str = None)[source]¶

Bases: _BaseQuantity

Frequency units.

Overview

Properties¶
`available_units`	List of all available units.

Methods¶
`get_unit`(unit)	Return the value of the unit.

property available_units : list[str]¶: List of all available units.

get_unit(unit: str) → float¶

Return the value of the unit.

Parameters:¶: unit (str) – Physical unit.
Returns:¶: float – Value of the unit.

class aim2dat.units.quantities.Length(constants: str | dict = 'CODATA_2022', base_unit: str = None)[source]¶

Bases: _BaseQuantity

Length units.

Overview

Properties¶
`available_units`	List of all available units.

Methods¶
`get_unit`(unit)	Return the value of the unit.

property available_units : list[str]¶: List of all available units.

get_unit(unit: str) → float¶

Return the value of the unit.

Parameters:¶: unit (str) – Physical unit.
Returns:¶: float – Value of the unit.

class aim2dat.units.quantities.Pressure(constants: str | dict = 'CODATA_2022', base_unit: str = None)[source]¶

Bases: _BaseQuantity

Pressure units.

Overview

Properties¶
`available_units`	List of all available units.

Methods¶
`get_unit`(unit)	Return the value of the unit.

property available_units : list[str]¶: List of all available units.

get_unit(unit: str) → float¶

Return the value of the unit.

Parameters:¶: unit (str) – Physical unit.
Returns:¶: float – Value of the unit.

class aim2dat.units.quantities.Wavevector(constants: str | dict = 'CODATA_2022', base_unit: str = None)[source]¶

Bases: _BaseQuantity

Wavevector units.

Overview

Properties¶
`available_units`	List of all available units.

Methods¶
`get_unit`(unit)	Return the value of the unit.

property available_units : list[str]¶: List of all available units.

get_unit(unit: str) → float¶

Return the value of the unit.

Parameters:¶: unit (str) – Physical unit.
Returns:¶: float – Value of the unit.