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