unitConversionI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2024 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "unitConversion.H"
27 #include "mathematicalConstants.H"
28 
29 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
30 
32 {
33  return dimensions_;
34 }
35 
36 
37 inline bool Foam::unitConversion::any() const
38 {
39  return multiplier_ == 0;
40 }
41 
42 
43 inline bool Foam::unitConversion::none() const
44 {
45  return multiplier_ == -1;
46 }
47 
48 
49 inline bool Foam::unitConversion::standard() const
50 {
51  return multiplier_ == 1 || any() || none();
52 }
53 
54 
55 // ************************************************************************* //
Dimension set for the base types.
Definition: dimensionSet.H:125
bool none() const
Return whether this is the "none" unit. I.e., the case where unit.
const dimensionSet & dimensions() const
Access the dimensions.
bool standard() const
Return whether this unit is standard. I.e., is its multiplier one?
bool any() const
Return whether this is the "any" unit. I.e., the case where.
bool any(const boolList &l)