distributionTemplates.C
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 "distribution.H"
27 
28 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
30 template<class Base, class Derived>
31 template<class Type>
33 {
34  Type value;
35  for (direction i = 0; i < pTraits<Type>::nComponents; ++ i)
36  {
37  setComponent(value, i) =
38  static_cast<const Derived&>(*this).sample();
39  }
40  return value;
41 }
42 
43 
44 template<class Base, class Derived>
46 (
47  const label n
48 ) const
49 {
50  tmp<scalarField> tResult(new scalarField(n));
51  scalarField& result = tResult.ref();
52 
53  forAll(result, i)
54  {
55  result[i] =
56  static_cast<const Derived&>(*this).sample();
57  }
58 
59  return tResult;
60 }
61 
62 
63 // ************************************************************************* //
label n
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
Type sample() const
Sample the distribution into components of a primitive type.
A class for managing temporary objects.
Definition: tmp.H:55
T & ref() const
Return non-const reference or generate a fatal error.
Definition: tmpI.H:181
volScalarField scalarField(fieldObject, mesh)
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
label & setComponent(label &l, const direction)
Definition: label.H:86
uint8_t direction
Definition: direction.H:45