src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.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::writeRegisteredObject
  27
  28 Description
  29     Takes over the writing of registered IO objects
  30
  31 SourceFiles
  32     writeRegisteredObject.C
  33     IOwriteRegisteredObject.H
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef writeRegisteredObject_H
  38 #define writeRegisteredObject_H
  39
  40 #include "pointFieldFwd.H"
  41 #include "wordList.H"
  42 #include "runTimeSelectionTables.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // Forward declaration of classes
  50 class objectRegistry;
  51 class dictionary;
  52 class mapPolyMesh;
  53
  54 /*---------------------------------------------------------------------------*\
  55                    Class writeRegisteredObject Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 class writeRegisteredObject
  59 {
  60 protected:
  61
  62     // Private data
  63
  64         //- Name of this set of writeRegisteredObject
  65         word name_;
  66
  67         const objectRegistry& obr_;
  68
  69         //- On/off switch
  70         bool active_;
  71
  72
  73         // Read from dictionary
  74
  75             //- Names of objects to control
  76             wordList objectNames_;
  77
  78
  79     // Private Member Functions
  80
  81
  82         //- Disallow default bitwise copy construct
  83         writeRegisteredObject(const writeRegisteredObject&);
  84
  85         //- Disallow default bitwise assignment
  86         void operator=(const writeRegisteredObject&);
  87
  88
  89 public:
  90
  91     //- Runtime type information
  92     TypeName("writeRegisteredObject");
  93
  94
  95     // Constructors
  96
  97         //- Construct for given objectRegistry and dictionary.
  98         //  Allow the possibility to load fields from files
  99         writeRegisteredObject
 100         (
 101             const word& name,
 102             const objectRegistry&,
 103             const dictionary&,
 104             const bool loadFromFiles = false
 105         );
 106
 107
 108     //- Destructor
 109     virtual ~writeRegisteredObject();
 110
 111
 112     // Member Functions
 113
 114         //- Return name of the writeRegisteredObject
 115         virtual const word& name() const
 116         {
 117             return name_;
 118         }
 119
 120         //- Read the writeRegisteredObject data
 121         virtual void read(const dictionary&);
 122
 123         //- Execute, currently does nothing
 124         virtual void execute();
 125
 126         //- Execute at the final time-loop, currently does nothing
 127         virtual void end();
 128
 129         //- Write the writeRegisteredObject
 130         virtual void write();
 131
 132         //- Update for changes of mesh
 133         virtual void updateMesh(const mapPolyMesh&)
 134         {}
 135
 136         //- Update for changes of mesh
 137         virtual void movePoints(const pointField&)
 138         {}
 139 };
 140
 141
 142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 143
 144 } // End namespace Foam
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 #endif
 149
 150 // ************************************************************************* //