NoBinaryCollision.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 | Copyright (C) 2011-2015 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 "NoBinaryCollision.H"
27 #include "constants.H"
28 
29 using namespace Foam::constant::mathematical;
30 
31 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32 
33 template<class CloudType>
35 (
36  const dictionary& dict,
37  CloudType& cloud
38 )
39 :
41 {}
42 
43 
44 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
45 
46 template<class CloudType>
48 {}
49 
50 
51 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
52 
53 template<class CloudType>
55 {
56  return false;
57 }
58 
59 
60 template<class CloudType>
62 (
63  const typename CloudType::parcelType& pP,
64  const typename CloudType::parcelType& pQ
65 ) const
66 {
68  << "sigmaTcR called on NoBinaryCollision model, this should "
69  << "not happen, this is not an actual model." << nl
70  << "Enclose calls to sigmaTcR within a if (binaryCollision().active()) "
71  << " check."
72  << abort(FatalError);
73 
74  return 0.0;
75 }
76 
77 
78 template<class CloudType>
80 (
81  typename CloudType::parcelType& pP,
82  typename CloudType::parcelType& pQ
83 )
84 {}
85 
86 
87 // ************************************************************************* //
virtual bool active() const
Flag to indicate whether model activates collision model.
error FatalError
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual ~NoBinaryCollision()
Destructor.
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:319
Templated DSMC particle collision class.
Definition: DSMCCloud.H:55
mathematical constants.
virtual void collide(typename CloudType::parcelType &pP, typename CloudType::parcelType &pQ)
Apply collision.
errorManip< error > abort(error &err)
Definition: errorManip.H:131
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:217
static const char nl
Definition: Ostream.H:262
virtual scalar sigmaTcR(const typename CloudType::parcelType &pP, const typename CloudType::parcelType &pQ) const
Return the collision cross section * relative velocity product.
NoBinaryCollision(const dictionary &dict, CloudType &cloud)
Construct from dictionary.
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:68