src/randomProcesses/Kmesh/Kmesh.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::Kmesh
  27
  28 Description
  29     Calculate the wavenumber vector field corresponding to the
  30     space vector field of a finite volume mesh;
  31
  32 SourceFiles
  33     Kmesh.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef Kmesh_H
  38 #define Kmesh_H
  39
  40 #include "fvMesh.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class Kmesh Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class Kmesh
  52 :
  53     public vectorField
  54 {
  55
  56     // Private data
  57
  58         //- Dimensions of box
  59         vector L;
  60
  61         //- Multi-dimensional addressing array
  62         labelList NN;
  63
  64         //- Maximum wavenumber
  65         scalar Kmax;
  66
  67 public:
  68
  69     // Constructors
  70
  71         //- Construct from fvMesh
  72         Kmesh(const fvMesh&);
  73
  74
  75     // Member Functions
  76
  77         // Access
  78
  79         const vector& sizeOfBox() const
  80         {
  81             return L;
  82         }
  83
  84         const labelList& nn() const
  85         {
  86             return NN;
  87         }
  88
  89         scalar max() const
  90         {
  91             return Kmax;
  92         }
  93 };
  94
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 } // End namespace Foam
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 #endif
 103
 104 // ************************************************************************* //