famNDiv.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 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef famNDiv_H
38 #define famNDiv_H
39 
40 #include "areaFieldsFwd.H"
41 #include "edgeFieldsFwd.H"
43 #include "faMatrix.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Namespace fam functions Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 namespace fam
55 {
56  template<class Type>
57  tmp<faMatrix<Type>> ndiv
58  (
59  const edgeScalarField&,
60  GeometricField<Type, faPatchField, areaMesh>&,
61  const word& name
62  );
63 
64  template<class Type>
65  tmp<faMatrix<Type>> ndiv
66  (
67  const tmp<edgeScalarField>&,
68  GeometricField<Type, faPatchField, areaMesh>&,
69  const word& name
70  );
71 
72  template<class Type>
73  tmp<faMatrix<Type>> ndiv
74  (
75  const edgeScalarField&,
76  GeometricField<Type, faPatchField, areaMesh>&
77  );
78 
79  template<class Type>
80  tmp<faMatrix<Type>> ndiv
81  (
82  const tmp<edgeScalarField>&,
83  GeometricField<Type, faPatchField, areaMesh>&
84  );
85 }
86 
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 } // End namespace Foam
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 #ifdef NoRepository
95  #include "famNDiv.C"
96 #endif
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
edgeInterpolationScheme.H
famNDiv.C
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
Foam::fam::ndiv
tmp< faMatrix< Type > > ndiv(const edgeScalarField &flux, GeometricField< Type, faPatchField, areaMesh > &vf, const word &name)
Definition: famNDiv.C:48
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.