exponentialRepulsion.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::pairPotentials::exponentialRepulsion
28
29Description
30
31SourceFiles
32 exponentialRepulsion.C
33
34\*---------------------------------------------------------------------------*/
35
36#ifndef exponentialRepulsion_H
37#define exponentialRepulsion_H
38
39#include "pairPotential.H"
40
41// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43namespace Foam
44{
45
46namespace pairPotentials
47{
48
49/*---------------------------------------------------------------------------*\
50 Class exponentialRepulsion Declaration
51\*---------------------------------------------------------------------------*/
54:
55 public pairPotential
56{
57 // Private data
58
59 dictionary exponentialRepulsionCoeffs_;
60
61 scalar rm_;
62 scalar epsilon_;
63
64
65public:
66
67 //- Runtime type information
68 TypeName("exponentialRepulsion");
69
70
71 // Constructors
72
73 //- Construct from components
75 (
76 const word& name,
78 );
79
80
81 //- Destructor
83 {}
84
85
86 // Member Functions
87
88 scalar unscaledEnergy(const scalar r) const;
89
90 //- Read dictionary
92};
93
94
95// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96
97} // End namespace pairPotentials
98} // End namespace Foam
99
100// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101
102#endif
103
104// ************************************************************************* //
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
const dictionary & pairPotentialProperties() const
bool read(const dictionary &pairPotentialProperties)
Read dictionary.
TypeName("exponentialRepulsion")
Runtime type information.
A class for handling words, derived from Foam::string.
Definition: word.H:68
Namespace for OpenFOAM.
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73