doubleSigmoid.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 "doubleSigmoid.H"
30
31// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32
33namespace Foam
34{
35namespace energyScalingFunctions
36{
37
38// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
39
41
43(
47);
48
49// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
50
51scalar doubleSigmoid::sigmoidScale
52 (
53 const scalar r,
54 const scalar shift,
55 const scalar scale
56 ) const
57{
58 return 1.0 / (1.0 + exp( scale * (r - shift)));
59}
60
61
62// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
63
65(
66 const word& name,
67 const dictionary& energyScalingFunctionProperties,
68 const pairPotential& pairPot
69)
70:
71 energyScalingFunction(name, energyScalingFunctionProperties, pairPot),
72 doubleSigmoidCoeffs_
73 (
74 energyScalingFunctionProperties.subDict(typeName + "Coeffs")
75 ),
76 shift1_(doubleSigmoidCoeffs_.get<scalar>("shift1")),
77 scale1_(doubleSigmoidCoeffs_.get<scalar>("scale1")),
78 shift2_(doubleSigmoidCoeffs_.get<scalar>("shift2")),
79 scale2_(doubleSigmoidCoeffs_.get<scalar>("scale2"))
80{}
81
82
83// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
84
85void doubleSigmoid::scaleEnergy(scalar& e, const scalar r) const
86{
87 e *= sigmoidScale(r, shift1_, scale1_) * sigmoidScale(r, shift2_, scale2_);
88}
89
90
91bool doubleSigmoid::read(const dictionary& energyScalingFunctionProperties)
92{
94
95 doubleSigmoidCoeffs_ =
96 energyScalingFunctionProperties.subDict(typeName + "Coeffs");
97
98 doubleSigmoidCoeffs_.readEntry("shift1", shift1_);
99 doubleSigmoidCoeffs_.readEntry("scale1", scale1_);
100 doubleSigmoidCoeffs_.readEntry("shift2", shift2_);
101 doubleSigmoidCoeffs_.readEntry("scale2", scale2_);
102
103 return true;
104}
105
106
107// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108
109} // End namespace energyScalingFunctions
110} // End namespace Foam
111
112// ************************************************************************* //
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: doubleSigmoid.C:85
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