verticalDamping.C
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) 2017-2019 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 \*---------------------------------------------------------------------------*/
25 
26 #include "verticalDamping.H"
27 #include "fvMatrix.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace fv
36 {
37  defineTypeNameAndDebug(verticalDamping, 0);
38  addToRunTimeSelectionTable(option, verticalDamping, dictionary);
39 }
40 }
41 
42 
43 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
44 
45 void Foam::fv::verticalDamping::add
46 (
47  const volVectorField& alphaRhoU,
48  fvMatrix<vector>& eqn
49 )
50 {
52  mesh_.lookupObject<uniformDimensionedVectorField>("g");
53 
54  const dimensionedSymmTensor gg(sqr(g)/magSqr(g));
55 
56  eqn -= forceCoeff()*(gg & alphaRhoU());
57 }
58 
59 
60 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
61 
63 (
64  const word& name,
65  const word& modelType,
66  const dictionary& dict,
67  const fvMesh& mesh
68 )
69 :
70  damping(name, modelType, dict, mesh)
71 {
72  read(dict);
73 }
74 
75 
76 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
77 
79 (
80  fvMatrix<vector>& eqn,
81  const label fieldi
82 )
83 {
84  add(eqn.psi(), eqn);
85 }
86 
87 
89 (
90  const volScalarField& rho,
91  fvMatrix<vector>& eqn,
92  const label fieldi
93 )
94 {
95  add(rho*eqn.psi(), eqn);
96 }
97 
98 
100 (
101  const volScalarField& alpha,
102  const volScalarField& rho,
103  fvMatrix<vector>& eqn,
104  const label fieldi
105 )
106 {
107  add(alpha*rho*eqn.psi(), eqn);
108 }
109 
110 
111 // ************************************************************************* //
defineTypeNameAndDebug(option, 0)
virtual void addSup(fvMatrix< vector > &eqn, const label fieldi)
Source term to momentum equation.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
UniformDimensionedField< vector > uniformDimensionedVectorField
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
const GeometricField< Type, fvPatchField, volMesh > & psi() const
Definition: fvMatrix.H:282
dimensionedSymmTensor sqr(const dimensionedVector &dv)
addToRunTimeSelectionTable(option, fixedTemperatureConstraint, dictionary)
GeometricField< vector, fvPatchField, volMesh > volVectorField
Definition: volFieldsFwd.H:55
Macros for easy insertion into run-time selection tables.
bool read(const char *, int32_t &)
Definition: int32IO.C:85
A class for handling words, derived from string.
Definition: word.H:59
labelList fv(nPoints)
A special matrix type and solver, designed for finite volume solutions of scalar equations. Face addressing is used to make all matrix assembly and solution loops vectorise.
Definition: fvPatchField.H:72
dimensioned< scalar > magSqr(const dimensioned< Type > &)
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
dimensioned< symmTensor > dimensionedSymmTensor
Dimensioned tensor obtained from generic dimensioned type.
verticalDamping(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
Construct from components.
Base fvOption for damping functions.
Definition: damping.H:56
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Namespace for OpenFOAM.