All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
NoDevolatilisation.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-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::NoDevolatilisation
26 
27 Description
28  Dummy devolatilisation model for 'none'
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef NoDevolatilisation_H
33 #define NoDevolatilisation_H
34 
35 #include "DevolatilisationModel.H"
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
61 
62  //- Construct copy
64 
65  //- Construct and return a clone
67  {
69  (
71  );
72  }
73 
74 
75  //- Destructor
76  virtual ~NoDevolatilisation();
77 
78 
79  // Member Functions
80 
81  //- Flag to indicate whether model activates devolatilisation model
82  virtual bool active() const;
83 
84  //- Update model
85  virtual void calculate
86  (
87  const scalar dt,
88  const scalar age,
89  const scalar mass0,
90  const scalar mass,
91  const scalar T,
92  const scalarField& YGasEff,
93  const scalarField& YLiquidEff,
94  const scalarField& YSolidEff,
95  label& canCombust,
96  scalarField& dMassDV
97  ) const;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #ifdef NoRepository
108  #include "NoDevolatilisation.C"
109 #endif
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual bool active() const
Flag to indicate whether model activates devolatilisation model.
const CloudType & owner() const
Return const access to the owner cloud.
virtual autoPtr< DevolatilisationModel< CloudType > > clone() const
Construct and return a clone.
virtual void calculate(const scalar dt, const scalar age, const scalar mass0, const scalar mass, const scalar T, const scalarField &YGasEff, const scalarField &YLiquidEff, const scalarField &YSolidEff, label &canCombust, scalarField &dMassDV) const
Update model.
TypeName("none")
Runtime type information.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
virtual ~NoDevolatilisation()
Destructor.
Templated devolatilisation model class.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
NoDevolatilisation(const dictionary &, CloudType &owner)
Construct from dictionary.
Namespace for OpenFOAM.
Dummy devolatilisation model for &#39;none&#39;.