The open source CFD toolbox
fvcFlux.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9-------------------------------------------------------------------------------
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26\*---------------------------------------------------------------------------*/
27
28#include "fvcFlux.H"
29#include "surfaceInterpolate.H"
30
31// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32
34(
35 const volVectorField& vvf
36)
37{
38 return scheme<vector>
39 (
40 vvf.mesh(),
41 "flux(" + vvf.name() + ')'
42 )().dotInterpolate(vvf.mesh().Sf(), vvf);
43}
44
45
47(
48 const tmp<volVectorField>& tvvf
49)
50{
51 tmp<surfaceScalarField> Flux(fvc::flux(tvvf()));
52 tvvf.clear();
53 return Flux;
54}
55
56
57// ************************************************************************* //
const Mesh & mesh() const
Return mesh.
const word & name() const noexcept
Return the object name.
Definition: IOobjectI.H:65
A class for managing temporary objects.
Definition: tmp.H:65
void clear() const noexcept
Definition: tmpI.H:287
Calculate the face-flux of the given field.
tmp< surfaceScalarField > flux(const volVectorField &vvf)
Return the face-flux field obtained from the given volVectorField.
Definition: fvcFlux.C:34