src/randomProcesses/turbulence/turbGen.H

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