fields.mixins.components.FieldComponentCoreMixin.convert_to_base#

FieldComponentCoreMixin.convert_to_base(unit_system: str | None = None, equivalence: str | None = None, **kwargs)[source]#

Convert the buffer to base units of a given system (in-place).

This is shorthand for converting to the base unit equivalent using unyt logic.

Parameters:
  • unit_system (str, optional) – Target unit system (“mks”, “cgs”, etc.). Defaults to MKS if not given.

  • equivalence (str, optional) – Optional equivalence to apply.

  • **kwargs – Extra options forwarded to the equivalence logic.

Raises:
  • UnitConversionError – If base unit conversion is invalid.

  • NotImplementedError – If the buffer does not support unit conversion.