openPMD-api
UnitDimension.hpp
1 /* Copyright 2020 Axel Huebl
2  *
3  * This file is part of openPMD-api.
4  *
5  * openPMD-api is free software: you can redistribute it and/or modify
6  * it under the terms of of either the GNU General Public License or
7  * the GNU Lesser General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * openPMD-api is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License and the GNU Lesser General Public License
15  * for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * and the GNU Lesser General Public License along with openPMD-api.
19  * If not, see <http://www.gnu.org/licenses/>.
20  */
21 #pragma once
22 
23 namespace openPMD
24 {
25 namespace python
26 {
27  constexpr auto doc_unit_dimension = R"docstr(
28 Return the physical dimension (quantity) of a record
29 
30 Annotating the physical dimension of a record allows us to read data
31 sets with arbitrary names and understand their purpose simply by
32 dimensional analysis. The dimensional base quantities in openPMD are
33 in order: length (L), mass (M), time (T), electric current (I),
34 thermodynamic temperature (theta), amount of substance (N),
35 luminous intensity (J) after the international system of quantities
36 (ISQ).
37 
38 See https://en.wikipedia.org/wiki/Dimensional_analysis
39 See https://en.wikipedia.org/wiki/International_System_of_Quantities#Base_quantities
40 See https://github.com/openPMD/openPMD-standard/blob/1.1.0/STANDARD.md#required-for-each-record
41 
42 Returns the powers of the 7 base measures in the order specified above.
43 )docstr";
44 
45 } // namespace python
46 } // namespace openPMD
Public definitions of openPMD-api.
Definition: Date.cpp:29