src/OpenFOAM/db/IOobjects/CompactIOField/CompactIOField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2010-2011 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::CompactIOField
  26
  27 Description
  28     A Field of objects of type \<T\> with automated input and output using
  29     a compact storage. Behaves like IOField except when binary output in
  30     case it writes a CompactListList.
  31
  32     Useful for fields of small subfields e.g. in lagrangian
  33
  34 SourceFiles
  35     CompactIOField.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef CompactIOField_H
  40 #define CompactIOField_H
  41
  42 #include "IOField.H"
  43 #include "regIOobject.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 // Forward declaration of friend functions and operators
  51 template<class T, class BaseType> class CompactIOField;
  52
  53 template<class T, class BaseType> Istream& operator>>
  54 (
  55     Istream&,
  56     CompactIOField<T, BaseType>&
  57 );
  58
  59 template<class T, class BaseType> Ostream& operator<<
  60 (
  61     Ostream&,
  62     const CompactIOField<T, BaseType>&
  63 );
  64
  65 /*---------------------------------------------------------------------------*\
  66                         Class CompactIOField Declaration
  67 \*---------------------------------------------------------------------------*/
  68
  69 template<class T, class BaseType>
  70 class CompactIOField
  71 :
  72     public regIOobject,
  73     public Field<T>
  74 {
  75     // Private Member Functions
  76
  77         //- Read according to header type
  78         void readFromStream();
  79
  80 public:
  81
  82     //- Runtime type information
  83     TypeName("FieldField");
  84
  85
  86     // Constructors
  87
  88         //- Construct from IOobject
  89         CompactIOField(const IOobject&);
  90
  91         //- Construct from IOobject and size
  92         CompactIOField(const IOobject&, const label);
  93
  94         //- Construct from IOobject and a Field
  95         CompactIOField(const IOobject&, const Field<T>&);
  96
  97         //- Construct by transferring the Field contents
  98         CompactIOField(const IOobject&, const Xfer<Field<T> >&);
  99
 100
 101     // Destructor
 102
 103         virtual ~CompactIOField();
 104
 105
 106     // Member functions
 107
 108         virtual bool writeObject
 109         (
 110             IOstream::streamFormat,
 111             IOstream::versionNumber,
 112             IOstream::compressionType
 113         ) const;
 114
 115         virtual bool writeData(Ostream&) const;
 116
 117
 118     // Member operators
 119
 120         void operator=(const CompactIOField<T, BaseType>&);
 121
 122         void operator=(const Field<T>&);
 123 };
 124
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 } // End namespace Foam
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #ifdef NoRepository
 133 #   include "CompactIOField.C"
 134 #endif
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 #endif
 139
 140 // ************************************************************************* //