randomiseTemplates.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) 2016-2022 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 "volFields.H"
27 #include "Random.H"
28 
29 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
30 
31 template<class Type>
32 bool Foam::functionObjects::randomise::calcRandomised()
33 {
34  if (foundObject<VolField<Type>>(fieldName_))
35  {
36  const VolField<Type>& field = lookupObject<VolField<Type>>(fieldName_);
37 
38  tmp<VolField<Type>> rfieldt(new VolField<Type>(field));
39  VolField<Type>& rfield = rfieldt.ref();
40 
41  Random rand(1234567);
42 
43  forAll(field, celli)
44  {
45  Type rndPert = rand.sample01<Type>();
46  rndPert = 2.0*rndPert - pTraits<Type>::one;
47  rndPert /= mag(rndPert);
48  rfield[celli] += magPerturbation_*rndPert;
49  }
50 
51  return store(resultName_, rfieldt);
52  }
53  else
54  {
55  return false;
56  }
57 }
58 
59 
60 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
word resultName_
Name of result field.
const word fieldName_
Name of field to process.
bool foundObject(const word &fieldName) const
Find field in the objectRegistry.
bool store(const tmp< ObjectType > &tfield)
Store the given field in the objectRegistry.
dimensioned< scalar > mag(const dimensioned< Type > &)