NoInteraction.H
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-2020 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 Class
25  Foam::NoInteraction
26 
27 Description
28  Dummy class for 'none' option - will raise an error if any functions are
29  called that require return values.
30 
31 \*---------------------------------------------------------------------------*/
32 
33 #ifndef NoInteraction_H
34 #define NoInteraction_H
35 
36 #include "PatchInteractionModel.H"
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 /*---------------------------------------------------------------------------*\
43  Class NoInteraction Declaration
44 \*---------------------------------------------------------------------------*/
45 
46 template<class CloudType>
47 class NoInteraction
48 :
49  public PatchInteractionModel<CloudType>
50 {
51 public:
52 
53  //- Runtime type information
54  TypeName("none");
55 
56 
57  // Constructors
58 
59  //- Construct from dictionary
61 
62  //- Construct copy
64 
65  //- Construct and return a clone
67  {
69  (
70  new NoInteraction<CloudType>(*this)
71  );
72  }
73 
74 
75  //- Destructor
76  virtual ~NoInteraction();
77 
78 
79  // Member Functions
80 
81  //- Apply velocity correction
82  // Returns true if particle remains in same cell
83  virtual bool correct
84  (
85  typename CloudType::parcelType& p,
86  const polyPatch& pp,
87  bool& keepParticle
88  );
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #ifdef NoRepository
99  #include "NoInteraction.C"
100 #endif
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
Templated patch interaction model class.
Definition: MomentumCloud.H:83
TypeName("none")
Runtime type information.
A cloud is a collection of lagrangian particles.
Definition: cloud.H:51
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:221
virtual autoPtr< PatchInteractionModel< CloudType > > clone() const
Construct and return a clone.
Definition: NoInteraction.H:65
virtual bool correct(typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle)
Apply velocity correction.
Definition: NoInteraction.C:62
Dummy class for &#39;none&#39; option - will raise an error if any functions are called that require return v...
Definition: NoInteraction.H:46
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
volScalarField & p
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:66
virtual ~NoInteraction()
Destructor.
Definition: NoInteraction.C:54
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:75
Namespace for OpenFOAM.
NoInteraction(const dictionary &dict, CloudType &cloud)
Construct from dictionary.
Definition: NoInteraction.C:32