FreeFOAM The Cross-Platform CFD Toolkit
surfaceInterpolateFields.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) 2010-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::surfaceInterpolateFields
26 
27 Description
28  Reads fields from the time folders and adds them to the mesh database
29  for further post-processing.
30 
31 SourceFiles
32  surfaceInterpolateFields.C
33  IOsurfaceInterpolateFields.H
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef surfaceInterpolateFields_H
38 #define surfaceInterpolateFields_H
39 
40 #include <OpenFOAM/OFstream.H>
41 //#include <OpenFOAM/pointFieldFwd.H>
43 #include <OpenFOAM/Tuple2.H>
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 // Forward declaration of classes
51 class objectRegistry;
52 class dictionary;
53 class mapPolyMesh;
54 
55 /*---------------------------------------------------------------------------*\
56  Class surfaceInterpolateFields Declaration
57 \*---------------------------------------------------------------------------*/
58 
60 {
61 protected:
62 
63  // Protected data
64 
65  //- Name of this set of surfaceInterpolateFields object
67 
69 
70  //- on/off switch
71  bool active_;
72 
73  //- Fields to process
74  //wordList fieldSet_;
76 
77  //- Locally constructed fields
83 
84 
85  // Protected Member Functions
86 
87  //- Disallow default bitwise copy construct
89 
90  //- Disallow default bitwise assignment
92 
93  template<class Type>
95  (
97  ) const;
98 
99 
100 public:
101 
102  //- Runtime type information
103  TypeName("surfaceInterpolateFields");
104 
105 
106  // Constructors
107 
108  //- Construct for given objectRegistry and dictionary.
109  // Allow the possibility to load fields from files
111  (
112  const word& name,
113  const objectRegistry&,
114  const dictionary&,
115  const bool loadFromFiles = false
116  );
117 
118 
119  //- Destructor
120  virtual ~surfaceInterpolateFields();
121 
122 
123  // Member Functions
124 
125  //- Return name of the surfaceInterpolateFields object
126  virtual const word& name() const
127  {
128  return name_;
129  }
130 
131  //- Read the field min/max data
132  virtual void read(const dictionary&);
133 
134  //- Execute, currently does nothing
135  virtual void execute();
136 
137  //- Execute at the final time-loop, currently does nothing
138  virtual void end();
139 
140  //- Write
141  virtual void write();
142 
143  //- Update for changes of mesh
144  virtual void updateMesh(const mapPolyMesh&)
145  {}
146 
147  //- Update for changes of mesh
148  virtual void movePoints(const pointField&)
149  {}
150 };
151 
152 
153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 
155 } // End namespace Foam
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
159 #ifdef NoRepository
161 #endif
162 
163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
164 
165 #endif
166 
167 // ************************ vim: set sw=4 sts=4 et: ************************ //