src/OpenFOAM/db/functionObjects/IOOutputFilter/IOOutputFilter.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::IOOutputFilter
  27
  28 Description
  29     IOdictionary wrapper around OutputFilter to allow them to read from
  30     their associated dictionaries.
  31
  32 SourceFiles
  33     IOOutputFilter.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef IOOutputFilter_H
  38 #define IOOutputFilter_H
  39
  40 #include "IOdictionary.H"
  41 #include "pointFieldFwd.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Forward declaration of classes
  49 class mapPolyMesh;
  50
  51 /*---------------------------------------------------------------------------*\
  52                        Class IOOutputFilter Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 template<class OutputFilter>
  56 class IOOutputFilter
  57 :
  58     public IOdictionary,
  59     public OutputFilter
  60 {
  61     // Private Member Functions
  62
  63         // Disallow default bitwise copy construct and assignment
  64         IOOutputFilter(const IOOutputFilter&);
  65         void operator=(const IOOutputFilter&);
  66
  67
  68 public:
  69
  70     // Constructors
  71
  72         //- Construct for given objectRegistry and dictionary
  73         //  Allow dictionary to be optional
  74         //  Allow the possibility to load fields from files
  75         IOOutputFilter
  76         (
  77             const word& outputFilterName,
  78             const objectRegistry&,
  79             const fileName& dictName = OutputFilter::typeName() + "Dict",
  80             const IOobject::readOption rOpt = IOobject::MUST_READ,
  81             const bool loadFromFile = false
  82         );
  83
  84
  85     //- Destructor
  86     virtual ~IOOutputFilter();
  87
  88
  89     // Member Functions
  90
  91         //- Return name
  92         virtual const word& name() const
  93         {
  94             return IOdictionary::name();
  95         }
  96
  97         //- Read the probes
  98         virtual bool read();
  99
 100         //- Sample and write
 101         virtual void write();
 102
 103         //- Update for changes of mesh
 104         virtual void updateMesh(const mapPolyMesh& mpm)
 105         {
 106             read();
 107             OutputFilter::updateMesh(mpm);
 108         }
 109
 110         //- Update for changes of mesh
 111         virtual void movePoints(const pointField& points)
 112         {
 113             read();
 114             OutputFilter::movePoints(points);
 115         }
 116 };
 117
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 } // End namespace Foam
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 #ifdef NoRepository
 126 #   include "IOOutputFilter.C"
 127 #endif
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 #endif
 132
 133 // ************************************************************************* //