doubleSigmoid.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::doubleSigmoid
28
29Description
30
31
32SourceFiles
33 doubleSigmoid.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef doubleSigmoid_H
38#define doubleSigmoid_H
39
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44namespace Foam
45{
46namespace energyScalingFunctions
47{
48
49/*---------------------------------------------------------------------------*\
50 Class doubleSigmoid Declaration
51\*---------------------------------------------------------------------------*/
53class doubleSigmoid
54:
56{
57 // Private data
58
59 dictionary doubleSigmoidCoeffs_;
60
61 scalar shift1_;
62 scalar scale1_;
63 scalar shift2_;
64 scalar scale2_;
65
66
67 // Private Member Functions
68
69 scalar sigmoidScale
70 (
71 const scalar r,
72 const scalar shift,
73 const scalar scale
74 ) const;
75
76
77public:
78
79 //- Runtime type information
80 TypeName("doubleSigmoid");
81
82
83 // Constructors
84
85 //- Construct from components
87 (
88 const word& name,
90 const pairPotential& pairPot
91 );
92
93
94 //- Destructor
96 {}
97
98 // Member Functions
99
100 void scaleEnergy(scalar& e, const scalar r) const;
101
102 //- Read dictionary
104};
105
106
107// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108
109} // End namespace energyScalingFunctions
110} // End namespace Foam
111
112// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113
114#endif
115
116// ************************************************************************* //
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: doubleSigmoid.C:91
TypeName("doubleSigmoid")
Runtime type information.
void scaleEnergy(scalar &e, const scalar r) const
Definition: doubleSigmoid.C:85
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