FreeFOAM The Cross-Platform CFD Toolkit
ReadFields.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) 1991-2010 OpenCFD Ltd.
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 Global
25  Foam::ReadFields
26 
27 Description
28  Helper routine to read fields
29 
30 SourceFiles
31  ReadFields.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef ReadFields_H
36 #define ReadFields_H
37 
38 #include <OpenFOAM/PtrList.H>
39 #include <OpenFOAM/wordList.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class IOobjectList;
47 
48 //- Helper routine to read fields
49 template<class GeoField, class Mesh>
51 (
52  const Mesh& mesh,
53  const IOobjectList& objects,
54  PtrList<GeoField>& fields,
55  const bool syncPar = true
56 );
57 
58 } // End namespace Foam
59 
60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
61 
62 #ifdef NoRepository
63 # include <OpenFOAM/ReadFields.C>
64 #endif
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 #endif
69 
70 // ************************ vim: set sw=4 sts=4 et: ************************ //