FreeFOAM The Cross-Platform CFD Toolkit
NoDevolatilisation.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 | Copyright (C) 2008-2010 OpenCFD Ltd.
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::NoDevolatilisation
26 
27 Description
28  Dummy devolatilisation model for 'none'
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef NoDevolatilisation_H
33 #define NoDevolatilisation_H
34 
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 /*---------------------------------------------------------------------------*\
42  Class NoDevolatilisation Declaration
43 \*---------------------------------------------------------------------------*/
44 
45 template<class CloudType>
47 :
48  public DevolatilisationModel<CloudType>
49 {
50 
51 public:
52 
53  //- Runtime type information
54  TypeName("none");
55 
56 
57  // Constructors
58 
59  //- Construct from dictionary
60  NoDevolatilisation(const dictionary&, CloudType& owner);
61 
62 
63  //- Destructor
64  virtual ~NoDevolatilisation();
65 
66 
67  // Member Functions
68 
69  //- Flag to indicate whether model activates devolatilisation model
70  virtual bool active() const;
71 
72  //- Update model
73  virtual scalar calculate
74  (
75  const scalar,
76  const scalar,
77  const scalar,
78  const scalar,
79  const scalar,
80  const scalar,
81  bool&
82  ) const;
83 };
84 
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #ifdef NoRepository
93 # include "NoDevolatilisation.C"
94 #endif
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************ vim: set sw=4 sts=4 et: ************************ //