initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / applications / utilities / postProcessing / dataConversion / foamToVTK / lagrangianWriter.H
blobbd13ec2571a7622d70e0c243098c8104348b48bb
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.
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.
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.
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
25 Class
26     Foam::lagrangianWriter
28 Description
29     Write fields (internal).
31 SourceFiles
32     lagrangianWriter.C
33     lagrangianWriterTemplates.C
35 \*---------------------------------------------------------------------------*/
37 #ifndef lagrangianWriter_H
38 #define lagrangianWriter_H
40 #include "globalPointPatch.H"
41 #include "OFstream.H"
42 #include "Cloud.H"
43 #include "volFields.H"
44 #include "pointFields.H"
45 #include "vtkMesh.H"
47 using namespace Foam;
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 namespace Foam
54 class volPointInterpolation;
56 /*---------------------------------------------------------------------------*\
57                            Class lagrangianWriter Declaration
58 \*---------------------------------------------------------------------------*/
60 class lagrangianWriter
62     const vtkMesh& vMesh_;
64     const bool binary_;
66     const fileName fName_;
68     const word cloudName_;
70     std::ofstream os_;
72     label nParcels_;
75 public:
77     // Constructors
79         //- Construct from components
80         lagrangianWriter
81         (
82             const vtkMesh&,
83             const bool binary,
84             const fileName&,
85             const word&
86         );
89     // Member Functions
91         std::ofstream& os()
92         {
93             return os_;
94         }
96         void writeParcelHeader(const label nFields);
98         //- Write IOField
99         template<class Type>
100         void writeIOField(const wordList&);
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 } // End namespace Foam
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 #ifdef NoRepository
111 #   include "lagrangianWriterTemplates.C"
112 #endif
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 #endif
119 // ************************************************************************* //