fvcCurl.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) 2011-2016 OpenFOAM Foundation
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::fvc
28 
29 Description
30  Calculate the curl of the given volField by constructing the Hodge-dual of
31  the symmetric part of the gradient.
32 
33 SourceFiles
34  fvcCurl.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 
39 #ifndef fvcCurl_H
40 #define fvcCurl_H
41 
42 #include "volFieldsFwd.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Namespace fvc functions Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 namespace fvc
54 {
55  template<class Type>
56  tmp<GeometricField<Type, fvPatchField, volMesh>> curl
57  (
58  const GeometricField<Type, fvPatchField, volMesh>&
59  );
60 
61  template<class Type>
62  tmp<GeometricField<Type, fvPatchField, volMesh>> curl
63  (
64  const tmp<GeometricField<Type, fvPatchField, volMesh>>&
65  );
66 }
67 
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 } // End namespace Foam
72 
73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74 
75 #ifdef NoRepository
76  #include "fvcCurl.C"
77 #endif
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 #endif
82 
83 // ************************************************************************* //
volFieldsFwd.H
Foam::fvc::curl
tmp< GeometricField< Type, fvPatchField, volMesh > > curl(const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcCurl.C:47
fvcCurl.C
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33