StochasticCollisionModel.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-2017 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 
29 
30 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31 
32 template<class CloudType>
34 (
35  CloudType& owner
36 )
37 :
39 {}
40 
41 
42 template<class CloudType>
44 (
46 )
47 :
49 {}
50 
51 
52 template<class CloudType>
54 (
55  const dictionary& dict,
56  CloudType& owner,
57  const word& type
58 )
59 :
60  CloudSubModelBase<CloudType>(owner, dict, typeName, type)
61 {}
62 
63 
64 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
65 
66 template<class CloudType>
68 {}
69 
70 
71 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
72 
73 template<class CloudType>
75 (
76  typename CloudType::parcelType::trackingData& td,
77  const scalar dt
78 )
79 {
80  if (this->active())
81  {
82  this->collide(td, dt);
83  }
84 }
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
90 
91 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
StochasticCollisionModelNew.C
Foam::CloudSubModelBase
Base class for cloud sub-models.
Definition: CloudSubModelBase.H:51
Foam::StochasticCollisionModel::~StochasticCollisionModel
virtual ~StochasticCollisionModel()
Destructor.
Definition: StochasticCollisionModel.C:67
Foam::StochasticCollisionModel::StochasticCollisionModel
StochasticCollisionModel(CloudType &owner)
Construct null from owner.
Definition: StochasticCollisionModel.C:34
Foam::StochasticCollisionModel
Templated stochastic collision model class.
Definition: KinematicCloud.H:95
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
StochasticCollisionModel.H
Foam::roots::type
type
Types of root.
Definition: Roots.H:54
Foam::StochasticCollisionModel::update
void update(typename CloudType::parcelType::trackingData &td, const scalar dt)
Update the model.
Definition: StochasticCollisionModel.C:75