sigmoid.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
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::energyScalingFunctions::sigmoid
26 
27 Description
28 
29 
30 SourceFiles
31  sigmoid.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef sigmoid_H
36 #define sigmoid_H
37 
38 #include "energyScalingFunction.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace energyScalingFunctions
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class sigmoid Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class sigmoid
52 :
54 {
55  // Private Data
56 
57  dictionary sigmoidCoeffs_;
58 
59  scalar shift_;
60  scalar scale_;
61 
62 
63  // Private Member Functions
64 
65  scalar sigmoidScale
66  (
67  const scalar r,
68  const scalar shift,
69  const scalar scale
70  ) const;
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("sigmoid");
77 
78 
79  // Constructors
80 
81  //- Construct from components
82  sigmoid
83  (
84  const word& name,
86  const pairPotential& pairPot
87  );
88 
89 
90  //- Destructor
91  ~sigmoid()
92  {}
93 
94 
95  // Member Functions
96 
97  void scaleEnergy(scalar& e, const scalar r) const;
98 
99  //- Read dictionary
100  bool read(const dictionary& energyScalingFunctionProperties);
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace energyScalingFunctions
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
sigmoid(const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)
Construct from components.
Definition: sigmoid.C:64
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
void scaleEnergy(scalar &e, const scalar r) const
Definition: sigmoid.C:82
const dictionary & energyScalingFunctionProperties() const
A class for handling words, derived from string.
Definition: word.H:59
TypeName("sigmoid")
Runtime type information.
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
bool read(const dictionary &energyScalingFunctionProperties)
Read dictionary.
Definition: sigmoid.C:88
const doubleScalar e
Elementary charge.
Definition: doubleScalar.H:98
Namespace for OpenFOAM.