src/foam/db/IOobject/IOobjectWriteHeader.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Description
  25     Writes the header description of the File to the stream
  26     associated with the File.
  27
  28 \*---------------------------------------------------------------------------*/
  29
  30 #include "IOobject.H"
  31
  32 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  33
  34 bool Foam::IOobject::writeHeader(Ostream& os) const
  35 {
  36     if (!os.good())
  37     {
  38         Info<< "IOobject::writeHeader(Ostream&) : "
  39             << "no stream open for write" << nl
  40             << os.info() << endl;
  41
  42         return false;
  43     }
  44
  45     writeBanner(os)
  46         << "FoamFile\n{\n"
  47         << "    version     " << os.version() << ";\n"
  48         << "    format      " << os.format() << ";\n"
  49         << "    class       " << type() << ";\n";
  50
  51     if (note().size())
  52     {
  53         os  << "    note        " << note() << ";\n";
  54     }
  55
  56     os  << "    location    " << instance()/local() << ";\n"
  57         << "    object      " << name() << ";\n"
  58         << "}" << nl;
  59
  60     writeDivider(os) << endl;
  61
  62     return true;
  63 }
  64
  65
  66 // ************************************************************************* //