fvmDiv.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) 2011-2018 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 InNamespace
25  Foam::fvm
26 
27 Description
28  Calculate the matrix for the divergence of the given field and flux.
29 
30 SourceFiles
31  fvmDiv.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef fvmDiv_H
36 #define fvmDiv_H
37 
38 #include "volFieldsFwd.H"
39 #include "surfaceFieldsFwd.H"
41 #include "fvMatrix.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Namespace fvm functions Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 namespace fvm
53 {
54  template<class Type>
55  tmp<fvMatrix<Type>> div
56  (
57  const surfaceScalarField&,
58  const GeometricField<Type, fvPatchField, volMesh>&,
59  const word& name
60  );
61 
62  template<class Type>
63  tmp<fvMatrix<Type>> div
64  (
65  const tmp<surfaceScalarField>&,
66  const GeometricField<Type, fvPatchField, volMesh>&,
67  const word& name
68  );
69 
70 
71  template<class Type>
72  tmp<fvMatrix<Type>> div
73  (
74  const surfaceScalarField&,
75  const GeometricField<Type, fvPatchField, volMesh>&
76  );
77 
78  template<class Type>
79  tmp<fvMatrix<Type>> div
80  (
81  const tmp<surfaceScalarField>&,
82  const GeometricField<Type, fvPatchField, volMesh>&
83  );
84 }
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace Foam
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #ifdef NoRepository
94  #include "fvmDiv.C"
95 #endif
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
tmp< fvMatrix< Type > > div(const surfaceScalarField &flux, const GeometricField< Type, fvPatchField, volMesh > &vf, const word &name)
Definition: fvmDiv.C:46
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
GeometricField< scalar, fvsPatchField, surfaceMesh > surfaceScalarField
Namespace for OpenFOAM.