All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
fvcFlux.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-2020 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  //- Return the face-flux field obtained from the given volVectorField
54  tmp<surfaceScalarField> flux(const volVectorField& vvf);
55 
56  //- Return the face-flux field obtained from the given tmp volVectorField
57  tmp<surfaceScalarField> flux(const tmp<volVectorField>& tvvf);
58 
59  template<class Type>
60  tmp<GeometricField<Type, fvsPatchField, surfaceMesh>> flux
61  (
62  const surfaceScalarField&,
63  const tmp<GeometricField<Type, fvPatchField, volMesh>>&
64  );
65 
66  template<class Type>
67  tmp<GeometricField<Type, fvsPatchField, surfaceMesh>> flux
68  (
69  const surfaceScalarField&,
70  const GeometricField<Type, fvPatchField, volMesh>&,
71  Istream& schemeData
72  );
73 
74  template<class Type>
75  tmp<GeometricField<Type, fvsPatchField, surfaceMesh>> flux
76  (
77  const surfaceScalarField&,
78  const GeometricField<Type, fvPatchField, volMesh>&,
79  const word& name
80  );
81 
82  template<class Type>
83  tmp<GeometricField<Type, fvsPatchField, surfaceMesh>> flux
84  (
85  const tmp<surfaceScalarField>&,
86  const GeometricField<Type, fvPatchField, volMesh>&,
87  const word& name
88  );
89 
90  template<class Type>
91  tmp<GeometricField<Type, fvsPatchField, surfaceMesh>> flux
92  (
93  const surfaceScalarField&,
94  const tmp<GeometricField<Type, fvPatchField, volMesh>>&,
95  const word& name
96  );
97 
98  template<class Type>
99  tmp<GeometricField<Type, fvsPatchField, surfaceMesh>> flux
100  (
101  const tmp<surfaceScalarField>&,
102  const tmp<GeometricField<Type, fvPatchField, volMesh>>&,
103  const word& name
104  );
105 
106 
107  template<class Type>
108  tmp<GeometricField<Type, fvsPatchField, surfaceMesh>> flux
109  (
110  const surfaceScalarField&,
111  const GeometricField<Type, fvPatchField, volMesh>&
112  );
113 
114  template<class Type>
115  tmp<GeometricField<Type, fvsPatchField, surfaceMesh>> flux
116  (
117  const tmp<surfaceScalarField>&,
118  const GeometricField<Type, fvPatchField, volMesh>&
119  );
120 
121  template<class Type>
122  tmp<GeometricField<Type, fvsPatchField, surfaceMesh>> flux
123  (
124  const surfaceScalarField&,
125  const tmp<GeometricField<Type, fvPatchField, volMesh>>&
126  );
127 
128  template<class Type>
129  tmp<GeometricField<Type, fvsPatchField, surfaceMesh>> flux
130  (
131  const tmp<surfaceScalarField>&,
132  const tmp<GeometricField<Type, fvPatchField, volMesh>>&
133  );
134 }
135 
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 } // End namespace Foam
140 
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 
143 #ifdef NoRepository
144  #include "fvcFluxTemplates.C"
145 #endif
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 #endif
150 
151 // ************************************************************************* //
GeometricField< vector, fvPatchField, volMesh > volVectorField
Definition: volFieldsFwd.H:58
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
tmp< surfaceScalarField > flux(const volVectorField &vvf)
Return the face-flux field obtained from the given volVectorField.
Definition: fvcFlux.C:32
GeometricField< scalar, fvsPatchField, surfaceMesh > surfaceScalarField
Namespace for OpenFOAM.