NoDamping.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) 2013-2018 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::DampingModels::NoDamping
26 
27 Description
28 
29 SourceFiles
30  NoDamping.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef NoDamping_H
35 #define NoDamping_H
36 
37 #include "DampingModel.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 namespace DampingModels
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class NoDamping Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class CloudType>
51 class NoDamping
52 :
53  public DampingModel<CloudType>
54 {
55 public:
56 
57  //- Runtime type information
58  TypeName("none");
59 
60  // Constructors
61 
62  //- Construct from components
64 
65  //- Construct copy
67 
68  //- Construct and return a clone
69  virtual autoPtr<DampingModel<CloudType>> clone() const
70  {
72  (
73  new NoDamping<CloudType>(*this)
74  );
75  }
76 
77 
78  //- Destructor
79  virtual ~NoDamping();
80 
81 
82  //- Member Functions
83 
84  //- Calculate the velocity correction
86  (
87  typename CloudType::parcelType& p,
88  const scalar deltaT
89  ) const;
90 
91  //- Return the model 'active' status
92  virtual bool active() const;
93 };
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 } // End namespace DampingModels
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #ifdef NoRepository
104  #include "NoDamping.C"
105 #endif
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
virtual ~NoDamping()
Destructor.
Definition: NoDamping.C:54
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
NoDamping(const dictionary &dict, CloudType &owner)
Construct from components.
Definition: NoDamping.C:32
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
const CloudType & owner() const
Return const access to the owner cloud.
virtual vector velocityCorrection(typename CloudType::parcelType &p, const scalar deltaT) const
Member Functions.
Definition: NoDamping.C:61
virtual autoPtr< DampingModel< CloudType > > clone() const
Construct and return a clone.
Definition: NoDamping.H:68
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:218
virtual bool active() const
Return the model &#39;active&#39; status.
Definition: NoDamping.C:71
TypeName("none")
Runtime type information.
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
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
Base class for collisional damping models.
Definition: MPPICCloud.H:56
Namespace for OpenFOAM.