interfacialGrowthGroupFractionFvScalarFieldSource.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) 2025-2026 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::interfacialGrowthGroupFractionFvScalarFieldSource
26 
27 Description
28  This source condition creates an interfacial growth transfer source term in
29  the group fraction equations of a population balance model, consistent with
30  interfacial mass transfer of phase change or similar.
31 
32 Usage
33  Example of the source condition specification:
34  \verbatim
35  <sourceName>
36  {
37  type interfacialGrowthGroupFraction;
38  libs ("libmultiphaseEulerFvModels.so");
39  }
40  \endverbatim
41 
42 SourceFiles
43  interfacialGrowthGroupFractionFvScalarFieldSource.C
44 
45 \*---------------------------------------------------------------------------*/
46 
47 #ifndef interfacialGrowthGroupFractionFvScalarFieldSource_H
48 #define interfacialGrowthGroupFractionFvScalarFieldSource_H
49 
51 
52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 
54 namespace Foam
55 {
56 
57 /*---------------------------------------------------------------------------*\
58  Class interfacialGrowthGroupFractionFvScalarFieldSource Declaration
59 \*---------------------------------------------------------------------------*/
60 
62 :
64 {
65 private:
66 
67  // Private Member Functions
68 
69  //- Return the moment of the diameter with which the source term scales
70  virtual label q() const
71  {
72  return 2;
73  }
74 
75 
76 public:
77 
78  //- Runtime type information
79  TypeName("interfacialGrowthGroupFraction");
80 
81 
82  // Constructors
83 
84  //- Inherit constructors
85  using
88 
89  //- Construct and return a clone setting internal field reference
91  (
93  ) const
94  {
96  (
98  (
99  *this,
100  iF
101  )
102  );
103  }
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
Base class for source conditions that create a growth source terms in the group fraction equations of...
growthGroupFractionFvScalarFieldSource(const DimensionedField< scalar, fvMesh > &, const dictionary &dict)
Construct from internal field and dictionary.
This source condition creates an interfacial growth transfer source term in the group fraction equati...
virtual autoPtr< fvScalarFieldSource > clone(const DimensionedField< scalar, fvMesh > &iF) const
Construct and return a clone setting internal field reference.
TypeName("interfacialGrowthGroupFraction")
Runtime type information.
Namespace for OpenFOAM.
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