mpusz/mp-units
1
0
Fork 1
mirror of https://github.com/mpusz/mp-units.git synced 2025-08-02 11:54:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: minor cleanup of quantity hierarchies

Browse Source
This commit is contained in:
Mateusz Pusz
2024-10-01 19:52:06 +02:00
parent 77aa13e54d
commit 74c55baebe
2 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/users_guide/framework_basics/dimensionless_quantities.md
View File

@@ -256,20 +256,20 @@ Angular quantities are not the only ones with such a "strange" behavior. Another
is a _storage capacity_ quantity specified in IEC-80000-13 that again allows expressing it in both is a _storage capacity_ quantity specified in IEC-80000-13 that again allows expressing it in both
`one` and `bit` units. `one` and `bit` units.
Those cases make dimensionless quantities an exceptional tree in the library. This is the only Those cases make dimensionless quantities an exceptional tree in the library. This
[quantity hierarchy](../../appendix/glossary.md#quantity-hierarchy) that contains more than one [quantity hierarchy](../../appendix/glossary.md#quantity-hierarchy) contains more than one
[quantity kind](../../appendix/glossary.md#kind) in its tree: [quantity kind](../../appendix/glossary.md#kind) and more than one unit in its tree:
```mermaid ```mermaid
flowchart TD flowchart TD
dimensionless["<b>dimensionless</b><br>[one]"] dimensionless["<b>dimensionless</b><br>[one]"]
dimensionless --- rotation["<b>rotation</b>"] dimensionless --- rotation["<b>rotation</b>"]
dimensionless --- efficiency["<b>efficiency</b>"] dimensionless --- thermodynamic_efficiency["<b>thermodynamic_efficiency</b><br><i>(work / heat)</i>"]
dimensionless --- angular_measure["<b>angular_measure</b><br>[rad]"] dimensionless --- angular_measure["<b>angular_measure</b><br><i>(arc_length / radius)</i><br>[rad]"]
angular_measure --- rotational_displacement["<b>rotational_displacement</b>"] angular_measure --- rotational_displacement["<b>rotational_displacement</b><br><i>(path_length / radius)</i>"]
angular_measure --- phase_angle["<b>phase_angle</b>"] angular_measure --- phase_angle["<b>phase_angle</b>"]
dimensionless --- solid_angular_measure["<b>solid_angular_measure</b><br>[sr]"] dimensionless --- solid_angular_measure["<b>solid_angular_measure</b><br><i>(area / pow<2>(radius))</i><br>[sr]"]
dimensionless --- drag_factor["<b>drag_factor</b>"] dimensionless --- drag_factor["<b>drag_factor</b><br><i>(drag_force / (mass_density * pow<2>(speed) * area))</i>"]
dimensionless --- storage_capacity["<b>storage_capacity</b><br>[bit]"] --- equivalent_binary_storage_capacity["<b>equivalent_binary_storage_capacity</b>"] dimensionless --- storage_capacity["<b>storage_capacity</b><br>[bit]"] --- equivalent_binary_storage_capacity["<b>equivalent_binary_storage_capacity</b>"]
dimensionless --- ... dimensionless --- ...
``` ```

4
docs/users_guide/framework_basics/systems_of_quantities.md
View File

@@ -296,7 +296,7 @@ sometimes not obvious what such a tree should look like. Also, ISO explicitly st
The division of ‘quantity’ according to ‘kind of quantity’ is, to some extent, arbitrary. The division of ‘quantity’ according to ‘kind of quantity’ is, to some extent, arbitrary.
The below presents some arbitrary hierarchy of derived quantities of kind energy: The below presents some arbitrary hierarchy of derived quantities of kind _energy_:
```mermaid ```mermaid
flowchart TD flowchart TD
@@ -365,7 +365,7 @@ quantities of the same kind. Such quantities have not only the same dimension bu
can be expressed in the same units. can be expressed in the same units.
To annotate a quantity to represent its kind (and not just a hierarchy tree's root quantity) To annotate a quantity to represent its kind (and not just a hierarchy tree's root quantity)
we introduced a `kind_of<>` specifier. For example, to express any quantity of length, we need we introduced a `kind_of<>` specifier. For example, to express any quantity of _length_, we need
to type `kind_of<isq::length>`. to type `kind_of<isq::length>`.
!!! important !!! important