NoSurfaceReaction.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::NoSurfaceReaction
26 
27 Description
28  Dummy surface reaction model for 'none'
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef NoSurfaceReaction_H
33 #define NoSurfaceReaction_H
34 
35 #include "SurfaceReactionModel.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 /*---------------------------------------------------------------------------*\
42  Class NoSurfaceReaction Declaration
43 \*---------------------------------------------------------------------------*/
44 
45 template<class CloudType>
47 :
48  public SurfaceReactionModel<CloudType>
49 {
50 public:
51 
52  //- Runtime type information
53  TypeName("none");
54 
55 
56  // Constructors
57 
58  //- Construct from dictionary
60 
61  //- Construct copy
63 
64  //- Construct and return a clone
66  {
68  (
70  );
71  }
72 
73 
74  //- Destructor
75  virtual ~NoSurfaceReaction();
76 
77 
78  // Member Functions
79 
80  //- Flag to indicate whether model activates devolatisation model
81  virtual bool active() const;
82 
83  //- Update surface reactions
84  virtual scalar calculate
85  (
86  const scalar dt,
87  const label celli,
88  const scalar d,
89  const scalar T,
90  const scalar Tc,
91  const scalar pc,
92  const scalar rhoc,
93  const scalar mass,
94  const scalarField& YGas,
95  const scalarField& YLiquid,
96  const scalarField& YSolid,
97  const scalarField& YMixture,
98  const scalar N,
99  scalarField& dMassGas,
100  scalarField& dMassLiquid,
101  scalarField& dMassSolid,
102  scalarField& dMassSRCarrier
103  ) const;
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #ifdef NoRepository
114  #include "NoSurfaceReaction.C"
115 #endif
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
TypeName("none")
Runtime type information.
virtual ~NoSurfaceReaction()
Destructor.
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:137
virtual bool active() const
Flag to indicate whether model activates devolatisation model.
virtual autoPtr< SurfaceReactionModel< CloudType > > clone() const
Construct and return a clone.
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.
Dummy surface reaction model for &#39;none&#39;.
NoSurfaceReaction(const dictionary &dict, CloudType &owner)
Construct from dictionary.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
label N
Definition: createFields.H:22
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 surface reaction model class.
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
virtual scalar calculate(const scalar dt, const label celli, const scalar d, const scalar T, const scalar Tc, const scalar pc, const scalar rhoc, const scalar mass, const scalarField &YGas, const scalarField &YLiquid, const scalarField &YSolid, const scalarField &YMixture, const scalar N, scalarField &dMassGas, scalarField &dMassLiquid, scalarField &dMassSolid, scalarField &dMassSRCarrier) const
Update surface reactions.
Namespace for OpenFOAM.