writeRandomField.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 | Copyright (C) 2011-2013 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 template<class Type>
28 (
29  const IOobject& header,
30  const scalar pertMag,
31  Random& rand,
32  const fvMesh& mesh,
33  bool& processed
34 )
35 {
37 
38  if (header.headerClassName() == fieldType::typeName)
39  {
40  Info<< " Reading " << header.name() << endl;
41  fieldType field(header, mesh);
42 
43  forAll(field, cellI)
44  {
45  Type rndPert;
46  rand.randomise(rndPert);
47  rndPert = 2.0*rndPert - pTraits<Type>::one;
48  rndPert /= mag(rndPert);
49  field[cellI] += pertMag*rndPert;
50  }
51 
52  fieldType randomisedField
53  (
54  IOobject
55  (
56  header.name() + "Random",
57  mesh.time().timeName(),
58  mesh,
59  IOobject::NO_READ
60  ),
61  field
62  );
63 
64  Info<< " Writing " << header.name() << "Random" << endl;
65  randomisedField.write();
66 
67  processed = true;
68  }
69 }
70 
71 
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
Foam::Random
Simple random number generator.
Definition: Random.H:49
Foam::IOobject
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:406
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
Foam::mag
dimensioned< scalar > mag(const dimensioned< Type > &)
Foam::calcTypes::randomise::writeRandomField
void writeRandomField(const IOobject &header, const scalar pertMag, Random &rand, const fvMesh &mesh, bool &processed)
Write component fields.
Definition: writeRandomField.C:28
Foam::IOobject::headerClassName
const word & headerClassName() const
Return name of the class name read from header.
Definition: IOobject.H:279
Foam::Ostream::write
virtual Ostream & write(const token &)=0
Write next token to stream.
Foam::Info
messageStream Info
Foam::IOobject::name
const word & name() const
Return name.
Definition: IOobject.H:273
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:18
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Foam::Random::randomise
void randomise(scalar &)
Definition: Random.C:138
Foam::pTraits
Traits class for primitives.
Definition: pTraits.H:50
Foam::GeometricField
Generic GeometricField class.
Definition: surfaceFieldsFwd.H:52