fluxTemplates.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) 2016-2019 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
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 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
32 
33 template<class FieldType, class RhoFieldType>
34 bool Foam::functionObjects::flux::calcVolFlux(const RhoFieldType& rho)
35 {
36  if (foundObject<FieldType>(fieldName_, false))
37  {
38  return store
39  (
41  fvc::flux(rho*lookupObject<FieldType>(fieldName_))
42  );
43  }
44 
45  return false;
46 }
47 
48 
49 template<class FieldType, class RhoFieldType>
50 bool Foam::functionObjects::flux::calcSurFlux(const RhoFieldType& rho)
51 {
52  if (foundObject<FieldType>(fieldName_, false))
53  {
54  return store
55  (
56  resultName_,
57  (
59  *lookupObject<FieldType>(fieldName_)
60  ) & mesh_.Sf()
61  );
62  }
63 
64  return false;
65 }
66 
67 
68 // ************************************************************************* //
Foam::fvc::flux
tmp< surfaceScalarField > flux(const volVectorField &vvf)
Return the face-flux field obtained from the given volVectorField.
Foam::functionObjects::regionFunctionObject::store
bool store(word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
Store the field in the (sub) objectRegistry under the given name.
Definition: regionFunctionObjectTemplates.C:107
rho
rho
Definition: readInitialConditions.H:88
Foam::functionObjects::fieldExpression::fieldName_
word fieldName_
Name of field to process.
Definition: fieldExpression.H:129
Foam::fvc::interpolate
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate(const GeometricField< Type, fvPatchField, volMesh > &tvf, const surfaceScalarField &faceFlux, Istream &schemeData)
Interpolate field onto faces using scheme given by Istream.
fvcFlux.H
Calculate the face-flux of the given field.
Foam::functionObjects::fieldExpression::resultName_
word resultName_
Name of result field.
Definition: fieldExpression.H:132