initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / lagrangian / molecularDynamics / potential / pairPotential / derived / exponentialRepulsion / exponentialRepulsion.C
blobae34ef4cdbc30f5dc58c3927f7a2f2c1eeb583a1
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2008-2009 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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     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, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 \*---------------------------------------------------------------------------*/
27 #include "exponentialRepulsion.H"
28 #include "addToRunTimeSelectionTable.H"
30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 namespace Foam
34 namespace pairPotentials
37 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
39 defineTypeNameAndDebug(exponentialRepulsion, 0);
41 addToRunTimeSelectionTable
43     pairPotential,
44     exponentialRepulsion,
45     dictionary
49 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
51 exponentialRepulsion::exponentialRepulsion
53     const word& name,
54     const dictionary& exponentialRepulsion
57     pairPotential(name, exponentialRepulsion),
58     exponentialRepulsionCoeffs_
59     (
60         exponentialRepulsion.subDict(typeName + "Coeffs")
61     ),
62     rm_(readScalar(exponentialRepulsionCoeffs_.lookup("rm"))),
63     epsilon_(readScalar(exponentialRepulsionCoeffs_.lookup("epsilon")))
65     setLookupTables();
69 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
71 scalar exponentialRepulsion::unscaledEnergy(const scalar r) const
73     return epsilon_ * exp(-r/rm_);
77 bool exponentialRepulsion::read(const dictionary& exponentialRepulsion)
79     pairPotential::read(exponentialRepulsion);
81     exponentialRepulsionCoeffs_ =
82         exponentialRepulsion.subDict(typeName + "Coeffs");
84     exponentialRepulsionCoeffs_.lookup("rm") >> rm_;
85     exponentialRepulsionCoeffs_.lookup("epsilon") >> epsilon_;
87     return true;
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 } // End namespace pairPotentials
94 } // End namespace Foam
96 // ************************************************************************* //