barycentric.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) 2016-2018 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 Typedef
25  Foam::barycentric
26 
27 Description
28  A scalar version of the templated Barycentric
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef barycentric_H
33 #define barycentric_H
34 
35 #include "scalar.H"
36 #include "Barycentric.H"
37 #include "contiguous.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 // Forward declaration of classes
45 class Random;
46 
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 typedef Barycentric<scalar> barycentric;
51 
52 
53 //- Generate a random barycentric coordinate within the unit tetrahedron
54 barycentric barycentric01(Random& rndGen);
55 
56 
57 template<>
58 inline bool contiguous<barycentric>()
59 {
60  return true;
61 }
62 
63 
64 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
65 
66 } // End namespace Foam
67 
68 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
69 
70 #endif
71 
72 // ************************************************************************* //
Foam::barycentric01
barycentric barycentric01(Random &rndGen)
Generate a random barycentric coordinate within the unit tetrahedron.
Definition: barycentric.C:31
contiguous.H
Template function to specify if the data of a type are contiguous.
Foam::barycentric
Barycentric< scalar > barycentric
A scalar version of the templated Barycentric.
Definition: barycentric.H:45
rndGen
Random rndGen(label(0))
Foam::Random
Random number generator.
Definition: Random.H:57
Foam::contiguous< barycentric >
bool contiguous< barycentric >()
Definition: barycentric.H:58
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.H:213