areaFields.H
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-2017 Wikki 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 Class
27  Foam::areaFields
28 
29 Description
30  Finite area area (element) fields
31 
32 Author
33  Zeljko Tukovic, FMENA
34  Hrvoje Jasak, Wikki Ltd.
35 
36 SourceFiles
37  areaFields.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef Foam_areaFields_H
42 #define Foam_areaFields_H
43 
44 #include "objectRegistry.H"
45 #include "GeometricFields.H"
46 #include "areaFaMesh.H"
47 #include "faMesh.H"
48 #include "faPatchFields.H"
49 #include "areaFieldsFwd.H"
50 
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 
53 namespace Foam
54 {
55 
56 // Specializations
57 
58 template<>
59 tmp<GeometricField<scalar, faPatchField, areaMesh>>
61 (
62  const direction
63 ) const;
64 
65 template<>
67 (
68  const direction,
69  const GeometricField<scalar, faPatchField, areaMesh>& sf
70 );
71 
72 
73 // Local consistency checks
74 //
75 // template<class Type>
76 // bool GeometricBoundaryField<Type, faPatchField, areaMesh>::check() const
77 // {
78 // return checkConsistency<coupledFaPatchField<Type>>
79 // (
80 // FieldBase::localBoundaryTolerance_,
81 // !(debug&4) // make into warning if debug&4
82 // );
83 // }
84 
85 template<>
87 check() const;
88 
89 template<>
91 check() const;
92 
93 template<>
95 check() const;
96 
97 template<>
99 check() const;
100 
101 template<>
103 check() const;
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
uint8_t direction
Definition: direction.H:46
tmp< GeometricField< cmptType, PatchField, GeoMesh > > component(const direction) const
Return a component of the field.
The standard GeometricField types.
Declarations for faPatchField types.
bool check() const
Helper: check if field has been evaluated. See instantiations.
Forwards and collection of common area field types.
Namespace for OpenFOAM.
void replace(const direction d, const GeometricField< cmptType, PatchField, GeoMesh > &gcf)
Replace specified field component with content from another field.