Quantity

>>> import ansys.fluent.core.quantity.quantity as q
>>> velocity_1 = q.Quantity(20.2, units="m s^-1")
>>> velocity_1
Quantity (20.2, "m s^-1")
>>> velocity_2 = q.Quantity(30.2, dimensions=[0.0, 1.0, -1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0])
>>> velocity_2
Quantity (30.2, "m s^-1")
>>> velocity_3 = q.Quantity(40.2, quantity_map={"Velocity": 1.0})
>>> velocity_3
Quantity (40.2, "m s^-1")
>>> velocity_1.value
20.2
>>> velocity_1.units
'm s^-1'
>>> velocity_1.si_value
20.2
>>> velocity_1.si_units
'm s^-1'
>>> velocity_1.type
'Composite'
>>> velocity_1.is_dimensionless
False
>>> velocity_1.dimensions
[0.0, 1.0, -1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
>>> velocity_1.to("ft s^-1")
Quantity (66.2729658792651, "ft s^-1")
>>> velocity_1 ** 2
Quantity (408.03999999999996, "m^2 s^-2")
>>> velocity_2 + velocity_1
Quantity (50.4, "m s^-1")
>>> velocity_2 - velocity_1
Quantity (10.0, "m s^-1")
>>> velocity_2 * velocity_1
Quantity (610.04, "m^2 s^-2")
>>> velocity_2 / velocity_1
Quantity (1.495049504950495, "")
>>> velocity_3 > velocity_1
True
>>> velocity_3 >= velocity_2
True
>>> velocity_1 < velocity_2
True
>>> velocity_1 <= velocity_3
True
>>> velocity_1 == velocity_2
False
>>> velocity_1 != velocity_3
True

Classes:

Quantity(value[, units, quantity_map, ...])

Quantity instantiates physical quantities using their real values and units.

Exceptions:

QuantityError(err)

Custom quantity errors.

class ansys.fluent.core.quantity.quantity.Quantity(value, units=None, quantity_map=None, dimensions=None, _type_hint=None)

Bases: float

Quantity instantiates physical quantities using their real values and units. All the instances of this class are converted to base SI units system to have consistency in arithmetic operations.

Parameters:

valueint | float

Real value of quantity.

unitsstr

Unit string representation of quantity.

quantity_mapdict

Quantity map representation of quantity.

dimensionslist

Dimensions representation of quantity.

Returns:

Quantity instance.

Methods

to()	Converts to given unit string.

Methods:

__init__(value[, units, quantity_map, ...])
to(to_units)	Perform quantity conversions.

Attributes:

dimensions	Dimensions.
is_dimensionless	Check if quantity is dimensionless.
si_units	SI conversion unit string.
si_value	SI conversion value.
type	Type.
units	Unit string.
value	Real value.

__init__(value, units=None, quantity_map=None, dimensions=None, _type_hint=None)

property dimensions

Dimensions.

property is_dimensionless: bool

Check if quantity is dimensionless.

property si_units

SI conversion unit string.

property si_value

SI conversion value.

to(to_units)

Perform quantity conversions.

Parameters:

to_unitsstr

Desired unit to be converted to.

Returns:

Quantity

Quantity object containing desired quantity conversion.

property type

Type.

property units

Unit string.

property value

Real value.

exception ansys.fluent.core.quantity.quantity.QuantityError(err)

Bases: ValueError

Custom quantity errors.

classmethod EXCESSIVE_PARAMETERS()

classmethod INCOMPATIBLE_DIMENSIONS(from_unit, to_unit)

classmethod INCOMPATIBLE_VALUE(value)

classmethod UNKNOWN_UNITS(unit)

__init__(err)

Classes:

Dimensions([units, dimensions, unit_sys])

Initialize a Dimensions object using a dimensions list or a unit string.

Exceptions:

DimensionsError(err)

Custom dimensions errors.

class ansys.fluent.core.quantity.dimensions.Dimensions(units=None, dimensions=None, unit_sys=None)

Bases: object

Initialize a Dimensions object using a dimensions list or a unit string.

Parameters:

units: str

Unit string of quantity.

dimensions: list

List of dimensions.

unit_sys: str

Unit system used for creating units.

Returns:

Dimensions instance.

Methods:

__init__([units, dimensions, unit_sys])
max_dim_len()	Maximum number of elements within a dimensions list.

Attributes:

dimensions	Dimensions list.
units	Unit string representation of dimensions.

__init__(units=None, dimensions=None, unit_sys=None)

property dimensions

Dimensions list.

static max_dim_len()

Maximum number of elements within a dimensions list.

property units

Unit string representation of dimensions.

exception ansys.fluent.core.quantity.dimensions.DimensionsError(err)

Bases: ValueError

Custom dimensions errors.

classmethod EXCESSIVE_DIMENSIONS(len)

classmethod EXCESSIVE_PARAMETERS()

__init__(err)

Classes:

QuantityMap(quantity_map)

Creates a Quantity Map object based on a given quantity map.

Exceptions:

QuantityMapError(err)

Custom quantity map errors.

class ansys.fluent.core.quantity.map.QuantityMap(quantity_map)

Bases: object

Creates a Quantity Map object based on a given quantity map.

Parameters:

quantity_mapdict

Dictionary containing quantity map units and values.

Returns:

QuantityMap instance.

Methods:

__init__(quantity_map)

Attributes:

units

Unit string representation of quantity map.

__init__(quantity_map)

property units

Unit string representation of quantity map.

exception ansys.fluent.core.quantity.map.QuantityMapError(err)

Bases: ValueError

Custom quantity map errors.

classmethod UNKNOWN_MAP_ITEM(item)

__init__(err)

Classes:

UnitsTable()

Initializes a UnitsTable object with all table values and unit string manipulation methods.

class ansys.fluent.core.quantity.tables.UnitsTable

Bases: object

Initializes a UnitsTable object with all table values and unit string manipulation methods.

Returns:

UnitsTable instance.

Methods

filter_unit_term()	Separate multiplier, base, and power from a unit term.
si_data()	Compute the SI unit string, SI multiplier, and SI offset from a unit string of any type.
si_conversion()	Perform SI conversion based on quantity type.
condense()	Condenses a unit string by collecting like-terms.
get_type()	Returns the type associated with a unit string.

Methods:

__init__()
condense(units)	Condenses a unit string by collecting like-terms.
filter_unit_term(unit_term)	Separate multiplier, base, and power from a unit term.
get_type(units)	Returns the type associated with a unit string.
si_data(units[, power, si_units, si_multiplier])	Compute the SI unit string, SI multiplier, and SI offset.

Attributes:

api_quantity_map	Quantity map values from settings API.
derived_units	Derived units and properties composed of fundamental units.
dimension_order	Order of dimensions.
fundamental_units	Fundamental units and properties representing Mass, Length, Time, Current, Chemical Amount, Light, Solid Angle, Angle, Temperature and Temperature Difference.
multipliers	Multiplier prefixes and respective factors.
unit_systems	Predefined unit systems and units.

__init__()

property api_quantity_map

Quantity map values from settings API.

condense(units)

Condenses a unit string by collecting like-terms.

Parameters:

unitsingstr

Unit string to be simplified.

Returns:

str

Simplified unit string.

property derived_units

Derived units and properties composed of fundamental units.

property dimension_order

Order of dimensions.

filter_unit_term(unit_term)

Separate multiplier, base, and power from a unit term.

Parameters:

unit_termstr

Unit term of a unit string.

Returns:

tuple

Tuple containing multiplier, base, and power of the unit term.

property fundamental_units

Fundamental units and properties representing Mass, Length, Time, Current, Chemical Amount, Light, Solid Angle, Angle, Temperature and Temperature Difference.

get_type(units)

Returns the type associated with a unit string.

Parameters:

unitsstr

Unit string of quantity.

Returns:

str

Type of quantity.

property multipliers

Multiplier prefixes and respective factors.

si_data(units, power=None, si_units=None, si_multiplier=None)

Compute the SI unit string, SI multiplier, and SI offset.

Parameters:

unitsstr

Unit string representation of quantity.

powerfloat

Power of unit string

si_unitsingstr

SI unit string representation of quantity.

si_multiplierfloat

SI multiplier of unit string.

si_offsetfloat

SI offset of a unit string.

Returns:

tuple

Tuple containing si_unitsing, si_multiplier and si_offset.

property unit_systems

Predefined unit systems and units.