PairModel.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 "PairModel.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class CloudType>
32 (
33  const dictionary& dict,
34  CloudType& owner,
35  const word& type
36 )
37 :
38  dict_(dict),
39  owner_(owner),
40  coeffDict_(dict.subDict(type + "Coeffs"))
41 {}
42 
43 
44 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
45 
46 template<class CloudType>
48 {}
49 
50 
51 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
52 
53 template<class CloudType>
54 const CloudType&
56 {
57  return owner_;
58 }
59 
60 
61 template<class CloudType>
63 {
64  return dict_;
65 }
66 
67 
68 template<class CloudType>
69 const Foam::dictionary&
71 {
72  return coeffDict_;
73 }
74 
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 #include "PairModelNew.C"
79 
80 // ************************************************************************* //
const dictionary & dict() const
Return the dictionary.
Definition: PairModel.C:62
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:699
A class for handling words, derived from string.
Definition: word.H:59
const CloudType & owner() const
Return the owner cloud object.
Definition: PairModel.C:55
const dictionary & coeffDict() const
Return the coefficients dictionary.
Definition: PairModel.C:70
virtual ~PairModel()
Destructor.
Definition: PairModel.C:47
PairModel(const dictionary &dict, CloudType &owner, const word &type)
Construct from components.
Definition: PairModel.C:32
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69