dispersedLiftModel.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) 2011-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::dispersedLiftModel
26 
27 Description
28  Model for lift between two phases where one phase can be considered
29  dispersed in the other and the lift therefore characterised by a lift
30  coefficient
31 
32 SourceFiles
33  dispersedLiftModel.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef dispersedLiftModel_H
38 #define dispersedLiftModel_H
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 #include "liftModel.H"
44 
45 namespace Foam
46 {
47 namespace liftModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class dispersedLiftModel Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public liftModel
57 {
58 protected:
59 
60  // Protected data
61 
62  //- Interface
64 
65 
66 public:
67 
68  // Constructors
69 
70  // Construct from a dictionary and an interface
72  (
73  const dictionary& dict,
74  const phaseInterface& interface
75  );
76 
77 
78  //- Destructor
79  virtual ~dispersedLiftModel();
80 
81 
82  // Member Functions
83 
84  //- Lift coefficient
85  virtual tmp<volScalarField> Cl() const = 0;
86 
87  //- Return phase-intensive lift force
88  virtual tmp<volVectorField> Fi() const;
89 
90  //- Return lift force
91  virtual tmp<volVectorField> F() const;
92 
93  //- Return face lift force
94  virtual tmp<surfaceScalarField> Ff() const;
95 };
96 
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 } // End namespace dragModels
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #endif
106 
107 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Class to represent a interface between phases where one phase is considered dispersed within the othe...
Model for the lift force between two phases.
Definition: liftModel.H:53
virtual tmp< surfaceScalarField > Ff() const
Return face lift force.
virtual tmp< volVectorField > F() const
Return lift force.
virtual tmp< volScalarField > Cl() const =0
Lift coefficient.
const dispersedPhaseInterface interface_
Interface.
dispersedLiftModel(const dictionary &dict, const phaseInterface &interface)
virtual tmp< volVectorField > Fi() const
Return phase-intensive lift force.
Class to represent an interface between phases. Derivations can further specify the configuration of ...
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
dictionary dict