volFields.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 | Copyright (C) 2011 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::volFields
26 
27 Description
28 
29 SourceFiles
30  volFields.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef volFields_H
35 #define volFields_H
36 
37 #include "GeometricFields.H"
38 #include "volMesh.H"
39 #include "fvMesh.H"
40 #include "fvPatchField.H"
41 #include "volFieldsFwd.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 template<>
52 tmp<GeometricField<scalar, fvPatchField, volMesh> >
54 (
55  const direction
56 ) const;
57 
58 template<>
60 (
61  const direction,
62  const GeometricField<scalar, fvPatchField, volMesh>& sf
63 );
64 
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 } // End namespace Foam
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 #endif
73 
74 // ************************************************************************* //
unsigned char direction
Definition: direction.H:43
volScalarField sf(fieldObject, mesh)
Namespace for OpenFOAM.
tmp< GeometricField< cmptType, PatchField, GeoMesh > > component(const direction) const
Return a component of the field.
void replace(const direction, const GeometricField< cmptType, PatchField, GeoMesh > &)