surfaceFields.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-2024 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 InClass
25  Foam::surfaceFields
26 
27 Description
28  Foam::surfaceFields
29 
30 SourceFiles
31  surfaceFields.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef surfaceFields_H
36 #define surfaceFields_H
37 
38 #include "GeometricFields.H"
39 #include "surfaceMesh.H"
40 #include "fvMesh.H"
41 #include "fvsPatchFields.H"
42 #include "surfaceFieldsFwd.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 //- Check if surfaceField is a flux
51 // i.e. an extensive field oriented with the face requiring
52 // flipping after mapping.
53 // Currently it is assumed that only surfaceScalarFields can be fluxes
54 template<class Type>
56 {
57  return false;
58 }
59 
60 //- Check if surfaceScalarField is a flux
61 // i.e. an extensive field oriented with the face requiring
62 // flipping after mapping.
63 // Currently it is assumed that fluxes are either volumetric or mass
64 template<>
66 {
67  return
69  || df.dimensions() == dimMassFlux;
70 }
71 
72 //- Check if surfaceField is a face velocity or momentum
73 template<class Type>
75 {
76  return false;
77 }
78 
79 //- Check if surfaceVectorField is a face velocity or momentum
80 template<>
82 (
84 )
85 {
86  return
87  df.dimensions() == dimVelocity
89 }
90 
91 }
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 #endif
97 
98 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
const dimensionSet & dimensions() const
Return dimensions.
Namespace for OpenFOAM.
const dimensionSet dimMassFlux
const dimensionSet dimVolumetricFlux
bool isFaceVelocity(const DimensionedField< Type, surfaceMesh > &df)
Check if surfaceField is a face velocity or momentum.
Definition: surfaceFields.H:74
bool isFlux(const DimensionedField< Type, surfaceMesh > &df)
Check if surfaceField is a flux.
Definition: surfaceFields.H:55
bool isFlux< scalar >(const DimensionedField< scalar, surfaceMesh > &df)
Check if surfaceScalarField is a flux.
Definition: surfaceFields.H:65
const dimensionSet dimDensity
bool isFaceVelocity< vector >(const DimensionedField< vector, surfaceMesh > &df)
Check if surfaceVectorField is a face velocity or momentum.
Definition: surfaceFields.H:82
const dimensionSet dimVelocity