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

exponentialRepulsion.C

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 \*---------------------------------------------------------------------------*/
00025 
00026 #include "exponentialRepulsion.H"
00027 #include <OpenFOAM/addToRunTimeSelectionTable.H>
00028 
00029 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00030 
00031 namespace Foam
00032 {
00033 namespace pairPotentials
00034 {
00035 
00036 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
00037 
00038 defineTypeNameAndDebug(exponentialRepulsion, 0);
00039 
00040 addToRunTimeSelectionTable
00041 (
00042     pairPotential,
00043     exponentialRepulsion,
00044     dictionary
00045 );
00046 
00047 
00048 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
00049 
00050 exponentialRepulsion::exponentialRepulsion
00051 (
00052     const word& name,
00053     const dictionary& exponentialRepulsion
00054 )
00055 :
00056     pairPotential(name, exponentialRepulsion),
00057     exponentialRepulsionCoeffs_
00058     (
00059         exponentialRepulsion.subDict(typeName + "Coeffs")
00060     ),
00061     rm_(readScalar(exponentialRepulsionCoeffs_.lookup("rm"))),
00062     epsilon_(readScalar(exponentialRepulsionCoeffs_.lookup("epsilon")))
00063 {
00064     setLookupTables();
00065 }
00066 
00067 
00068 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
00069 
00070 scalar exponentialRepulsion::unscaledEnergy(const scalar r) const
00071 {
00072     return epsilon_ * exp(-r/rm_);
00073 }
00074 
00075 
00076 bool exponentialRepulsion::read(const dictionary& exponentialRepulsion)
00077 {
00078     pairPotential::read(exponentialRepulsion);
00079 
00080     exponentialRepulsionCoeffs_ =
00081         exponentialRepulsion.subDict(typeName + "Coeffs");
00082 
00083     exponentialRepulsionCoeffs_.lookup("rm") >> rm_;
00084     exponentialRepulsionCoeffs_.lookup("epsilon") >> epsilon_;
00085 
00086     return true;
00087 }
00088 
00089 
00090 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00091 
00092 } // End namespace pairPotentials
00093 } // End namespace Foam
00094 
00095 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines