00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::energyScalingFunctions::doubleSigmoid 00026 00027 Description 00028 00029 00030 SourceFiles 00031 doubleSigmoid.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef doubleSigmoid_H 00036 #define doubleSigmoid_H 00037 00038 #include <potential/energyScalingFunction.H> 00039 00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00041 00042 namespace Foam 00043 { 00044 namespace energyScalingFunctions 00045 { 00046 00047 /*---------------------------------------------------------------------------*\ 00048 Class doubleSigmoid Declaration 00049 \*---------------------------------------------------------------------------*/ 00050 00051 class doubleSigmoid 00052 : 00053 public energyScalingFunction 00054 { 00055 // Private data 00056 00057 dictionary doubleSigmoidCoeffs_; 00058 00059 scalar shift1_; 00060 scalar scale1_; 00061 scalar shift2_; 00062 scalar scale2_; 00063 00064 00065 // Private Member Functions 00066 00067 scalar sigmoidScale 00068 ( 00069 const scalar r, 00070 const scalar shift, 00071 const scalar scale 00072 ) const; 00073 00074 00075 public: 00076 00077 //- Runtime type information 00078 TypeName("doubleSigmoid"); 00079 00080 00081 // Constructors 00082 00083 //- Construct from components 00084 doubleSigmoid 00085 ( 00086 const word& name, 00087 const dictionary& energyScalingFunctionProperties, 00088 const pairPotential& pairPot 00089 ); 00090 00091 00092 // Destructor 00093 00094 ~doubleSigmoid() 00095 {} 00096 00097 // Member Functions 00098 00099 void scaleEnergy(scalar& e, const scalar r) const; 00100 00101 //- Read dictionary 00102 bool read(const dictionary& energyScalingFunctionProperties); 00103 }; 00104 00105 00106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00107 00108 } // End namespace energyScalingFunctions 00109 } // End namespace Foam 00110 00111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00112 00113 #endif 00114 00115 // ************************ vim: set sw=4 sts=4 et: ************************ //
