fvcFlux.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 | Copyright (C) 2011 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 face-flux of the given field.
29 
30 SourceFiles
31  fvcFlux.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 
36 #ifndef fvcFlux_H
37 #define fvcFlux_H
38 
39 #include "volFieldsFwd.H"
40 #include "surfaceFieldsFwd.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, fvsPatchField, surfaceMesh> > flux
55  (
56  const surfaceScalarField&,
57  const GeometricField<Type, fvPatchField, volMesh>&,
58  const word& name
59  );
60 
61  template<class Type>
62  tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
63  (
64  const tmp<surfaceScalarField>&,
65  const GeometricField<Type, fvPatchField, volMesh>&,
66  const word& name
67  );
68 
69  template<class Type>
70  tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
71  (
72  const surfaceScalarField&,
73  const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
74  const word& name
75  );
76 
77  template<class Type>
78  tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
79  (
80  const tmp<surfaceScalarField>&,
81  const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
82  const word& name
83  );
84 
85 
86  template<class Type>
87  tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
88  (
89  const surfaceScalarField&,
90  const GeometricField<Type, fvPatchField, volMesh>&
91  );
92 
93  template<class Type>
94  tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
95  (
96  const tmp<surfaceScalarField>&,
97  const GeometricField<Type, fvPatchField, volMesh>&
98  );
99 
100  template<class Type>
101  tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
102  (
103  const surfaceScalarField&,
104  const tmp<GeometricField<Type, fvPatchField, volMesh> >&
105  );
106 
107  template<class Type>
108  tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
109  (
110  const tmp<surfaceScalarField>&,
111  const tmp<GeometricField<Type, fvPatchField, volMesh> >&
112  );
113 }
114 
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #ifdef NoRepository
123 # include "fvcFlux.C"
124 #endif
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 #endif
129 
130 // ************************************************************************* //
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > flux(const surfaceScalarField &phi, const GeometricField< Type, fvPatchField, volMesh > &vf, const word &name)
Definition: fvcFlux.C:45
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
Namespace for OpenFOAM.
GeometricField< scalar, fvsPatchField, surfaceMesh > surfaceScalarField