BioSimSpace.Types.Charge

class BioSimSpace.Types.Charge(*args)

A charge type.

__init__(*args)

Constructor.

*args can be a magnitude and unit, or a string representation of the charge, e.g. “0.2 e”.

Parameters
  • magnitude (float) – The magnitude.

  • unit (str) – The unit.

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

Examples

Create an object representing a charge of 27.8 electron charge print the charge in Coulomb.

>>> import BioSimSpace as BSS
>>> charge = BSS.Types.Charge(27.8, "e")
>>> print(charge.coulomb())

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

>>> import BioSimSpace as BSS
>>> charge = BSS.Types.Charge("3.1 atm")
>>> print(charge.coulomb())

The string matching is extremeley flexible, so all of the following would be valid arguments: “27.8 e”, “27.8 electron charge”, “2.78e1 e”.

Methods

__add__(other)

Addition operator.

__delattr__

Implement delattr(self, name).

__dir__

Default dir() implementation.

__eq__(other)

Equals to operator.

__format__

Default object formatter.

__ge__(other)

Greater than or equal to operator.

__getattribute__

Return getattr(self, name).

__gt__(other)

Gretear than operator.

__init__(*args)

Constructor.

__init_subclass__

This method is called when a class is subclassed.

__le__(other)

Less than or equal to operator.

__lt__(other)

Less than operator.

__mul__(other)

Multiplication operator.

__ne__(other)

Not equals to operator.

__neg__()

Unary - operator.

__new__

Create and return a new object.

__pos__()

Unary + operator.

__reduce__

Helper for pickle.

__reduce_ex__

Helper for pickle.

__repr__()

Return a human readable string representation of the object.

__rmul__(other)

Multiplication operator.

__setattr__

Implement setattr(self, name, value).

__sizeof__

Size of object in memory, in bytes.

__str__()

Return a human readable string representation of the object.

__sub__(other)

Subtraction operator.

__subclasshook__

Abstract classes can override this to customize issubclass().

__truediv__(other)

Division operator.

_convert_to(unit)

Return the charge in a different unit.

_default_unit([mag])

Internal method to return an object of the same type in the default unit.

_from_string(string)

Convert a string to an object of the same type.

_validate_unit(unit)

Validate that the unit are supported.

coulomb()

Return the charge in Coulomb.

electron_charge()

Return the charge in electron charge.

magnitude()

Return the magnitude.

unit()

Return the unit.

Attributes

__dict__

__doc__

__hash__

__module__

__weakref__

list of weak references to the object (if defined)

_abbreviations

_doc_strings

_null_unit

_print_format

_supported_units