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

IOobjectWriteHeader.C

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 Description
00025     Writes the header description of the File to the stream
00026     associated with the File.
00027 
00028 \*---------------------------------------------------------------------------*/
00029 
00030 #include <OpenFOAM/IOobject.H>
00031 
00032 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00033 
00034 bool Foam::IOobject::writeHeader(Ostream& os) const
00035 {
00036     if (!os.good())
00037     {
00038         Info<< "IOobject::writeHeader(Ostream&) : "
00039             << "no stream open for write" << nl
00040             << os.info() << endl;
00041 
00042         return false;
00043     }
00044 
00045     writeBanner(os)
00046         << "FoamFile\n{\n"
00047         << "    version     " << os.version() << ";\n"
00048         << "    format      " << os.format() << ";\n"
00049         << "    class       " << type() << ";\n";
00050 
00051     if (note().size())
00052     {
00053         os  << "    note        " << note() << ";\n";
00054     }
00055 
00056     os  << "    location    " << instance()/local() << ";\n"
00057         << "    object      " << name() << ";\n"
00058         << "}" << nl;
00059 
00060     writeDivider(os) << endl;
00061 
00062     return true;
00063 }
00064 
00065 
00066 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines