ostk.physics.unit.Derived

class Derived(
self: ostk.physics.unit.Derived,
arg0: ostk.core.type.Real,
arg1: ostk::physics::unit::Derived::Unit,
)

Bases: pybind11_object

Derived unit.

Reference:

https://en.wikipedia.org/wiki/SI_derived_unit

Constructor.

Parameters:
  • aValue (Real) -- Value

  • aUnit (Unit) -- Unit

Methods

get_unit

Get unit.

in_unit

Convert to unit.

is_defined

Check if the derived unit is defined.

string_from_unit

Get string from unit.

symbol_from_unit

Get symbol from unit.

to_string

Convert to string.

undefined

Create an undefined derived unit.

class Order(*args, **kwargs)

Bases: pybind11_object

SI unit order.

Overloaded function.

  1. __init__(self: ostk.physics.unit.Derived.Order, arg0: int) -> None

    Constructor.

    Args:

    aValue (int): Value.

  2. __init__(self: ostk.physics.unit.Derived.Order, arg0: int, arg1: int) -> None

    Constructor.

    Args:

    aNumerator (int): Numerator. aDenominator (int): Denominator.

get_denominator(self: ostk.physics.unit.Derived.Order) int

Get denominator.

Returns:

Denominator.

Return type:

int

get_numerator(self: ostk.physics.unit.Derived.Order) int

Get numerator.

Returns:

Numerator.

Return type:

int

get_value(self: ostk.physics.unit.Derived.Order) ostk.core.type.Real

Get value.

Returns:

Value.

Return type:

float

is_unity(self: ostk.physics.unit.Derived.Order) bool

Check if the order is unity.

Returns:

True if unity.

Return type:

bool

is_zero(self: ostk.physics.unit.Derived.Order) bool

Check if the order is zero.

Returns:

True if zero.

Return type:

bool

static one() ostk.physics.unit.Derived.Order

Create a unity order.

Returns:

Order.

Return type:

Order

to_string(self: ostk.physics.unit.Derived.Order) ostk.core.type.String

Convert to string.

Returns:

String representation.

Return type:

str

static two() ostk.physics.unit.Derived.Order

Create a two order.

Returns:

Order.

Return type:

Order

static zero() ostk.physics.unit.Derived.Order

Create a zero order.

Returns:

Order.

Return type:

Order

class Unit

Bases: pybind11_object

__init__(self: ostk.physics.unit.Derived.Unit, arg0: ostk.physics.unit.Length.Unit, arg1: ostk.physics.unit.Derived.Order, arg2: ostk.physics.unit.Mass.Unit, arg3: ostk.physics.unit.Derived.Order, arg4: ostk.physics.unit.Time.Unit, arg5: ostk.physics.unit.Derived.Order, arg6: ostk.physics.unit.ElectricCurrent.Unit, arg7: ostk.physics.unit.Derived.Order, arg8: ostk::physics::unit::Angle::Unit, arg9: ostk.physics.unit.Derived.Order) -> None

static acceleration(
length: ostk.physics.unit.Length.Unit,
time: ostk.physics.unit.Time.Unit,
) ostk.physics.unit.Derived.Unit

Create an acceleration unit.

Parameters:
  • length (Length::Unit) -- Length unit.

  • time (Time::Unit) -- Time unit.

Returns:

Unit.

Return type:

Unit

static angular_velocity(
angle: ostk::physics::unit::Angle::Unit,
time: ostk.physics.unit.Time.Unit,
) ostk.physics.unit.Derived.Unit

Create an angular velocity unit.

Parameters:
  • angle (Angle::Unit) -- Angle unit.

  • time (Time::Unit) -- Time unit.

Returns:

Unit.

Return type:

Unit

static cubic_meter() ostk.physics.unit.Derived.Unit

Create a cubic meter unit.

Returns:

Unit.

Return type:

Unit

static force(
mass: ostk.physics.unit.Mass.Unit,
length: ostk.physics.unit.Length.Unit,
time: ostk.physics.unit.Time.Unit,
) ostk.physics.unit.Derived.Unit

Create a force unit.

Parameters:
  • mass (Mass::Unit) -- Mass unit.

  • length (Length::Unit) -- Length unit.

  • time (Time::Unit) -- Time unit.

Returns:

Unit.

Return type:

Unit

get_symbol(self: ostk.physics.unit.Derived.Unit) ostk.core.type.String

Get symbol.

Returns:

Symbol.

Return type:

str

static gravitational_parameter(
length: ostk.physics.unit.Length.Unit,
time: ostk.physics.unit.Time.Unit,
) ostk.physics.unit.Derived.Unit

Create a gravitational parameter unit.

Parameters:
  • length (Length::Unit) -- Length unit.

  • time (Time::Unit) -- Time unit.

Returns:

Unit.

Return type:

Unit

static hertz() ostk.physics.unit.Derived.Unit

Create a hertz unit.

Returns:

Unit.

Return type:

Unit

is_compatible_with(
self: ostk.physics.unit.Derived.Unit,
arg0: ostk.physics.unit.Derived.Unit,
) bool
is_defined(self: ostk.physics.unit.Derived.Unit) bool
static kilogram_per_second() ostk.physics.unit.Derived.Unit

Create a kilogram per second unit.

Returns:

Unit.

Return type:

Unit

static mass_density(
mass: ostk.physics.unit.Mass.Unit,
length: ostk.physics.unit.Length.Unit,
) ostk.physics.unit.Derived.Unit

Create a mass density unit.

Parameters:
  • mass (Mass::Unit) -- Mass unit.

  • length (Length::Unit) -- Length unit.

Returns:

Unit.

Return type:

Unit

static mass_flow_rate(
mass: ostk.physics.unit.Mass.Unit,
time: ostk.physics.unit.Time.Unit,
) ostk.physics.unit.Derived.Unit

Create a mass flow rate unit.

Parameters:
  • mass (Mass::Unit) -- Mass unit.

  • time (Time::Unit) -- Time unit.

Returns:

Unit.

Return type:

Unit

static meter_cubed_per_second_squared() ostk.physics.unit.Derived.Unit

Create a meter cubed per second squared unit.

Returns:

Unit.

Return type:

Unit

static meter_per_second() ostk.physics.unit.Derived.Unit

Create a meter per second unit.

Returns:

Unit.

Return type:

Unit

static meter_per_second_squared() ostk.physics.unit.Derived.Unit

Create a meter per second squared unit.

Returns:

Unit.

Return type:

Unit

static newton() ostk.physics.unit.Derived.Unit

Create a newton unit.

Returns:

Unit.

Return type:

Unit

static radian_per_second() ostk.physics.unit.Derived.Unit

Create a radian per second unit.

Returns:

Unit.

Return type:

Unit

static revolution_per_day() ostk.physics.unit.Derived.Unit

Create a revolution per day unit.

Returns:

Unit.

Return type:

Unit

static square_meter() ostk.physics.unit.Derived.Unit

Create a square meter unit.

Returns:

Unit.

Return type:

Unit

static tesla() ostk.physics.unit.Derived.Unit

Create a tesla unit.

Returns:

Unit.

Return type:

Unit

to_string(self: ostk.physics.unit.Derived.Unit) ostk.core.type.String

Convert to string.

Returns:

String representation.

Return type:

str

static undefined() ostk.physics.unit.Derived.Unit

Create an undefined unit.

Returns:

Unit.

Return type:

Unit

static velocity(
length: ostk.physics.unit.Length.Unit,
time: ostk.physics.unit.Time.Unit,
) ostk.physics.unit.Derived.Unit

Create a velocity unit.

Parameters:
  • length (Length::Unit) -- Length unit.

  • time (Time::Unit) -- Time unit.

Returns:

Unit.

Return type:

Unit

static watt() ostk.physics.unit.Derived.Unit

Create a watt unit.

Returns:

Unit.

Return type:

Unit

get_unit(self: ostk.physics.unit.Derived) ostk::physics::unit::Derived::Unit

Get unit.

Returns:

Unit.

Return type:

Unit

in_unit(
self: ostk.physics.unit.Derived,
arg0: ostk::physics::unit::Derived::Unit,
) ostk.core.type.Real

Convert to unit.

Returns:

Value in unit.

Return type:

float

is_defined(self: ostk.physics.unit.Derived) bool

Check if the derived unit is defined.

Returns:

True if defined.

Return type:

bool

static string_from_unit(
arg0: ostk::physics::unit::Derived::Unit,
) ostk.core.type.String

Get string from unit.

Parameters:

aUnit (Unit) -- Unit.

Returns:

String.

Return type:

str

static symbol_from_unit(
arg0: ostk::physics::unit::Derived::Unit,
) ostk.core.type.String

Get symbol from unit.

Parameters:

aUnit (Unit) -- Unit.

Returns:

Symbol.

Return type:

str

to_string(
self: ostk.physics.unit.Derived,
aPrecision: ostk.core.type.Integer = Undefined,
) ostk.core.type.String

Convert to string.

Parameters:

aPrecision (int) -- Precision

Returns:

String representation.

Return type:

str

static undefined() ostk.physics.unit.Derived

Create an undefined derived unit.

Returns:

Derived unit.

Return type:

Derived