fixedInterfacialAreaDiameter.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) 2023 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::fixedInterfacialArea
26 
27 Description
28  fixedInterfacialArea dispersed-phase diameter model.
29  The interfacial are is set by providing phase surface area divided by phase
30  volume, AvbyAlpha, either as a constant value or as a field.
31 
32 SourceFiles
33  fixedInterfacialAreaDiameter.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef fixedInterfacialAreaDiameter_H
38 #define fixedInterfacialAreaDiameter_H
39 
40 #include "diameterModel.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace diameterModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class fixedInterfacialArea Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public diameterModel
56 {
57  // Private Data
58 
59  //- Uniform fixed area by volume of the stationary phase for calculation
60  // of the interfacial area
61  dimensionedScalar AvbyAlpha_;
62 
63  //- Optional area by volume field of the stationary phase for
64  // calculation of interfacial area
65  autoPtr<volScalarField> AvbyAlphaFieldPtr_;
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("fixedInterfacialArea");
72 
73 
74  // Constructors
75 
76  //- Construct from dictionary and phase
78  (
80  const phaseModel& phase
81  );
82 
83 
84  //- Destructor
85  virtual ~fixedInterfacialArea();
86 
87 
88  // Member Functions
89 
90  //- Get the diameter field
91  virtual tmp<volScalarField> d() const;
92 
93  //- Get the surface area per unit volume field
94  virtual tmp<volScalarField> Av() const;
95 
96  //- Read diameterProperties dictionary
97  virtual bool read(const dictionary& diameterProperties);
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace diameterModels
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
Abstract base-class for dispersed-phase particle diameter models.
Definition: diameterModel.H:52
const phaseModel & phase() const
Return the phase.
const dictionary & diameterProperties() const
Return the phase diameter properties dictionary.
fixedInterfacialArea dispersed-phase diameter model. The interfacial are is set by providing phase su...
fixedInterfacialArea(const dictionary &diameterProperties, const phaseModel &phase)
Construct from dictionary and phase.
virtual bool read(const dictionary &diameterProperties)
Read diameterProperties dictionary.
virtual tmp< volScalarField > d() const
Get the diameter field.
virtual tmp< volScalarField > Av() const
Get the surface area per unit volume field.
TypeName("fixedInterfacialArea")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.