applications/utilities/miscellaneous/foamFormatConvert/fieldDictionary.H

   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 Class
  26     Foam::fieldDictionary
  27
  28 Description
  29     Read field as dictionary (without mesh).
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef fieldDictionary_H
  34 #define fieldDictionary_H
  35
  36 #include "regIOobject.H"
  37 #include "dictionary.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class fieldDictionary Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class fieldDictionary
  50 :
  51     public regIOobject,
  52     public dictionary
  53 {
  54     const word type_;
  55
  56 public:
  57
  58     // Redefine type name to be of the instantiated type
  59     virtual const word& type() const
  60     {
  61         return type_;
  62     }
  63
  64
  65     // Constructors
  66
  67         //- Construct from ioobject and overloaded typename.
  68         explicit fieldDictionary(const IOobject& io, const word& type)
  69         :
  70             regIOobject(io),
  71             dictionary(readStream(type)),
  72             type_(type)
  73         {
  74             close();
  75         }
  76
  77
  78
  79     // Member functions
  80
  81         bool writeData(Ostream& os) const
  82         {
  83             static_cast<const dictionary&>(*this).write(os, false);
  84
  85             return os.good();
  86         }
  87 };
  88
  89
  90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  91
  92 } // End namespace Foam
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 #endif
  97
  98 // ************************************************************************* //