dampedCoulomb.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::dampedCoulomb
28
29Description
30
31
32SourceFiles
33 dampedCoulomb.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef dampedCoulomb_H
38#define dampedCoulomb_H
39
40#include "pairPotential.H"
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44namespace Foam
45{
46namespace pairPotentials
47{
48
49/*---------------------------------------------------------------------------*\
50 Class dampedCoulomb Declaration
51\*---------------------------------------------------------------------------*/
53class dampedCoulomb
54:
55 public pairPotential
56{
57 // Private data
58
59 dictionary dampedCoulombCoeffs_;
60
61 scalar alpha_;
62
63
64public:
65
66 //- Runtime type information
67 TypeName("dampedCoulomb");
68
69
70 // Static data members
72 static scalar oneOverFourPiEps0;
73
74
75 // Constructors
76
77 //- Construct from components
79 (
80 const word& name,
82 );
83
84
85 //- Destructor
87 {}
88
89
90 // Member Functions
91
92 scalar unscaledEnergy(const scalar r) const;
93
94 //- Read dictionary
96};
97
98
99// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100
101} // End namespace pairPotentials
102} // End namespace Foam
103
104// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105
106#endif
107
108// ************************************************************************* //
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.
Definition: dampedCoulomb.C:81
scalar unscaledEnergy(const scalar r) const
Definition: dampedCoulomb.C:75
TypeName("dampedCoulomb")
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