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