src/finiteVolume/cfdTools/general/SRF/SRFModel/rpm/rpm.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::SRF::rpm
  27
  28 Description
  29     Basic SRF model whereby angular velocity is specified in terms of
  30     a (global) axis and revolutions-per-minute [rpm]
  31
  32 SourceFiles
  33     rpm.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef SRFModelRpm_H
  38 #define SRFModelRpm_H
  39
  40 #include "SRFModel.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46 namespace SRF
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                             Class rpm Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class rpm
  54 :
  55     public SRFModel
  56 {
  57
  58     // Private data
  59
  60         //- Revolutions per minute
  61         scalar rpm_;
  62
  63
  64     // Private member functions
  65
  66         //- Disallow default bitwise copy construct
  67         rpm(const rpm&);
  68
  69         //- Disallow default bitwise assignment
  70         void operator=(const rpm&);
  71
  72
  73 public:
  74
  75     //- Runtime type information
  76     TypeName("rpm");
  77
  78
  79     // Constructors
  80
  81         //- Construct from components
  82         rpm(const volVectorField& U);
  83
  84
  85     // Destructor
  86
  87         ~rpm();
  88
  89     // Member functions
  90
  91         // I-O
  92
  93             //- Read
  94             bool read();
  95 };
  96
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 } // End namespace SRF
 101 } // End namespace Foam
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #endif
 106
 107 // ************************************************************************* //