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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2015 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
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 "NoBinaryCollision.H"
29#include "constants.H"
30
31using namespace Foam::constant::mathematical;
32
33// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
34
35template<class CloudType>
37(
38 const dictionary& dict,
40)
41:
43{}
44
45
46// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
47
48template<class CloudType>
50{}
51
52
53// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
54
55template<class CloudType>
57{
58 return false;
59}
60
61
62template<class CloudType>
64(
65 const typename CloudType::parcelType& pP,
66 const typename CloudType::parcelType& pQ
67) const
68{
70 << "sigmaTcR called on NoBinaryCollision model, this should "
71 << "not happen, this is not an actual model." << nl
72 << "Enclose calls to sigmaTcR within a if (binaryCollision().active()) "
73 << " check."
74 << abort(FatalError);
75
76 return 0.0;
77}
78
79
80template<class CloudType>
82(
83 typename CloudType::parcelType& pP,
84 typename CloudType::parcelType& pQ
85)
86{}
87
88
89// ************************************************************************* //
Templated DSMC particle collision class.
virtual void collide()=0
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:75
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:220
No collison BinaryCollision Model.
virtual scalar sigmaTcR(const typename CloudType::parcelType &pP, const typename CloudType::parcelType &pQ) const
Return the collision cross section * relative velocity product.
virtual ~NoBinaryCollision()
Destructor.
virtual bool active() const
Flag to indicate whether model activates collision model.
A cloud is a registry collection of lagrangian particles.
Definition: cloud.H:60
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
Mathematical constants.
errorManip< error > abort(error &err)
Definition: errorManip.H:144
error FatalError
constexpr char nl
The newline '\n' character (0x0a)
Definition: Ostream.H:53
dictionary dict