randomiseTemplates.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "volFields.H"
29 #include "Random.H"
30 
31 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
32 
33 template<class Type>
34 bool Foam::functionObjects::randomise::calcRandomised()
35 {
36  typedef GeometricField<Type, fvPatchField, volMesh> VolFieldType;
37 
38  if (foundObject<VolFieldType>(fieldName_, false))
39  {
40  const VolFieldType& field = lookupObject<VolFieldType>(fieldName_);
41 
42  resultName_ = fieldName_ & "Random";
43 
44  auto trfield = tmp<VolFieldType>::New(field);
45  auto& rfield = trfield.ref();
46 
47  Random rand(1234567);
48 
49  for (Type& cellval : rfield)
50  {
51  Type rndPert;
52  rand.randomise01(rndPert);
53  rndPert = 2.0*rndPert - pTraits<Type>::one;
54  rndPert /= mag(rndPert);
55 
56  cellval += magPerturbation_*rndPert;
57  }
58 
59  return store(resultName_, trfield);
60  }
61 
62  return false;
63 }
64 
65 
66 // ************************************************************************* //
volFields.H
Foam::functionObjects::regionFunctionObject::store
bool store(word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
Store the field in the (sub) objectRegistry under the given name.
Definition: regionFunctionObjectTemplates.C:107
field
rDeltaTY field()
Foam::functionObjects::fieldExpression::fieldName_
word fieldName_
Name of field to process.
Definition: fieldExpression.H:112
Random.H
Foam::mag
dimensioned< typename typeOfMag< Type >::type > mag(const dimensioned< Type > &dt)
Foam::tmp::New
static tmp< T > New(Args &&... args)
Construct tmp of T with forwarding arguments.
Foam::functionObjects::fieldExpression::resultName_
word resultName_
Name of result field.
Definition: fieldExpression.H:115