ParkRogakGroupSurfaceAreaVolumeRatioFvScalarFieldSource.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) 2024-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::ParkRogakGroupSurfaceAreaVolumeRatioFvScalarFieldSource
26 
27 Description
28  This source condition creates an interfacial mass transfer source term in
29  the group surface-area-to-volume-ratio (kappa) equations of the fractal
30  shape model of a population balance model, according to the model of Park
31  and Rogak.
32 
33  Reference:
34  \verbatim
35  Park, S. H., & Rogak, S. N. (2004).
36  A novel fixed-sectional model for the formation and growth of aerosol
37  agglomerates.
38  Journal of Aerosol Science, 35(11), 1385-1404.
39  \endbverbatim
40 
41 Usage
42  Example of the source condition specification:
43  \verbatim
44  <sourceName>
45  {
46  type ParkRogakGroupSurfaceAreaVolumeRatio;
47  libs ("libmultiphaseEulerFvModels.so");
48  }
49  \endverbatim
50 
51 SourceFiles
52  ParkRogakGroupSurfaceAreaVolumeRatioFvScalarFieldSource.C
53 
54 \*---------------------------------------------------------------------------*/
55 
56 #ifndef ParkRogakGroupSurfaceAreaVolumeRatioFvScalarFieldSource_H
57 #define ParkRogakGroupSurfaceAreaVolumeRatioFvScalarFieldSource_H
58 
60 
61 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
62 
63 namespace Foam
64 {
65 
66 /*---------------------------------------------------------------------------*\
67  Class ParkRogakGroupSurfaceAreaVolumeRatioFvScalarFieldSource Declaration
68 \*---------------------------------------------------------------------------*/
69 
71 :
73 {
74 public:
75 
76  //- Runtime type information
77  TypeName("ParkRogakGroupSurfaceAreaVolumeRatio");
78 
79 
80  // Constructors
81 
82  //- Inherit constructors
83  using
86 
87  //- Construct and return a clone setting internal field reference
89  (
91  ) const
92  {
94  (
96  (
97  *this,
98  iF
99  )
100  );
101  }
102 
103 
104  // Member Functions
105 
106  //- Return the value transported from an adjacent group
108  (
109  const label j,
110  const fvSource& model
111  ) const;
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
This source condition creates an interfacial mass transfer source term in the group surface-area-to-v...
virtual autoPtr< fvScalarFieldSource > clone(const DimensionedField< scalar, fvMesh > &iF) const
Construct and return a clone setting internal field reference.
virtual tmp< DimensionedField< scalar, fvMesh > > value(const label j, const fvSource &model) const
Return the value transported from an adjacent group.
TypeName("ParkRogakGroupSurfaceAreaVolumeRatio")
Runtime type information.
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 finite volume sources.
Definition: fvSource.H:53
Base class for source conditions which create a growth source terms for secondary properties of the g...
growthSecondaryPropertyFvScalarFieldSource(const DimensionedField< scalar, fvMesh > &, const dictionary &dict)
Construct from internal field and dictionary.
A class for managing temporary objects.
Definition: tmp.H:55
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