Karana.Math.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
angle
mass
time
velocity
angular_velocity
acceleration
force
torque
inertia
gravitational_parameter
linear_spring_constant
linear_damping_constant
rotational_spring_constant
rotational_damping_constant

Functions

__getattr__(name)
setUnitRegistry(ur)	Set the UnitRegistry.
getDefaultUnits(→ pint.facets.plain.objects.PlainUnit)	Get the default units for a quantity.
convert(…)	Convert this quantity to the current units system.

Module Contents

Karana.Math.Kquantities.__getattr__(name)

Karana.Math.Kquantities.setUnitRegistry(ur: pint.UnitRegistry)

Set the UnitRegistry.

This sets the units system used for simulation. If this is never called, the default will be SI units. If you want something other than SI for your simulation, you should call this function before ureg is ever imported from Kquantities.

Parameters:

ur (UnitRegistry) – The new UnitRegistry to use.

Karana.Math.Kquantities.length

Karana.Math.Kquantities.angle

Karana.Math.Kquantities.mass

Karana.Math.Kquantities.time

Karana.Math.Kquantities.velocity

Karana.Math.Kquantities.angular_velocity

Karana.Math.Kquantities.acceleration

Karana.Math.Kquantities.force

Karana.Math.Kquantities.torque

Karana.Math.Kquantities.inertia

Karana.Math.Kquantities.gravitational_parameter

Karana.Math.Kquantities.linear_spring_constant

Karana.Math.Kquantities.linear_damping_constant

Karana.Math.Kquantities.rotational_spring_constant

Karana.Math.Kquantities.rotational_damping_constant

Karana.Math.Kquantities.getDefaultUnits(quantity: pint.util.UnitsContainer) → pint.facets.plain.objects.PlainUnit

Get the default units for a quantity.

Parameters:

quantity (UnitsContainer) – The quantity to get default units for.

Returns:

The default units for the provided quantity.

Return type:

PlainUnit

Karana.Math.Kquantities.convert(v: float) → float

Karana.Math.Kquantities.convert(v: numpy.typing.NDArray[numpy.float64]) → numpy.typing.NDArray[numpy.float64]

Karana.Math.Kquantities.convert(v: pint.Quantity) → pint.Quantity

Convert this quantity to the current units system.