fields.mixins.components.FieldComponentCoreMixin.to

FieldComponentCoreMixin.to(units: str | Unit, *args, equivalence: str | None = None, buffer_class: Type[BufferBase] | None = None, buffer_registry: BufferRegistry | None = None, as_array: bool = False, **kwargs)

Alias for in_units.

Returns a new buffer or array in the desired units.

Parameters:

• units (str or unyt.Unit) – Target units.

• as_array (bool, default False) – If True, return a raw array instead of a FieldComponent.

• equivalence (str, optional) – Unit conversion equivalence.

• buffer_class (type, optional) – Explicit buffer type override.

• buffer_registry (BufferRegistry, optional) – Custom registry for resolution.

• *args – Passed to .in_units.

• **kwargs – Passed to .in_units.

Return type:

FieldComponent or unyt_array