BioSimSpace.Types.Volume

class BioSimSpace.Types.Volume(*args)

A volume type.

__init__(*args)

Constructor.

*args can be a value and unit, or a string representation of the volume, e.g. “100 pm^3”.

Parameters
  • value (float) – The value.

  • unit (str) – The unit.

  • string (str) – A string representation of the volume.

Examples

Create an object representing a volume of 100 cube nanometers then print the volume in cube Angstrom.

>>> import BioSimSpace as BSS
>>> volume = BSS.Types.Volume(100, "nm^3")
>>> print(volume.angstroms3())

The same as above, except passing a string representation of the volume to the constructor.

>>> import BioSimSpace as BSS
>>> volume = BSS.Types.Volume("100 nm^3")
>>> print(volume.angstroms3())

The string matching is extremeley flexible, so all of the following would be valid arguments: “100 nm^3”, “100 cube nanometers”, “100 nanometers cubed”.

Methods

__init__(*args)

Constructor.

angle()

Return the power in the ‘angle’ dimension.

angstroms3()

Return the volume in cubic Angstrom.

charge()

Return the power in the ‘charge’ dimension.

dimensions()

Return the dimensions of this type.

length()

Return the power in the ‘length’ dimension.

mass()

Return the power in the ‘mass’ dimension.

meters3()

Return the volume in cubic meters.

nanometers3()

Return the volume in cubic nanometers.

picometers3()

Return the volume in cubic picometers.

quantity()

Return the power in the ‘quantity’ dimension.

temperature()

Return the power in the ‘temperature’ dimension.

time()

Return the power in the ‘time’ dimension.

unit()

Return the unit.

value()

Return the value.

classmethod angle()

Return the power in the ‘angle’ dimension.

Returns

angle – The power in the ‘angle’ dimension.

Return type

int

angstroms3()

Return the volume in cubic Angstrom.

Returns

volume – The volume in cubic Angstrom.

Return type

Volume

classmethod charge()

Return the power in the ‘charge’ dimension.

Returns

charge – The power in the ‘charge’ dimension.

Return type

int

classmethod dimensions()

Return the dimensions of this type. This is a tuple containing the power in each dimension.

Returns(int, int, int, int, int, int)

The power in each dimension: ‘angle’, ‘charge’, ‘length’, ‘mass’, ‘quantity’, ‘temperature’, and ‘time’.

classmethod length()

Return the power in the ‘length’ dimension.

Returns

length – The power in the ‘length’ dimension.

Return type

int

classmethod mass()

Return the power in the ‘mass’ dimension.

Returns

mass – The power in the ‘mass’ dimension.

Return type

int

meters3()

Return the volume in cubic meters.

Returns

volume – The volume in cubic meters.

Return type

Volume

nanometers3()

Return the volume in cubic nanometers.

Returns

volume – The volume in cubic nanometers.

Return type

Volume

picometers3()

Return the volume in cubic picometers.

Returns

volume – The volume in cubic picometers.

Return type

Volume

classmethod quantity()

Return the power in the ‘quantity’ dimension.

Returns

quantity – The power in the ‘quantity’ dimension.

Return type

int

classmethod temperature()

Return the power in the ‘temperature’ dimension.

Returns

temperature – The power in the ‘temperature’ dimension.

Return type

int

classmethod time()

Return the power in the ‘time’ dimension.

Returns

time – The power the ‘time’ dimension.

Return type

int

unit()

Return the unit.

Returns

unit – The unit of the type.

Return type

str

value()

Return the value.

Returns

value – The value of the type.

Return type

float