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