All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
reactionDriven.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) 2019-2020 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::diameterModels::nucleationModels::constantNucleation
26 
27 Description
28  Nucleation source due to reactions. Applicable for irreversible
29  reactions only.
30 
31 SourceFiles
32  reactionDriven.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef reactionDriven_H
37 #define reactionDriven_H
38 
39 #include "nucleationModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace diameterModels
46 {
47 namespace nucleationModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class reactionDriven Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class reactionDriven
55 :
56  public nucleationModel
57 {
58  // Private Data
59 
60  //- Sphere-equivalent nucleation diameter
61  const dimensionedScalar dNuc_;
62 
63  //- Velocity group in which the nucleation occurs
64  const velocityGroup& velGroup_;
65 
66  //- Phase in which the reaction occurs
67  const phaseModel& reactingPhase_;
68 
69  //- PhasePair between which the nucleation occurs
70  const phasePair pair_;
71 
72  //- Name of the mass transfer rate
73  const word dmdtfName_;
74 
75  //- Name of the specie which nucleates
76  const word specieName_;
77 
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("reactionDriven");
83 
84  // Constructor
85 
87  (
89  const dictionary& dict
90  );
91 
92 
93  //- Destructor
94  virtual ~reactionDriven()
95  {}
96 
97 
98  // Member Functions
99 
100  //- Add to nucleationRate
101  virtual void addToNucleationRate
102  (
103  volScalarField& nucleationRate,
104  const label i
105  );
106 };
107 
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 } // End namespace nucleationModels
112 } // End namespace diameterModels
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
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
reactionDriven(const populationBalanceModel &popBal, const dictionary &dict)
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
Class that solves the univariate population balance equation by means of a class method (also called ...
TypeName("reactionDriven")
Runtime type information.
This diameterModel is intended for use with a populationBalanceModel in order to simulate polydispers...
const dictionary & dict() const
Return reference to model dictionary.
Base class for nucleation models.
A class for handling words, derived from string.
Definition: word.H:59
virtual void addToNucleationRate(volScalarField &nucleationRate, const label i)
Add to nucleationRate.
const populationBalanceModel & popBal() const
Return reference to the populationBalanceModel.
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:53
Namespace for OpenFOAM.