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-2021 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 /*---------------------------------------------------------------------------*\
43  Class NoSurfaceReaction Declaration
44 \*---------------------------------------------------------------------------*/
45 
46 template<class CloudType>
48 :
49  public SurfaceReactionModel<CloudType>
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 ~NoSurfaceReaction();
77 
78 
79  // Member Functions
80 
81  //- Update surface reactions
82  virtual scalar calculate
83  (
84  const scalar dt,
85  const label celli,
86  const scalar d,
87  const scalar T,
88  const scalar Tc,
89  const scalar pc,
90  const scalar rhoc,
91  const scalar mass,
92  const scalarField& YGas,
93  const scalarField& YLiquid,
94  const scalarField& YSolid,
95  const scalarField& YMixture,
96  const scalar N,
97  scalarField& dMassGas,
98  scalarField& dMassLiquid,
99  scalarField& dMassSolid,
100  scalarField& dMassSRCarrier
101  ) const;
102 
103 
104  // I-O
105 
106  //- Write injection info to stream
107  virtual void info(Ostream& os);
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #ifdef NoRepository
118  #include "NoSurfaceReaction.C"
119 #endif
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
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:156
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
virtual void info(Ostream &os)
Write injection info to stream.
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.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
label N
Definition: createFields.H:9
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:75
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.