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