DampingModel.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 | Copyright (C) 2013 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 "DampingModel.H"
27 #include "TimeScaleModel.H"
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
31 template<class CloudType>
33 :
35  timeScaleModel_(NULL)
36 {}
37 
38 
39 template<class CloudType>
41 (
42  const dictionary& dict,
43  CloudType& owner,
44  const word& type
45 )
46 :
49  (
51  (
52  this->coeffDict().subDict(TimeScaleModel::typeName)
53  )
54  )
55 {}
56 
57 
58 template<class CloudType>
60 :
63 {}
64 
65 
66 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
67 
68 template<class CloudType>
70 {}
71 
72 
73 // * * * * * * * * * * * * * * * * Selector * * * * * * * * * * * * * * * * //
74 
75 template<class CloudType>
78 (
79  const dictionary& dict,
80  CloudType& owner
81 )
82 {
83  word modelType(dict.lookup(typeName));
84 
85  Info<< "Selecting damping model " << modelType << endl;
86 
87  typename dictionaryConstructorTable::iterator cstrIter =
88  dictionaryConstructorTablePtr_->find(modelType);
89 
90  if (cstrIter == dictionaryConstructorTablePtr_->end())
91  {
93  (
94  "DampingModel<CloudType>::New"
95  "("
96  "const dictionary&, "
97  "CloudType&"
98  ")"
99  ) << "Unknown damping model type " << modelType
100  << ", constructor not in hash table" << nl << nl
101  << " Valid damping model types are:" << nl
102  << dictionaryConstructorTablePtr_->sortedToc()
103  << exit(FatalError);
104  }
105 
106  return
108  (
109  cstrIter()(dict, owner)
110  );
111 }
112 
113 
114 // ************************************************************************* //
virtual ~DampingModel()
Destructor.
Definition: DampingModel.C:69
Base class for collisional damping models.
Definition: MPPICCloud.H:56
const CloudType & owner() const
Return const access to the owner cloud.
const word & modelType() const
Return const access to the sub-model type.
Definition: subModelBase.C:122
static autoPtr< TimeScaleModel > New(const dictionary &dict)
Selector.
A class for handling words, derived from string.
Definition: word.H:59
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
autoPtr< TimeScaleModel > timeScaleModel_
Time scale model.
Definition: DampingModel.H:66
messageStream Info
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
static const char nl
Definition: Ostream.H:260
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
DampingModel(CloudType &owner)
Construct null from owner.
Definition: DampingModel.C:32
fileName::Type type(const fileName &)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:589
#define FatalErrorIn(functionName)
Report an error message using Foam::FatalError.
Definition: error.H:314
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:452
error FatalError
Base class for cloud sub-models.
const dictionary & coeffDict() const
Return const access to the coefficients dictionary.
Definition: subModelBase.C:128
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:68
static autoPtr< DampingModel< CloudType > > New(const dictionary &dict, CloudType &owner)
Selector.
Definition: DampingModel.C:78
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117