Karana.KUtils.Kquantities

Karana.KUtils.Kquantities#

Simulation quantities and unit conversion tools.

This module contains common quantities used throughout simulations. It also contains helper functions to convert a given quantity to the simulation’s units. In addition, it contains functions to define and set a units system. The default is SI.

Attributes#

length

mass

time

velocity

angular_velocity

acceleration

force

torque

inertia

gravitational_parameter

Functions#

setDefaultUnits([system, currency, current, ...])

Set the default units / units system.

isQuantity(v, quantity)

Determine if the given value is one of the known quantities.

convert(…)

Convert this quantity to the current units system.

Module Contents#

Karana.KUtils.Kquantities.length: quantities.Quantity#
Karana.KUtils.Kquantities.mass: quantities.Quantity#
Karana.KUtils.Kquantities.time: quantities.Quantity#
Karana.KUtils.Kquantities.velocity: quantities.Quantity#
Karana.KUtils.Kquantities.angular_velocity: quantities.Quantity#
Karana.KUtils.Kquantities.acceleration: quantities.Quantity#
Karana.KUtils.Kquantities.force: quantities.Quantity#
Karana.KUtils.Kquantities.torque: quantities.Quantity#
Karana.KUtils.Kquantities.inertia: quantities.Quantity#
Karana.KUtils.Kquantities.gravitational_parameter: quantities.Quantity#
Karana.KUtils.Kquantities.setDefaultUnits(system: Literal['si', 'cgs'] | None = None, currency: quantities.Quantity | None = None, current: quantities.Quantity | None = None, information: quantities.Quantity | None = None, length: quantities.Quantity | None = None, luminous_intensity: quantities.Quantity | None = None, mass: quantities.Quantity | None = None, substance: quantities.Quantity | None = None, temperature: quantities.Quantity | None = None, time: quantities.Quantity | None = None)[source]#

Set the default units / units system.

Parameters:

  • system (Literal["si","cgs"]) – Set the default units system. Other parameters will modify this system. If None, then si is used.

  • currency (Optional[Quantity]) – Set the currency unit.

  • current (Optional[Quantity]) – Set the current unit.

  • information (Optional[Quantity]) – Set the information unit.

  • length (Optional[Quantity]) – Set the length unit.

  • luminous_intensity (Optional[Quantity]) – Set the luminous_intensity unit.

  • mass (Optional[Quantity]) – Set the mass unit.

  • substance (Optional[Quantity]) – Set the substance unit.

  • temperature (Optional[Quantity]) – Set the temperature unit.

  • time (Optional[Quantity]) – Set the time unit.

Karana.KUtils.Kquantities.isQuantity(v: quantities.Quantity | numpy.typing.NDArray, quantity: quantities.Quantity)[source]#

Determine if the given value is one of the known quantities.

Karana.KUtils.Kquantities.convert(v: float) → float[source]#
Karana.KUtils.Kquantities.convert(v: numpy.typing.NDArray) → numpy.typing.NDArray
Karana.KUtils.Kquantities.convert(v: quantities.Quantity) → quantities.Quantity

Convert this quantity to the current units system.

Contents