Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / lagrangian / molecularDynamics / potential / pairPotential / derived / exponentialRepulsion / exponentialRepulsion.C
blob5342b0cfad3c5d948c87668dc58da64096081f3a
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2008-2010 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 \*---------------------------------------------------------------------------*/
26 #include "exponentialRepulsion.H"
27 #include "addToRunTimeSelectionTable.H"
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
31 namespace Foam
33 namespace pairPotentials
36 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
38 defineTypeNameAndDebug(exponentialRepulsion, 0);
40 addToRunTimeSelectionTable
42     pairPotential,
43     exponentialRepulsion,
44     dictionary
48 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
50 exponentialRepulsion::exponentialRepulsion
52     const word& name,
53     const dictionary& exponentialRepulsion
56     pairPotential(name, exponentialRepulsion),
57     exponentialRepulsionCoeffs_
58     (
59         exponentialRepulsion.subDict(typeName + "Coeffs")
60     ),
61     rm_(readScalar(exponentialRepulsionCoeffs_.lookup("rm"))),
62     epsilon_(readScalar(exponentialRepulsionCoeffs_.lookup("epsilon")))
64     setLookupTables();
68 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
70 scalar exponentialRepulsion::unscaledEnergy(const scalar r) const
72     return epsilon_ * exp(-r/rm_);
76 bool exponentialRepulsion::read(const dictionary& exponentialRepulsion)
78     pairPotential::read(exponentialRepulsion);
80     exponentialRepulsionCoeffs_ =
81         exponentialRepulsion.subDict(typeName + "Coeffs");
83     exponentialRepulsionCoeffs_.lookup("rm") >> rm_;
84     exponentialRepulsionCoeffs_.lookup("epsilon") >> epsilon_;
86     return true;
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 } // End namespace pairPotentials
93 } // End namespace Foam
95 // ************************************************************************* //