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

shiftedForce.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::shiftedForce
00026 
00027 Description
00028 
00029 
00030 SourceFiles
00031     shiftedForce.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef shiftedForce_H
00036 #define shiftedForce_H
00037 
00038 #include <potential/energyScalingFunction.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 namespace energyScalingFunctions
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                        Class shiftedForce Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class shiftedForce
00052 :
00053     public energyScalingFunction
00054 {
00055     // Private data
00056 
00057         scalar rCut_;
00058 
00059         scalar e_at_rCut_;
00060 
00061         scalar de_dr_at_rCut_;
00062 
00063 
00064 public:
00065 
00066     //- Runtime type information
00067     TypeName("shiftedForce");
00068 
00069 
00070     // Constructors
00071 
00072         //- Construct from components
00073         shiftedForce
00074         (
00075             const word& name,
00076             const dictionary& energyScalingFunctionProperties,
00077             const pairPotential& pairPot
00078         );
00079 
00080 
00081     // Destructor
00082 
00083         ~shiftedForce()
00084         {}
00085 
00086 
00087     // Member Functions
00088 
00089         void scaleEnergy(scalar& e, const scalar r) const;
00090 
00091         //- Read dictionary
00092         bool read(const dictionary& energyScalingFunctionProperties);
00093 };
00094 
00095 
00096 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00097 
00098 } // End namespace energyScalingFunctions
00099 } // End namespace Foam
00100 
00101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00102 
00103 #endif
00104 
00105 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines