src/postProcessing/foamCalcFunctions/field/randomise/randomise.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::calcTypes::randomise
  26
  27 Description
  28     Adds a random component to a field, with a given perturbation magnitude.
  29
  30 SourceFiles
  31     randomise.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef randomise_H
  36 #define randomise_H
  37
  38 #include "calcType.H"
  39 #include "Random.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 namespace calcTypes
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                          Class randomise Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class randomise
  54 :
  55     public calcType
  56 {
  57     // Private Member Functions
  58
  59         //- Disallow default bitwise copy construct
  60         randomise(const randomise&);
  61
  62         //- Disallow default bitwise assignment
  63         void operator=(const randomise&);
  64
  65
  66 protected:
  67
  68     // Member Functions
  69
  70         // Calculation routines
  71
  72             //- Initialise - typically setting static variables,
  73             //  e.g. command line arguments
  74             virtual void init();
  75
  76             //- Pre-time loop calculations
  77             virtual void preCalc
  78             (
  79                 const argList& args,
  80                 const Time& runTime,
  81                 const fvMesh& mesh
  82             );
  83
  84             //- Time loop calculations
  85             virtual void calc
  86             (
  87                 const argList& args,
  88                 const Time& runTime,
  89                 const fvMesh& mesh
  90             );
  91
  92
  93         // I-O
  94
  95             //- Write component fields
  96             template<class Type>
  97             void writeRandomField
  98             (
  99                 const IOobject& header,
 100                 const scalar pertMag,
 101                 Random& rand,
 102                 const fvMesh& mesh,
 103                 bool& processed
 104             );
 105
 106
 107 public:
 108
 109     //- Runtime type information
 110     TypeName("randomise");
 111
 112
 113     // Constructors
 114
 115         //- Construct null
 116         randomise();
 117
 118
 119     // Destructor
 120
 121         virtual ~randomise();
 122 };
 123
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 } // End namespace calcTypes
 128 } // End namespace Foam
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #ifdef NoRepository
 133 #   include "writeRandomField.C"
 134 #endif
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 #endif
 139
 140 // ************************************************************************* //