NoIsotropy.H
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) 2013-2016 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 Class
27  Foam::IsotropyModels::NoIsotropy
28 
29 Group
30  grpLagrangianIntermediateMPPICIsotropySubModels
31 
32 Description
33  Place holder for the 'none' option
34 
35 SourceFiles
36  NoIsotropy.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef NoIsotropy_H
41 #define NoIsotropy_H
42 
43 #include "IsotropyModel.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace IsotropyModels
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class NoIsotropy Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 template<class CloudType>
57 class NoIsotropy
58 :
59  public IsotropyModel<CloudType>
60 {
61 public:
62 
63  //- Runtime type information
64  TypeName("none");
65 
66  // Constructors
67 
68  //- Construct from components
70 
71  //- Construct copy
73 
74  //- Construct and return a clone
76  {
78  (
79  new NoIsotropy<CloudType>(*this)
80  );
81  }
82 
83 
84  //- Destructor
85  virtual ~NoIsotropy();
86 
87 
88  //- Member Functions
89 
90  //- Calculate velocities
91  virtual void calculate();
92 
93  //- Return the model 'active' status
94  virtual bool active() const;
95 };
96 
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 } // End namespace IsotropyModels
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #ifdef NoRepository
106  #include "NoIsotropy.C"
107 #endif
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
virtual void calculate()
Member Functions.
Definition: NoIsotropy.C:56
TypeName("none")
Runtime type information.
virtual bool active() const
Return the model &#39;active&#39; status.
Definition: NoIsotropy.C:61
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:104
virtual autoPtr< IsotropyModel< CloudType > > clone() const
Construct and return a clone.
Definition: NoIsotropy.H:78
const CloudType & owner() const
Return const access to the owner cloud.
Place holder for the &#39;none&#39; option.
Definition: NoIsotropy.H:52
Base class for collisional return-to-isotropy models.
NoIsotropy(const dictionary &dict, CloudType &owner)
Construct from components.
Definition: NoIsotropy.C:27
Pointer management similar to std::unique_ptr, with some additional methods and type checking...
Definition: HashPtrTable.H:48
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:67
virtual ~NoIsotropy()
Destructor.
Definition: NoIsotropy.C:49
Namespace for OpenFOAM.