InertPhaseModel.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) 2015 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::InertPhaseModel
26 
27 Description
28  Class which represents an inert phase, with no reactions. Returns zero
29  reaction rate and heat.
30 
31 SourceFiles
32  InertPhaseModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef InertPhaseModel_H
37 #define InertPhaseModel_H
38 
39 #include "phaseModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class phaseModel Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class BasePhaseModel>
51 class InertPhaseModel
52 :
53  public BasePhaseModel
54 {
55 public:
56 
57  // Constructors
58 
60  (
61  const phaseSystem& fluid,
62  const word& phaseName,
63  const label index
64  );
65 
66 
67  //- Destructor
68  virtual ~InertPhaseModel();
69 
70 
71  // Member Functions
72 
73  // Thermo
74 
75  //- Return the fuel consumption rate matrix
76  virtual tmp<fvScalarMatrix> R
77  (
78  volScalarField& Yi
79  ) const;
80 
81  //- Return the reaction heat source
82  virtual tmp<volScalarField> Sh() const;
83 };
84 
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #ifdef NoRepository
93 # include "InertPhaseModel.C"
94 #endif
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
multiphaseSystem & fluid
Definition: createFields.H:10
Class to represent a system of phases and model interfacial transfers between them.
Definition: phaseSystem.H:67
A class for handling words, derived from string.
Definition: word.H:59
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
Namespace for OpenFOAM.
virtual ~InertPhaseModel()
Destructor.
virtual tmp< fvScalarMatrix > R(volScalarField &Yi) const
Return the fuel consumption rate matrix.
InertPhaseModel(const phaseSystem &fluid, const word &phaseName, const label index)
A class for managing temporary objects.
Definition: PtrList.H:118
virtual tmp< volScalarField > Sh() const
Return the reaction heat source.
Class which represents an inert phase, with no reactions. Returns zero reaction rate and heat...