Loading...
Searching...
No Matches
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-------------------------------------------------------------------------------
11License
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\*---------------------------------------------------------------------------*/
29#include "DampingModel.H"
30#include "TimeScaleModel.H"
31
32// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33
34template<class CloudType>
38 timeScaleModel_(nullptr)
39{}
40
41
42template<class CloudType>
44(
45 const dictionary& dict,
46 CloudType& owner,
47 const word& type
48)
49:
51 timeScaleModel_
52 (
54 (
56 )
57 )
58{}
59
60
61template<class CloudType>
63:
67
68
69// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
70
71template<class CloudType>
73{}
74
75
76// * * * * * * * * * * * * * * * * Selector * * * * * * * * * * * * * * * * //
77
78template<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",
102 *dictionaryConstructorTablePtr_
103 ) << abort(FatalIOError);
104 }
105
106 return autoPtr<DampingModel<CloudType>>(ctorPtr(dict, owner));
107}
108
109
110// ************************************************************************* //
Base class for cloud sub-models.
const CloudType & owner() const
Return const access to the owner cloud.
CloudSubModelBase(CloudType &owner)
Construct null from owner cloud.
Base class for collisional damping models.
autoPtr< TimeScaleModel > timeScaleModel_
Time scale model.
virtual ~DampingModel()
Destructor.
DampingModel(CloudType &owner)
Construct null from owner.
static autoPtr< DampingModel< CloudType > > New(const dictionary &dict, CloudType &owner)
Selector.
Base class for time scale models.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition autoPtr.H:65
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition dictionary.H:133
const dictionary & coeffDict() const
Return const access to the coefficients dictionary.
const dictionary & dict() const
Return const access to the cloud dictionary.
const word & modelType() const
Return const access to the sub-model type.
A class for handling words, derived from Foam::string.
Definition word.H:66
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition error.H:637
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh > > &tf1, const word &name, const dimensionSet &dimensions, const bool initCopy=false)
Global function forwards to reuseTmpDimensionedField::New.
DSMCCloud< dsmcParcel > CloudType
messageStream Info
Information stream (stdout output on master, null elsewhere).
const word GlobalIOList< Tuple2< scalar, vector > >::typeName("scalarVectorTable")
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition Ostream.H:519
errorManip< error > abort(error &err)
Definition errorManip.H:139
IOerror FatalIOError
Error stream (stdout output on all processes), with additional 'FOAM FATAL IO ERROR' header text and ...
dictionary dict