unitforge 0.5.13__tar.gz → 0.5.16__tar.gz

{unitforge-0.5.13 → unitforge-0.5.16}/Cargo.lock

@@ -351,7 +351,7 @@ checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512"
 
 [[package]]
 name = "unitforge"
-version = "0.5.13"
+version = "0.5.16"
 dependencies = [
  "ndarray",
  "num-traits",
@@ -367,7 +367,7 @@ dependencies = [
 
 [[package]]
 name = "unitforge_macros"
-version = "0.5.13"
+version = "0.5.16"
 dependencies = [
  "regex",
 ]

{unitforge-0.5.13 → unitforge-0.5.16}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "unitforge"
-version = "0.5.13"
+version = "0.5.16"
 edition = "2021"
 authors = ["Dr.Q team <info@askdrq.com>", "Henrik Stromberg <henrik@askdrq.com>"]
 description = "A library for unit and quantity consistent computations in Rust"
@@ -20,7 +20,7 @@ pyo3 = { version = "0.28.3", features = ["extension-module", "auto-initialize",
 numpy = { version = "0.28.0", optional = true }
 strum = { version = "0.28.0", optional = true }
 strum_macros = { version = "0.28.0", optional = true }
-unitforge_macros = { version = "0.5.13", path = "unitforge_macros" }
+unitforge_macros = { version = "0.5.16", path = "unitforge_macros" }
 
 [features]
 default = []

{unitforge-0.5.13 → unitforge-0.5.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitforge
-Version: 0.5.13
+Version: 0.5.16
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Rust
 Classifier: License :: OSI Approved :: MIT License
@@ -9,9 +9,7 @@ Classifier: Topic :: Scientific/Engineering :: Physics
 Requires-Dist: numpy>=2.2.0
 Summary: A library for unit and quantity consistent computations in Rust
 Keywords: units,quantities,simulation,physics
-Author: Dr.Q team <info@askdrq.com>, Henrik Stromberg <henrik@askdrq.com>
 Author-email: "Dr.Q team" <info@askdrq.com>, Henrik Stromberg <henrik@askdrq.com>
-License: MIT
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Project-URL: Repository, https://gitlab.com/henrikjstromberg/unitforge
@@ -149,3 +147,24 @@ Contributions are welcome! While the core is implemented in Rust, Python usage f
 ## Repository
 
 [GitLab – Unitforge Crate](https://gitlab.com/henrikjstromberg/unitforge)
+## Viscous coefficients
+
+Version 0.5.15 adds `StrainRate`, `DynamicViscosity`, `TranslationalDamping`,
+`RotationalDamping`, `ForceRate`, and `ForceTime` with their corresponding
+`Unit` enums. For example:
+
+```python
+from unitforge import (
+    Stress, StressUnit, Time, TimeUnit, StrainRate, StrainRateUnit,
+    DynamicViscosityUnit,
+)
+viscosity = Stress(200.0, StressUnit.MPa) * Time(0.5, TimeUnit.s)
+assert viscosity.to(DynamicViscosityUnit.MPa_s) == 100.0
+stress = viscosity * StrainRate(0.002, StrainRateUnit.m_m_s)
+```
+
+Shear conventions belong to the constitutive/tensor layer; Unitforge adds no
+factors of two. Radians retain the existing dimensionless-angle convention.
+For compatibility, `StressRate / Stress` still returns `Frequency`, while
+`StressRate / StrainRate` returns `Stress`.
+

unitforge-0.5.16/Readme.md

@@ -0,0 +1,76 @@
+# Unitforge
+
+## Overview
+
+**Unitforge** is a Rust crate designed for safe handling of physical quantities of units. New quantities and relations can be set up via small macros.
+
+## Features
+
+- **Quantity inference:** Resulting quantities of arithmetic operations are inferred at compile time.
+- **Unit conversion:** Quantities can be set or read in arbitrary units.
+- **Computing Precision** Values are stored in exponential format (f64*10^i32) to prevent floating point precision issues.
+- **Formating** Quantities are displayed with 4 significant digits and configured display unit.
+- **ndarray support:** Optional `ndarray` integration with `features = ["ndarray"]`; quantities may be used as inner types for arrays.
+- **3D Vector and matrix operations:** Structs for 3D vectors and matrices are included to allow fast and unit-safe work with them.
+- **Serialization**: Optional support for serde using `features = ["serde"]`; combine with `ndarray` for ndarray serialization support.
+- **python interface** Optional Python interface when building with flag pyo3; also available on pypi
+
+## Comparing quantities
+
+`==` is tolerance-based: two quantities are equal when they differ by at most `1e-9` of the larger
+magnitude. An infinity equals only itself, and NaN equals nothing. Ordering (`<`, `<=`, `>`, `>=`)
+compares the stored values exactly. As a consequence:
+
+- `==` is not transitive, and for nearly equal values `a == b` and `a < b` can both be true.
+- `Hash` hashes the exact stored value, so quantities that compare equal can hash differently. Do
+  not rely on hash-based collections to merge nearly equal quantities.
+- For an explicit, absolute tolerance use `a.is_close(&b, &tolerance)`.
+
+## Contribute
+
+All contributions are welcome! Feel free to implement new quantities or define relations using `impl_macros.rs`. 🚀
+
+## Viscous coefficients and rates
+
+`StrainRate` represents the time derivative of strain and is distinct from
+`Frequency`. Construct it from typed strain divided by time, or strain times
+frequency. The material coefficient `DynamicViscosity` is distinct from the
+assembled coefficients `TranslationalDamping` and `RotationalDamping`.
+
+```rust
+use unitforge::*;
+
+let modulus = Stress::new(200.0, StressUnit::MPa);
+let relaxation_time = Time::new(0.5, TimeUnit::s);
+let viscosity: DynamicViscosity = modulus * relaxation_time;
+let strain_rate = StrainRate::new(0.002, StrainRateUnit::m_m_s);
+let viscous_stress: Stress = viscosity * strain_rate; // 0.2 MPa
+let damping: TranslationalDamping =
+    viscosity * Area::new(100.0, AreaUnit::mmsq)
+    / Distance::new(1000.0, DistanceUnit::mm); // 10000 N s/m
+let force: Force = damping * Velocity::new(2.0, VelocityUnit::mm_s); // 20 N
+```
+
+`ForceRate` supports differentiated translational equilibrium. `ForceTime`
+represents force times time, including mixed translation/rotation damping
+blocks: `2 N s * 3 rad/s = 6 N` and `2 N s * 3 m/s = 6 N m`.
+Radians follow the library's existing dimensionless-angle convention.
+Rotational damping per degree converts to per radian by multiplying by 180/π;
+`1 N m s/degree * 1 degree/s = 1 N m`.
+
+Tensor shear versus engineering shear conventions belong to the constitutive
+and tensor layer. Unitforge inserts no factors of two. Signed components,
+zero, and nonfinite values follow the normal quantity arithmetic policy.
+
+Existing semantic result types take precedence where dimensions overlap:
+`StressRate / Stress` returns `Frequency`, `Velocity / Distance` returns
+`AngularVelocity`, and `Power / ForceDistance` returns `Frequency`.
+`Stress * StrainRate` returns `StressRate` in both orders, while
+`StressRate / StrainRate` returns `Stress`. Rotational stiffness times angular
+velocity returns `Power` in both orders, and `Power / AngularVelocity` returns
+`RotationalStiffness`; no inverse `Power / RotationalStiffness` is added.
+
+Downstream tensor libraries retain ownership of tensor constructors, registered
+quantity specializations, and constitutive contractions. Unitforge supplies the
+scalar operations and generic vector, matrix, and ndarray arithmetic needed by
+those implementations; it does not implement finite-element tensors.

{unitforge-0.5.13 → unitforge-0.5.16}/Readme_py.md

@@ -130,4 +130,24 @@ Contributions are welcome! While the core is implemented in Rust, Python usage f
 
 ## Repository
 
-[GitLab – Unitforge Crate](https://gitlab.com/henrikjstromberg/unitforge)
+[GitLab – Unitforge Crate](https://gitlab.com/henrikjstromberg/unitforge)
+## Viscous coefficients
+
+Version 0.5.15 adds `StrainRate`, `DynamicViscosity`, `TranslationalDamping`,
+`RotationalDamping`, `ForceRate`, and `ForceTime` with their corresponding
+`Unit` enums. For example:
+
+```python
+from unitforge import (
+    Stress, StressUnit, Time, TimeUnit, StrainRate, StrainRateUnit,
+    DynamicViscosityUnit,
+)
+viscosity = Stress(200.0, StressUnit.MPa) * Time(0.5, TimeUnit.s)
+assert viscosity.to(DynamicViscosityUnit.MPa_s) == 100.0
+stress = viscosity * StrainRate(0.002, StrainRateUnit.m_m_s)
+```
+
+Shear conventions belong to the constitutive/tensor layer; Unitforge adds no
+factors of two. Radians retain the existing dimensionless-angle convention.
+For compatibility, `StressRate / Stress` still returns `Frequency`, while
+`StressRate / StrainRate` returns `Stress`.