src/randomProcesses/processes/UOprocess/UOprocess.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::UOprocess
  26
  27 Description
  28     Random UO process.
  29
  30 SourceFiles
  31     UOprocess.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef UOprocess_H
  36 #define UOprocess_H
  37
  38 #include "complexFields.H"
  39 #include "scalar.H"
  40 #include "Random.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 class Kmesh;
  48 class dictionary;
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class UOprocess Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class UOprocess
  55 {
  56     // Private data
  57
  58         Random GaussGen;
  59
  60         const Kmesh& Mesh;
  61         const scalar DeltaT, RootDeltaT;
  62         complexVectorField UOfield;
  63
  64         scalar Alpha;
  65         scalar Sigma;
  66         scalar Kupper;
  67         scalar Klower;
  68         scalar Scale;
  69
  70
  71     // Private Member Functions
  72
  73         complexVector WeinerProcess();
  74
  75
  76 public:
  77
  78     // Constructors
  79
  80         //- Construct from wavenumber mesh and timestep
  81         UOprocess
  82         (
  83             const Kmesh& kmesh,
  84             const scalar deltaT,
  85             const dictionary&
  86         );
  87
  88
  89     // Member Functions
  90
  91         const complexVectorField& newField();
  92 };
  93
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 } // End namespace Foam
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //