def validate_charge(cls, charge):
"""Check to see that a charge is a unyt array of the right dimension"""
if not isinstance(charge, u.unyt_array):
warnings.warn(
UNIT_WARNING_STRING.format('Charges', 'elementary charge'))
charge *= u.elementary_charge
else:
ensure_valid_dimensions(charge, u.elementary_charge)
return charge
def validate_mass(cls, mass):
"""Check to see that a mass is a unyt array of the right dimension"""
default_mass_units = u.gram / u.mol
if not isinstance(mass, u.unyt_array):
warnings.warn(UNIT_WARNING_STRING.format('Masses', 'g/mol'))
mass *= u.gram / u.mol
else:
ensure_valid_dimensions(mass, default_mass_units)
return mass
def is_valid_mass(cls, mass):
if mass is None:
return None
default_mass_units = u.gram / u.mol
if not isinstance(mass, u.unyt_array):
warnings.warn(UNIT_WARNING_STRING.format('Masses', 'g/mol'))
mass *= default_mass_units
else:
ensure_valid_dimensions(mass, default_mass_units)
return mass
def is_valid_mass(cls, mass):
"""Ensure that the mass is physically meaningful."""
if mass is None:
return None
default_mass_units = u.gram / u.mol
if not isinstance(mass, u.unyt_array):
warnings.warn(UNIT_WARNING_STRING.format("Masses", "g/mol"))
mass *= default_mass_units
else:
ensure_valid_dimensions(mass, default_mass_units)
return mass
def is_valid_charge(cls, charge):
if charge is None:
return None
if not isinstance(charge, u.unyt_array):
warnings.warn(
UNIT_WARNING_STRING.format('Charges', 'elementary charge'))
charge *= u.elementary_charge
else:
ensure_valid_dimensions(charge, u.elementary_charge)
return charge
def is_valid_charge(cls, charge):
"""Ensure that the charge is physically meaningful."""
if charge is None:
return None
if not isinstance(charge, u.unyt_array):
warnings.warn(
UNIT_WARNING_STRING.format("Charges", "elementary charge"))
charge *= u.elementary_charge
else:
ensure_valid_dimensions(charge, u.elementary_charge)
return charge
