rpm.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011 OpenFOAM Foundation
    Copyright (C) 2018 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::SRF::rpm
 
Description
    Basic SRF model whereby angular velocity is specified in terms of
    a (global) axis and revolutions-per-minute [rpm]
 
SourceFiles
    rpm.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef SRF_rpm_H
#define SRF_rpm_H
 
#include "SRFModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace SRF
{
 
/*---------------------------------------------------------------------------*\
                            Class rpm Declaration
\*---------------------------------------------------------------------------*/
 
class rpm
:
    public SRFModel
{
 
    // Private data
 
        //- Revolutions per minute
        scalar rpm_;
 
 
    // Private Member Functions
 
        //- No copy construct
        rpm(const rpm&) = delete;
 
        //- No copy assignment
        void operator=(const rpm&) = delete;
 
 
public:
 
    //- Runtime type information
    TypeName("rpm");
 
 
    // Constructors
 
        //- Construct from components
        rpm(const volVectorField& U);
 
 
    //- Destructor
    ~rpm() = default;
 
 
    // Member functions
 
        //- Read coefficients
        bool read();
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace SRF
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //