openforcefield.utils.utils.check_units_are_compatible

openforcefield.utils.utils.check_units_are_compatible(object_name, object, unit_to_check, context=None)

Checks whether a simtk.unit.Quantity or list of simtk.unit.Quantitys is compatible with given unit.

Parameters

object_namestring

Name of object, used in printing exception.

objectA simtk.unit.Quantity or list of simtk.unit.Quantitys

unit_to_checkA simtk.unit.Unit

contextstring, optional. Default=None

Additional information to provide at the beginning of the exception message if raised

Raises

IncompatibleUnitError