BinaryCollisionModel.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) 2011-2015 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "BinaryCollisionModel.H"
29 
30 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31 
32 template<class CloudType>
34 :
35  dict_(dictionary::null),
36  owner_(owner),
37  coeffDict_(dictionary::null)
38 {}
39 
40 
41 template<class CloudType>
43 (
44  const dictionary& dict,
45  CloudType& owner,
46  const word& type
47 )
48 :
49  dict_(dict),
50  owner_(owner),
51  coeffDict_(dict.subDict(type + "Coeffs"))
52 {}
53 
54 
55 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
56 
57 template<class CloudType>
59 {}
60 
61 
62 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
63 
64 template<class CloudType>
65 const CloudType&
67 {
68  return owner_;
69 }
70 
71 
72 template<class CloudType>
73 CloudType&
75 {
76  return owner_;
77 }
78 
79 
80 template<class CloudType>
81 const Foam::dictionary&
83 {
84  return dict_;
85 }
86 
87 
88 template<class CloudType>
89 const Foam::dictionary&
91 {
92  return coeffDict_;
93 }
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
99 
100 // ************************************************************************* //
Foam::BinaryCollisionModel::owner
const CloudType & owner() const
Return the owner cloud object.
Definition: BinaryCollisionModel.C:66
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
BinaryCollisionModel.H
BinaryCollisionModelNew.C
Foam::BinaryCollisionModel::BinaryCollisionModel
BinaryCollisionModel(CloudType &owner)
Construct null from owner.
Definition: BinaryCollisionModel.C:33
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::BinaryCollisionModel::~BinaryCollisionModel
virtual ~BinaryCollisionModel()
Destructor.
Definition: BinaryCollisionModel.C:58
Foam::BinaryCollisionModel::dict
const dictionary & dict() const
Return the dictionary.
Definition: BinaryCollisionModel.C:82
Foam::roots::type
type
Types of root.
Definition: Roots.H:54
Foam::BinaryCollisionModel::coeffDict
const dictionary & coeffDict() const
Return the coefficients dictionary.
Definition: BinaryCollisionModel.C:90