shifted.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 -------------------------------------------------------------------------------
10 License
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 "shifted.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace energyScalingFunctions
36 {
37 
38 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
39 
40 defineTypeNameAndDebug(shifted, 0);
41 
43 (
44  energyScalingFunction,
45  shifted,
46  dictionary
47 );
48 
49 
50 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
51 
53 (
54  const word& name,
55  const dictionary& energyScalingFunctionProperties,
56  const pairPotential& pairPot
57 )
58 :
59  energyScalingFunction(name, energyScalingFunctionProperties, pairPot),
60  e_at_rCut_(pairPot.unscaledEnergy(pairPot.rCut()))
61 {}
62 
63 
64 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
65 
66 void shifted::scaleEnergy(scalar& e, const scalar r) const
67 {
68  e -= e_at_rCut_;
69 }
70 
71 
72 bool shifted::read(const dictionary& energyScalingFunctionProperties)
73 {
75 
76  return true;
77 }
78 
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 } // End namespace energyScalingFunctions
83 } // End namespace Foam
84 
85 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::energyScalingFunction::energyScalingFunctionProperties
const dictionary & energyScalingFunctionProperties() const
Definition: energyScalingFunction.H:130
Foam::pairPotential::rCut
scalar rCut() const
Definition: pairPotentialI.H:42
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::pairPotential
Definition: pairPotential.H:60
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::energyScalingFunctions::shifted::scaleEnergy
void scaleEnergy(scalar &e, const scalar r) const
Definition: shifted.C:66
shifted.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::pairPotential::unscaledEnergy
virtual scalar unscaledEnergy(const scalar r) const =0
Foam::energyScalingFunctions::defineTypeNameAndDebug
defineTypeNameAndDebug(doubleSigmoid, 0)
Foam::constant::electromagnetic::e
const dimensionedScalar e
Elementary charge.
Definition: createFields.H:11
Foam::energyScalingFunctions::addToRunTimeSelectionTable
addToRunTimeSelectionTable(energyScalingFunction, doubleSigmoid, dictionary)
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::energyScalingFunction
Definition: energyScalingFunction.H:55
Foam::energyScalingFunction::read
virtual bool read(const dictionary &energyScalingFunctionProperties)=0
Read energyScalingFunction dictionary.
Definition: energyScalingFunction.C:58
Foam::energyScalingFunctions::shifted::read
bool read(const dictionary &energyScalingFunctionProperties)
Read dictionary.
Definition: shifted.C:72
Foam::energyScalingFunctions::shifted::shifted
shifted(const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)
Construct from components.
Definition: shifted.C:53