FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

shifted.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 2008-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::energyScalingFunctions::shifted
00026 
00027 Description
00028 
00029 
00030 SourceFiles
00031     shifted.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef shifted_H
00036 #define shifted_H
00037 
00038 #include <potential/energyScalingFunction.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 namespace energyScalingFunctions
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class shifted Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class shifted
00052 :
00053     public energyScalingFunction
00054 {
00055     // Private data
00056 
00057         scalar e_at_rCut_;
00058 
00059 
00060 public:
00061 
00062     //- Runtime type information
00063     TypeName("shifted");
00064 
00065 
00066     // Constructors
00067 
00068         //- Construct from components
00069         shifted
00070         (
00071             const word& name,
00072             const dictionary& energyScalingFunctionProperties,
00073             const pairPotential& pairPot
00074         );
00075 
00076 
00077     // Destructor
00078 
00079         ~shifted()
00080         {}
00081 
00082 
00083     // Member Functions
00084 
00085         void scaleEnergy(scalar& e, const scalar r) const;
00086 
00087         //- Read dictionary
00088         bool read(const dictionary& energyScalingFunctionProperties);
00089 };
00090 
00091 
00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00093 
00094 } // End namespace energyScalingFunctions
00095 } // End namespace Foam
00096 
00097 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00098 
00099 #endif
00100 
00101 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines