noLift.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2014-2018 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::liftModels::noLift
28 
29 Description
30 
31 SourceFiles
32  noLift.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef noLift_H
37 #define noLift_H
38 
39 #include "liftModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class phasePair;
47 
48 namespace liftModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class noLift Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class noLift
56 :
57  public liftModel
58 {
59 public:
60 
61  //- Runtime type information
62  TypeName("none");
63 
64 
65  // Constructors
66 
67  //- Construct from a dictionary and a phase pair
68  noLift
69  (
70  const dictionary& dict,
71  const phasePair& pair
72  );
73 
74 
75  //- Destructor
76  virtual ~noLift();
77 
78 
79  // Member Functions
80 
81  //- Lift coefficient
82  virtual tmp<volScalarField> Cl() const;
83 
84  //- Lift force
85  virtual tmp<volVectorField> F() const;
86 
87  //- Lift force on faces
88  virtual tmp<surfaceScalarField> Ff() const;
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace liftModels
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
Foam::phasePair
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:53
Foam::liftModels::noLift
Definition: noLift.H:54
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::liftModels::noLift::~noLift
virtual ~noLift()
Destructor.
Definition: noLift.C:58
Foam::liftModels::noLift::Cl
virtual tmp< volScalarField > Cl() const
Lift coefficient.
Definition: noLift.C:64
Foam::liftModels::noLift::noLift
noLift(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
Definition: noLift.C:47
Foam::liftModels::noLift::F
virtual tmp< volVectorField > F() const
Lift force.
Definition: noLift.C:77
Foam::liftModels::noLift::Ff
virtual tmp< surfaceScalarField > Ff() const
Lift force on faces.
Definition: noLift.C:90
Foam::liftModels::noLift::TypeName
TypeName("none")
Runtime type information.
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::liftModel
Definition: liftModel.H:55