noInteraction.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 -------------------------------------------------------------------------------
10 License
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 
26 Class
27  Foam::pairPotentials::noInteraction
28 
29 Description
30 
31 
32 SourceFiles
33  noInteraction.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef noInteraction_H
38 #define noInteraction_H
39 
40 #include "pairPotential.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace pairPotentials
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class noInteraction Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class noInteraction
54 :
55  public pairPotential
56 {
57 
58 public:
59 
60  //- Runtime type information
61  TypeName("noInteraction");
62 
63 
64  // Constructors
65 
66  //- Construct from components
68  (
69  const word& name,
71  );
72 
73 
74  //- Destructor
76  {}
77 
78 
79  // Member Functions
80 
81  scalar unscaledEnergy(const scalar r) const;
82 
83  //- Read dictionary
85 };
86 
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 } // End namespace pairPotentials
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::pairPotentials::noInteraction
Definition: noInteraction.H:52
Foam::pairPotentials::noInteraction::read
bool read(const dictionary &pairPotentialProperties)
Read dictionary.
Definition: noInteraction.C:72
Foam::pairPotentials::noInteraction::TypeName
TypeName("noInteraction")
Runtime type information.
Foam::pairPotentials::noInteraction::noInteraction
noInteraction(const word &name, const dictionary &pairPotentialProperties)
Construct from components.
Definition: noInteraction.C:53
Foam::name
word name(const complex &c)
Return string representation of complex.
Definition: complex.C:76
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::pairPotential
Definition: pairPotential.H:60
Foam::pairPotential::pairPotentialProperties
const dictionary & pairPotentialProperties() const
Definition: pairPotential.H:172
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::pairPotentials::noInteraction::unscaledEnergy
scalar unscaledEnergy(const scalar r) const
Definition: noInteraction.C:66
Foam::pairPotentials::noInteraction::~noInteraction
~noInteraction()
Destructor.
Definition: noInteraction.H:74
pairPotential.H