energyScalingFunctionNew.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "energyScalingFunction.H"
27 
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
32 (
33  const word& name,
34  const dictionary& propDict,
35  const pairPotential& pairPot
36 )
37 {
38  const word scalingType(propDict.lookup("energyScalingFunction"));
39 
40  Info<< "Selecting energy scaling function "
41  << scalingType << " for "
42  << name << " potential energy." << endl;
43 
44  dictionaryConstructorTable::iterator cstrIter =
45  dictionaryConstructorTablePtr_->find(scalingType);
46 
47  if (cstrIter == dictionaryConstructorTablePtr_->end())
48  {
50  << "Unknown energyScalingFunction type "
51  << scalingType << nl << nl
52  << "Valid energyScalingFunctions are:" << nl
53  << dictionaryConstructorTablePtr_->sortedToc()
54  << exit(FatalError);
55  }
56 
57  return autoPtr<energyScalingFunction>(cstrIter()(name, propDict, pairPot));
58 }
59 
60 
61 // ************************************************************************* //
static autoPtr< energyScalingFunction > New(const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)
Return a reference to the selected viscosity model.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
error FatalError
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:323
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
A class for handling words, derived from string.
Definition: word.H:59
static const char nl
Definition: Ostream.H:260
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
messageStream Info
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:844