FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

ReadFields.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Global
00025     Foam::ReadFields
00026 
00027 Description
00028     Helper routine to read fields
00029 
00030 SourceFiles
00031     ReadFields.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef ReadFields_H
00036 #define ReadFields_H
00037 
00038 #include <OpenFOAM/PtrList.H>
00039 #include <OpenFOAM/wordList.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 class IOobjectList;
00047 
00048 //- Helper routine to read fields
00049 template<class GeoField, class Mesh>
00050 wordList ReadFields
00051 (
00052     const Mesh& mesh,
00053     const IOobjectList& objects,
00054     PtrList<GeoField>& fields,
00055     const bool syncPar = true
00056 );
00057 
00058 } // End namespace Foam
00059 
00060 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00061 
00062 #ifdef NoRepository
00063 #   include <OpenFOAM/ReadFields.C>
00064 #endif
00065 
00066 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00067 
00068 #endif
00069 
00070 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines