noScaling.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::energyScalingFunctions::noScaling
28
29Description
30
31
32SourceFiles
33 noScaling.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef noScaling_H
38#define noScaling_H
39
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44namespace Foam
45{
46namespace energyScalingFunctions
47{
48
49/*---------------------------------------------------------------------------*\
50 Class noScaling Declaration
51\*---------------------------------------------------------------------------*/
53class noScaling
54:
56{
57
58public:
59
60 //- Runtime type information
61 TypeName("noScaling");
62
63
64 // Constructors
65
66 //- Construct from components
68 (
69 const word& name,
71 const pairPotential& pairPot
72 );
73
74
75 //- Destructor
77 {}
78
79 // Member Functions
80
81 void scaleEnergy(scalar& e, const scalar r) const;
82
83 //- Read dictionary
85};
86
87
88// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89
90} // End namespace energyScalingFunctions
91} // End namespace Foam
92
93// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94
95#endif
96
97// ************************************************************************* //
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
const dictionary & energyScalingFunctionProperties() const
bool read(const dictionary &energyScalingFunctionProperties)
Read dictionary.
Definition: noScaling.C:69
TypeName("noScaling")
Runtime type information.
void scaleEnergy(scalar &e, const scalar r) const
Definition: noScaling.C:65
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
volScalarField & e
Definition: createFields.H:11
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73