src/OpenFOAM/db/IOobjects/IOField/IOField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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::IOField
  26
  27 Description
  28     A primitive field of type \<T\> with automated input and output.
  29
  30 SourceFiles
  31     IOField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef IOField_H
  36 #define IOField_H
  37
  38 #include "regIOobject.H"
  39 #include "Field.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class IOField Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class IOField
  52 :
  53     public regIOobject,
  54     public Field<Type>
  55 {
  56
  57 public:
  58
  59     TypeName("Field");
  60
  61
  62     // Constructors
  63
  64         //- Construct from IOobject
  65         IOField(const IOobject&);
  66
  67         //- Construct from IOobject and size (does not set values)
  68         IOField(const IOobject&, const label size);
  69
  70         //- Construct from components
  71         IOField(const IOobject&, const Field<Type>&);
  72
  73         //- Construct by transferring the Field contents
  74         IOField(const IOobject&, const Xfer<Field<Type> >&);
  75
  76
  77     //- Destructor
  78     virtual ~IOField();
  79
  80
  81     // Member functions
  82
  83         bool writeData(Ostream&) const;
  84
  85
  86     // Member operators
  87
  88         void operator=(const IOField<Type>&);
  89
  90         void operator=(const Field<Type>&);
  91 };
  92
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 } // End namespace Foam
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 #ifdef NoRepository
 101 #   include "IOField.C"
 102 #endif
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #endif
 107
 108 // ************************************************************************* //