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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2013-2016 OpenFOAM Foundation
9  Copyright (C) 2019-2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "DampingModel.H"
30 #include "TimeScaleModel.H"
31 
32 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33 
34 template<class CloudType>
36 :
38  timeScaleModel_(nullptr)
39 {}
40 
41 
42 template<class CloudType>
44 (
45  const dictionary& dict,
46  CloudType& owner,
47  const word& type
48 )
49 :
50  CloudSubModelBase<CloudType>(owner, dict, typeName, type),
51  timeScaleModel_
52  (
54  (
55  this->coeffDict().subDict(TimeScaleModel::typeName)
56  )
57  )
58 {}
59 
60 
61 template<class CloudType>
63 :
65  timeScaleModel_(cm.timeScaleModel_)
66 {}
67 
68 
69 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
70 
71 template<class CloudType>
73 {}
74 
75 
76 // * * * * * * * * * * * * * * * * Selector * * * * * * * * * * * * * * * * //
77 
78 template<class CloudType>
81 (
82  const dictionary& dict,
83  CloudType& owner
84 )
85 {
86  const word modelType
87  (
88  dict.template getOrDefault<word>(typeName, "none")
89  );
90 
91  Info<< "Selecting damping model " << modelType << endl;
92 
93  auto* ctorPtr = dictionaryConstructorTable(modelType);
94 
95  if (!ctorPtr)
96  {
98  (
99  dict,
100  "damping model",
101  modelType,
102  *dictionaryConstructorTablePtr_
103  ) << abort(FatalIOError);
104  }
105 
106  return autoPtr<DampingModel<CloudType>>(ctorPtr(dict, owner));
107 }
108 
109 
110 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::CloudSubModelBase
Base class for cloud sub-models.
Definition: CloudSubModelBase.H:51
TimeScaleModel.H
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::DampingModel
Base class for collisional damping models.
Definition: KinematicCloud.H:101
Foam::DampingModel::~DampingModel
virtual ~DampingModel()
Destructor.
Definition: DampingModel.C:72
FatalIOErrorInLookup
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::DampingModel::New
static autoPtr< DampingModel< CloudType > > New(const dictionary &dict, CloudType &owner)
Selector.
Definition: DampingModel.C:81
Foam::DSMCCloud
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:71
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:144
Foam::New
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
Global function forwards to reuseTmpDimensionedField::New.
Definition: DimensionedFieldReuseFunctions.H:105
Foam::DampingModel::DampingModel
DampingModel(CloudType &owner)
Construct null from owner.
Definition: DampingModel.C:35
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
DampingModel.H
Foam::roots::type
type
Types of root.
Definition: Roots.H:54