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