liftModel.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) 2014-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::liftModel
26 
27 Description
28  Model for the lift force between two phases
29 
30 SourceFiles
31  liftModel.C
32  liftModelNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef liftModel_H
37 #define liftModel_H
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 #include "volFields.H"
42 #include "dictionary.H"
43 #include "runTimeSelectionTables.H"
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class liftModel Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class liftModel
54 {
55 public:
56 
57  //- Runtime type information
58  TypeName("liftModel");
59 
60 
61  // Declare runtime construction
62 
64  (
65  autoPtr,
66  liftModel,
67  dictionary,
68  (
69  const dictionary& dict,
70  const phaseInterface& interface
71  ),
72  (dict, interface)
73  );
74 
75 
76  // Static Data Members
77 
78  //- Force dimensions
79  static const dimensionSet dimF;
80 
81  //- Does this model require correcting on fixed flux boundaries?
82  static const bool correctFixedFluxBCs = true;
83 
84 
85  // Constructors
86 
87  //- Construct from a dictionary and an interface
88  liftModel
89  (
90  const dictionary& dict,
91  const phaseInterface& interface
92  );
93 
94 
95  //- Destructor
96  virtual ~liftModel();
97 
98 
99  // Selectors
100 
101  static autoPtr<liftModel> New
102  (
103  const dictionary& dict,
104  const phaseInterface& interface,
105  const bool outer=true
106  );
107 
108 
109  // Member Functions
110 
111  //- Return lift force
112  virtual tmp<volVectorField> F() const = 0;
113 
114  //- Return face lift force
115  virtual tmp<surfaceScalarField> Ff() const = 0;
116 };
117 
118 
119 /*---------------------------------------------------------------------------*\
120  Class blendedLiftModel Declaration
121 \*---------------------------------------------------------------------------*/
122 
123 class blendedLiftModel
124 :
125  public BlendedInterfacialModel<liftModel>
126 {
127 public:
128 
129  // Constructors
130 
131  //- Inherit base class constructors
133 
134 
135  // Selectors
136 
138  (
139  const dictionary& dict,
141  );
142 
143 
144  // Member Functions
145 
146  //- Return lift force
147  tmp<volVectorField> F() const;
148 
149  //- Return face lift force
150  tmp<surfaceScalarField> Ff() const;
151 };
152 
153 
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 } // End namespace Foam
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 #endif
162 
163 // ************************************************************************* //
const phaseInterface & interface() const
Access the interface.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
tmp< surfaceScalarField > Ff() const
Return face lift force.
Definition: liftModel.C:64
tmp< volVectorField > F() const
Return lift force.
Definition: liftModel.C:58
static autoPtr< blendedLiftModel > New(const dictionary &dict, const phaseInterface &interface)
Definition: liftModelNew.C:64
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Dimension set for the base types.
Definition: dimensionSet.H:125
Model for the lift force between two phases.
Definition: liftModel.H:53
static const bool correctFixedFluxBCs
Does this model require correcting on fixed flux boundaries?
Definition: liftModel.H:81
TypeName("liftModel")
Runtime type information.
static const dimensionSet dimF
Force dimensions.
Definition: liftModel.H:78
declareRunTimeSelectionTable(autoPtr, liftModel, dictionary,(const dictionary &dict, const phaseInterface &interface),(dict, interface))
virtual tmp< surfaceScalarField > Ff() const =0
Return face lift force.
virtual tmp< volVectorField > F() const =0
Return lift force.
liftModel(const dictionary &dict, const phaseInterface &interface)
Construct from a dictionary and an interface.
Definition: liftModel.C:43
virtual ~liftModel()
Destructor.
Definition: liftModel.C:52
static autoPtr< liftModel > New(const dictionary &dict, const phaseInterface &interface, const bool outer=true)
Definition: liftModelNew.C:32
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.
void outer(FieldField< Field1, typename outerProduct< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Macros to ease declaration of run-time selection tables.
dictionary dict