src/OpenFOAM/db/IOobject/IOobjectWriteHeader.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Description
  26     Writes the header description of the File to the stream
  27     associated with the File.
  28
  29 \*---------------------------------------------------------------------------*/
  30
  31 #include "IOobject.H"
  32
  33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  34
  35 bool Foam::IOobject::writeHeader(Ostream& os) const
  36 {
  37     if (!os.good())
  38     {
  39         Info<< "IOobject::writeHeader(Ostream&) : "
  40             << "no stream open for write" << nl
  41             << os.info() << endl;
  42
  43         return false;
  44     }
  45
  46     writeBanner(os)
  47         << "FoamFile\n{\n"
  48         << "    version     " << os.version() << ";\n"
  49         << "    format      " << os.format() << ";\n"
  50         << "    class       " << type() << ";\n";
  51
  52     if (note().size())
  53     {
  54         os  << "    note        " << note() << ";\n";
  55     }
  56
  57     os  << "    location    " << instance()/local() << ";\n"
  58         << "    object      " << name() << ";\n"
  59         << "}" << nl;
  60
  61     writeDivider(os) << endl;
  62
  63     return true;
  64 }
  65
  66
  67 // ************************************************************************* //