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::sigmoid 00026 00027 Description 00028 00029 00030 SourceFiles 00031 sigmoid.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef sigmoid_H 00036 #define sigmoid_H 00037 00038 #include <potential/energyScalingFunction.H> 00039 00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00041 00042 namespace Foam 00043 { 00044 namespace energyScalingFunctions 00045 { 00046 00047 /*---------------------------------------------------------------------------*\ 00048 Class sigmoid Declaration 00049 \*---------------------------------------------------------------------------*/ 00050 00051 class sigmoid 00052 : 00053 public energyScalingFunction 00054 { 00055 // Private data 00056 00057 dictionary sigmoidCoeffs_; 00058 00059 scalar shift_; 00060 scalar scale_; 00061 00062 00063 // Private Member Functions 00064 00065 scalar sigmoidScale 00066 ( 00067 const scalar r, 00068 const scalar shift, 00069 const scalar scale 00070 ) const; 00071 00072 00073 public: 00074 00075 //- Runtime type information 00076 TypeName("sigmoid"); 00077 00078 00079 // Constructors 00080 00081 //- Construct from components 00082 sigmoid 00083 ( 00084 const word& name, 00085 const dictionary& energyScalingFunctionProperties, 00086 const pairPotential& pairPot 00087 ); 00088 00089 00090 // Destructor 00091 00092 ~sigmoid() 00093 {} 00094 00095 00096 // Member Functions 00097 00098 void scaleEnergy(scalar& e, const scalar r) const; 00099 00100 //- Read dictionary 00101 bool read(const dictionary& energyScalingFunctionProperties); 00102 }; 00103 00104 00105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00106 00107 } // End namespace energyScalingFunctions 00108 } // End namespace Foam 00109 00110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00111 00112 #endif 00113 00114 // ************************ vim: set sw=4 sts=4 et: ************************ //
