wallDampedLift.C
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) 2015-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 \*---------------------------------------------------------------------------*/
27 
28 #include "wallDampedLift.H"
29 #include "phasePair.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace liftModels
37 {
38  defineTypeNameAndDebug(wallDamped, 0);
39  addToRunTimeSelectionTable(liftModel, wallDamped, dictionary);
40 }
41 }
42 
43 
44 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
45 
47 (
48  const dictionary& dict,
49  const phasePair& pair
50 )
51 :
52  liftModel(dict, pair),
53  liftModel_(liftModel::New(dict.subDict("lift"), pair)),
54  wallDampingModel_
55  (
56  wallDampingModel::New(dict.subDict("wallDamping"), pair)
57  )
58 {}
59 
60 
61 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
62 
64 {}
65 
66 
67 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
68 
70 {
71  return wallDampingModel_->damp(liftModel_->Cl());
72 }
73 
74 
76 {
77  return wallDampingModel_->damp(liftModel_->Fi());
78 }
79 
80 
82 {
83  return wallDampingModel_->damp(liftModel_->F());
84 }
85 
86 
88 {
89  return wallDampingModel_->damp(liftModel_->Ff());
90 }
91 
92 
93 // ************************************************************************* //
Foam::liftModels::wallDamped::Cl
virtual tmp< volScalarField > Cl() const
Return lift coefficient.
Definition: wallDampedLift.C:69
Foam::phasePair
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:51
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::liftModels::wallDamped::Ff
virtual tmp< surfaceScalarField > Ff() const
Return face lift force.
Definition: wallDampedLift.C:87
wallDampedLift.H
Foam::liftModels::defineTypeNameAndDebug
defineTypeNameAndDebug(constantLiftCoefficient, 0)
Foam::liftModels::wallDamped::wallDamped
wallDamped(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
Definition: wallDampedLift.C:47
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::liftModels::wallDamped::F
virtual tmp< volVectorField > F() const
Return lift force.
Definition: wallDampedLift.C:81
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::New
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
Global function forwards to reuseTmpDimensionedField::New.
Definition: DimensionedFieldReuseFunctions.H:105
Foam::liftModels::addToRunTimeSelectionTable
addToRunTimeSelectionTable(liftModel, constantLiftCoefficient, dictionary)
Foam::liftModel
Definition: liftModel.H:54
Foam::liftModels::wallDamped::~wallDamped
virtual ~wallDamped()
Destructor.
Definition: wallDampedLift.C:63
Foam::liftModels::wallDamped::Fi
virtual tmp< volVectorField > Fi() const
Return phase-intensive lift force.
Definition: wallDampedLift.C:75