fvmDiv.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) 2011-2022 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 "fvmDiv.H"
27 #include "fvMesh.H"
28 #include "fvMatrix.H"
29 #include "convectionScheme.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 
36 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
37 
38 namespace fvm
39 {
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 template<class Type>
44 tmp<fvMatrix<Type>>
45 div
46 (
47  const surfaceScalarField& flux,
49  const word& name
50 )
51 {
53  (
54  vf.mesh(),
55  flux,
56  vf.mesh().schemes().div(name)
57  )().fvmDiv(flux, vf);
58 }
59 
60 template<class Type>
62 div
63 (
64  const tmp<surfaceScalarField>& tflux,
66  const word& name
67 )
68 {
69  tmp<fvMatrix<Type>> Div(fvm::div(tflux(), vf, name));
70  tflux.clear();
71  return Div;
72 }
73 
74 
75 template<class Type>
77 div
78 (
79  const surfaceScalarField& flux,
81 )
82 {
83  return fvm::div(flux, vf, "div("+flux.name()+','+vf.name()+')');
84 }
85 
86 template<class Type>
88 div
89 (
90  const tmp<surfaceScalarField>& tflux,
92 )
93 {
94  tmp<fvMatrix<Type>> Div(fvm::div(tflux(), vf));
95  tflux.clear();
96  return Div;
97 }
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace fvm
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // ************************************************************************* //
const word & name() const
Return name.
Definition: IOobject.H:315
void clear() const
If object pointer points to valid object:
Definition: tmpI.H:237
Generic GeometricField class.
A class for handling words, derived from string.
Definition: word.H:59
tmp< fvMatrix< Type > > div(const surfaceScalarField &flux, const GeometricField< Type, fvPatchField, volMesh > &vf, const word &name)
Definition: fvmDiv.C:46
const Mesh & mesh() const
Return mesh.
Calculate the matrix for the divergence of the given field and flux.
static tmp< convectionScheme< Type > > New(const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
Return a pointer to a new convectionScheme created on freestore.
A class for managing temporary objects.
Definition: PtrList.H:53
tmp< surfaceScalarField > flux(const volVectorField &vvf)
Return the face-flux field obtained from the given volVectorField.
Definition: fvcFlux.C:32
Namespace for OpenFOAM.