src/randomProcesses/turbulence/turbGen.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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 Class
  25     Foam::turbGen
  26
  27 Description
  28     Generate a turbulent velocity field conforming to a given
  29     energy spectrum and being divergence free.
  30
  31 SourceFiles
  32     turbGen.C
  33     turbGenIO.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef turbGen_H
  38 #define turbGen_H
  39
  40 #include "Random.H"
  41 #include "primitiveFields.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 class Kmesh;
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class turbGen Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class turbGen
  55 {
  56     // Private data
  57
  58         const Kmesh& K;
  59         const scalar Ea;
  60         const scalar k0;
  61         Random RanGen;
  62
  63
  64 public:
  65
  66     // Constructors
  67
  68         //- Construct from components
  69         turbGen(const Kmesh& k, const scalar EA, const scalar K0);
  70
  71
  72     // Member Functions
  73
  74         //- Generate and return a velocity field
  75         vectorField U();
  76 };
  77
  78
  79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  80
  81 } // End namespace Foam
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 #endif
  86
  87 // ************************************************************************* //