FreeFOAM The Cross-Platform CFD Toolkit
tetherPotential.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 | Copyright (C) 2008-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
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.
15 
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.
20 
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/>.
23 
24 Class
25  Foam::tetherPotential
26 
27 Description
28 
29 SourceFiles
30  tetherPotential.C
31  newTetherPotential.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef tetherPotential_H
36 #define tetherPotential_H
37 
38 #include <OpenFOAM/IOdictionary.H>
39 #include <OpenFOAM/typeInfo.H>
41 #include <OpenFOAM/autoPtr.H>
42 #include <OpenFOAM/vector.H>
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class tetherPotential Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 {
55 
56 protected:
57 
58  // Protected data
59 
62 
63 
64  // Private Member Functions
65 
66  //- Disallow copy construct
68 
69  //- Disallow default bitwise assignment
70  void operator=(const tetherPotential&);
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("tetherPotential");
77 
78 
79  // Declare run-time constructor selection table
80 
82  (
83  autoPtr,
85  dictionary,
86  (
87  const word& name,
89  ),
90  (name, tetherPotentialProperties)
91  );
92 
93 
94  // Selectors
95 
96  //- Return a reference to the selected viscosity model
98  (
99  const word& name,
100  const dictionary& tetherPotentialProperties
101  );
102 
103 
104  // Constructors
105 
106  //- Construct from components
108  (
109  const word& name,
110  const dictionary& tetherPotentialProperties
111  );
112 
113 
114  // Destructor
115 
117  {}
118 
119 
120  // Member Functions
121 
122  virtual scalar energy (const vector r) const = 0;
123 
124  virtual vector force (const vector r) const = 0;
125 
127  {
129  }
130 
131  //- Read tetherPotential dictionary
132  virtual bool read(const dictionary& tetherPotentialProperties) = 0;
133 };
134 
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 } // End namespace Foam
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 #endif
143 
144 // ************************ vim: set sw=4 sts=4 et: ************************ //