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-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 \*---------------------------------------------------------------------------*/
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  typedef GeometricField<Type, fvPatchField, volMesh> VolFieldType;
35 
36  if (foundObject<VolFieldType>(fieldName_))
37  {
38  const VolFieldType& field = lookupObject<VolFieldType>(fieldName_);
39 
40  resultName_ = fieldName_ + "Random";
41 
42  tmp<VolFieldType> rfieldt(new VolFieldType(field));
43  VolFieldType& rfield = rfieldt.ref();
44 
45  Random rand(1234567);
46 
47  forAll(field, celli)
48  {
49  Type rndPert = rand.sample01<Type>();
50  rndPert = 2.0*rndPert - pTraits<Type>::one;
51  rndPert /= mag(rndPert);
52  rfield[celli] += magPerturbation_*rndPert;
53  }
54 
55  return store(resultName_, rfieldt);
56  }
57  else
58  {
59  return false;
60  }
61 }
62 
63 
64 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
word fieldName_
Name of field to process.
bool store(word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
Store the given field in the objectRegistry under the given name.
dimensioned< scalar > mag(const dimensioned< Type > &)