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-2023 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  fvcFluxTemplates.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  template<class Type>
55  tmp<SurfaceField<typename innerProduct<vector, Type>::type>> flux
56  (
57  const VolField<Type>& vf
58  );
59 
60  //- Return the face-flux field obtained from the given tmp volVectorField
61  template<class Type>
62  tmp<SurfaceField<typename innerProduct<vector, Type>::type>> flux
63  (
64  const tmp<VolField<Type>>& tvf
65  );
66 
67  template<class Type>
68  tmp<SurfaceField<Type>> flux
69  (
70  const surfaceScalarField&,
71  const tmp<VolField<Type>>&
72  );
73 
74  template<class Type>
75  tmp<SurfaceField<Type>> flux
76  (
77  const surfaceScalarField&,
78  const VolField<Type>&,
79  Istream& schemeData
80  );
81 
82  template<class Type>
83  tmp<SurfaceField<Type>> flux
84  (
85  const surfaceScalarField&,
86  const VolField<Type>&,
87  const word& name
88  );
89 
90  template<class Type>
91  tmp<SurfaceField<Type>> flux
92  (
93  const tmp<surfaceScalarField>&,
94  const VolField<Type>&,
95  const word& name
96  );
97 
98  template<class Type>
99  tmp<SurfaceField<Type>> flux
100  (
101  const surfaceScalarField&,
102  const tmp<VolField<Type>>&,
103  const word& name
104  );
105 
106  template<class Type>
107  tmp<SurfaceField<Type>> flux
108  (
109  const tmp<surfaceScalarField>&,
110  const tmp<VolField<Type>>&,
111  const word& name
112  );
113 
114 
115  template<class Type>
116  tmp<SurfaceField<Type>> flux
117  (
118  const surfaceScalarField&,
119  const VolField<Type>&
120  );
121 
122  template<class Type>
123  tmp<SurfaceField<Type>> flux
124  (
125  const tmp<surfaceScalarField>&,
126  const VolField<Type>&
127  );
128 
129  template<class Type>
130  tmp<SurfaceField<Type>> flux
131  (
132  const surfaceScalarField&,
133  const tmp<VolField<Type>>&
134  );
135 
136  template<class Type>
137  tmp<SurfaceField<Type>> flux
138  (
139  const tmp<surfaceScalarField>&,
140  const tmp<VolField<Type>>&
141  );
142 }
143 
144 
145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146 
147 } // End namespace Foam
148 
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150 
151 #ifdef NoRepository
152  #include "fvcFluxTemplates.C"
153 #endif
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 #endif
158 
159 // ************************************************************************* //
tmp< SurfaceField< typename innerProduct< vector, Type >::type > > flux(const VolField< Type > &vf)
Return the face-flux field obtained from the given volVectorField.
Namespace for OpenFOAM.
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
SurfaceField< scalar > surfaceScalarField