surfaceToVolVelocity.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) 2022 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
26 
27 Description
28  Return the vol-field velocity corresponding to a given surface-field
29  velocity
30 
31 SourceFiles
32  surfaceToVolVelocity.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef surfaceToVolVelocity_H
37 #define surfaceToVolVelocity_H
38 
39 #include "surfaceFields.H"
40 #include "volFields.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 // * * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * //
48 
49 //- Get the cell velocity field corresponding to a given face velocity, or a
50 // null reference if no corresponding field exists
51 const volVectorField& surfaceToVolVelocity(const surfaceVectorField& Uf);
52 
53 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
54 
55 } // End namespace Foam
56 
57 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
58 
59 #endif
60 
61 // ************************************************************************* //
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.H:214
Foam::volVectorField
VolField< vector > volVectorField
Definition: volFieldsFwd.H:62
Foam::surfaceVectorField
SurfaceField< vector > surfaceVectorField
Definition: surfaceFieldsFwd.H:59
Foam::surfaceToVolVelocity
const volVectorField & surfaceToVolVelocity(const surfaceVectorField &Uf)
Get the cell velocity field corresponding to a given face velocity, or a.
Definition: surfaceToVolVelocity.C:31
surfaceFields.H
Foam::surfaceFields.