random.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) 2022-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 "random.H"
27 #include "clock.H"
28 #include "randomGenerator.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace decompositionMethods
36 {
38 
40  (
42  random,
43  decomposer
44  );
45 
47  (
49  random,
50  distributor
51  );
52 }
53 }
54 
55 
56 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
57 
59 :
60  decompositionMethod(decompositionDict),
61  seed_
62  (
63  decompositionDict.optionalSubDict
64  (
65  word(decompositionDict.lookup("method")) + "Coeffs"
66  ).lookupOrDefault<label>("seed", clock::getTime())
67  )
68 {}
69 
70 
71 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
72 
74 (
75  const polyMesh& mesh,
76  const pointField& points,
77  const scalarField& pointWeights
78 )
79 {
80  checkWeights(points, pointWeights);
81 
82  randomGenerator rndGen(seed_, true);
83 
84  // Simple random integer. No guarantees about balance.
85  /*
86  labelList result(points.size());
87  forAll(result, i)
88  {
89  result[i] = rndGen.sampleAB<label>(0, nDomains());
90  }
91  */
92 
93  // Sorted random scalar. Equal balance.
94  scalarList position(points.size());
95  forAll(points, i)
96  {
97  position[i] = rndGen.sample01<scalar>();
98  }
99 
100  labelList order(points.size());
101  sortedOrder(position, order);
102 
103  labelList result(points.size());
104  forAll(points, i)
105  {
106  result[i] = (nDomains()*order[i])/points.size();
107  }
108 
109  return result;
110 }
111 
112 
113 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
Macros for easy insertion into run-time selection tables.
Read access to the system clock with formatting.
Definition: clock.H:51
Abstract base class for decomposition.
Random decomposition. Good for testing. Very bad for anything else.
Definition: random.H:53
virtual labelList decompose(const polyMesh &mesh, const pointField &cellCentres, const scalarField &cellWeights)
Return for every coordinate the wanted processor number. Use the.
Definition: random.C:74
random(const dictionary &decompositionDict)
Construct given the decomposition dictionary.
Definition: random.C:58
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
Random number generator.
A class for handling words, derived from string.
Definition: word.H:62
const pointField & points
addToRunTimeSelectionTable(decompositionMethod, metis, decomposer)
Namespace for OpenFOAM.
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
int order(const scalar s)
void sortedOrder(const UList< T > &, labelList &order)
Generate the (stable) sort order for the list.
randomGenerator rndGen(653213)