sigmoid.C
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
26\*---------------------------------------------------------------------------*/
27
28#include "sigmoid.H"
30
31// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32
33namespace Foam
34{
35namespace energyScalingFunctions
36{
37
38// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
39
41
43(
45 sigmoid,
47);
48
49
50// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
51
52scalar sigmoid::sigmoidScale
53 (
54 const scalar r,
55 const scalar shift,
56 const scalar scale
57 ) const
58{
59 return 1.0 / (1.0 + exp( scale * (r - shift)));
60}
61
62
63// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
64
66(
67 const word& name,
68 const dictionary& energyScalingFunctionProperties,
69 const pairPotential& pairPot
70)
71:
72 energyScalingFunction(name, energyScalingFunctionProperties, pairPot),
73 sigmoidCoeffs_
74 (
75 energyScalingFunctionProperties.subDict(typeName + "Coeffs")
76 ),
77 shift_(sigmoidCoeffs_.get<scalar>("shift")),
78 scale_(sigmoidCoeffs_.get<scalar>("scale"))
79{}
80
81
82// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
83
84void sigmoid::scaleEnergy(scalar& e, const scalar r) const
85{
86 e *= sigmoidScale(r, shift_, scale_);
87}
88
89
90bool sigmoid::read(const dictionary& energyScalingFunctionProperties)
91{
93
94 sigmoidCoeffs_ =
95 energyScalingFunctionProperties.subDict(typeName + "Coeffs");
96
97 sigmoidCoeffs_.readEntry("shift", shift_);
98 sigmoidCoeffs_.readEntry("scale", shift_);
99
100 return true;
101}
102
103
104// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105
106} // End namespace energyScalingFunctions
107} // End namespace Foam
108
109// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
#define addToRunTimeSelectionTable(baseType, thisType, argNames)
Add to construction table with typeName as the key.
virtual bool read()
Re-read model coefficients if they have changed.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
const dictionary & subDict(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a sub-dictionary.
Definition: dictionary.C:460
bool readEntry(const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
const dictionary & energyScalingFunctionProperties() const
void scaleEnergy(scalar &e, const scalar r) const
Definition: sigmoid.C:84
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
Namespace for OpenFOAM.
dimensionedScalar exp(const dimensionedScalar &ds)
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