famDiv.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) 2016-2017 Wikki Ltd
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 InNamespace
27  Foam::fam
28 
29 Description
30  Calculate the matrix for the divergence of the given field and flux.
31 
32 SourceFiles
33  famDiv.C
34  vectorFamDiv.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef famDiv_H
39 #define famDiv_H
40 
41 #include "areaFieldsFwd.H"
42 #include "edgeFieldsFwd.H"
44 #include "faMatrix.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Namespace fam functions Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 namespace fam
56 {
57  template<class Type>
58  tmp<faMatrix<Type>> div
59  (
60  const edgeScalarField&,
61  const GeometricField<Type, faPatchField, areaMesh>&,
62  const word& name
63  );
64 
65  template<class Type>
66  tmp<faMatrix<Type>> div
67  (
68  const tmp<edgeScalarField>&,
69  const GeometricField<Type, faPatchField, areaMesh>&,
70  const word& name
71  );
72 
73  template<class Type>
74  tmp<faMatrix<Type>> div
75  (
76  const edgeScalarField&,
77  const GeometricField<Type, faPatchField, areaMesh>&
78  );
79 
80  template<class Type>
81  tmp<faMatrix<Type>> div
82  (
83  const tmp<edgeScalarField>&,
84  const GeometricField<Type, faPatchField, areaMesh>&
85  );
86 }
87 
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 // Template specialisation
96 #include "vectorFamDiv.H"
97 
98 #ifdef NoRepository
99  #include "famDiv.C"
100 #endif
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
edgeInterpolationScheme.H
vectorFamDiv.H
Specialisation of fam div for a flux.
areaFieldsFwd.H
Forwards and collection of common area field types.
faMatrix.H
Foam::edgeScalarField
GeometricField< scalar, faePatchField, edgeMesh > edgeScalarField
Definition: edgeFieldsFwd.H:52
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
famDiv.C
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
fam
Calculate the matrix for the second temporal derivative.
edgeFieldsFwd.H
Forwards for edge field types.
Foam::fam::div
tmp< faMatrix< Type > > div(const edgeScalarField &flux, const GeometricField< Type, faPatchField, areaMesh > &vf, const word &name)
Definition: famDiv.C:48