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