FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

jplotSetWriter.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::jplotSetWriter
00026 
00027 SourceFiles
00028     jplotSetWriter.C
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef jplotSetWriter_H
00033 #define jplotSetWriter_H
00034 
00035 #include <sampling/writer.H>
00036 #include <OpenFOAM/vector.H>
00037 
00038 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00039 
00040 namespace Foam
00041 {
00042 
00043 /*---------------------------------------------------------------------------*\
00044                       Class jplotSetWriter Declaration
00045 \*---------------------------------------------------------------------------*/
00046 
00047 template<class Type>
00048 class jplotSetWriter
00049 :
00050     public writer<Type>
00051 {
00052 
00053     // Private Member Functions
00054 
00055         //- Write header
00056         Ostream& writeHeader(Ostream&) const;
00057 
00058 public:
00059 
00060     //- Runtime type information
00061     TypeName("jplot");
00062 
00063 
00064     // Constructors
00065 
00066         //- Construct null
00067         jplotSetWriter();
00068 
00069 
00070     //- Destructor
00071     virtual ~jplotSetWriter();
00072 
00073 
00074     // Member Functions
00075 
00076         virtual fileName getFileName
00077         (
00078             const coordSet&,
00079             const wordList&
00080         ) const;
00081 
00082         virtual void write
00083         (
00084             const coordSet&,
00085             const wordList&,
00086             const List<const Field<Type>*>&,
00087             Ostream&
00088         ) const;
00089 
00090         virtual void write
00091         (
00092             const bool writeTracks,
00093             const PtrList<coordSet>&,
00094             const wordList& valueSetNames,
00095             const List<List<Field<Type> > >&,
00096             Ostream&
00097         ) const
00098         {
00099             notImplemented
00100             (
00101                 "jplotSetWriter<Type>::write\n"
00102                 "(\n"
00103                 "    const bool,\n"
00104                 "    const PtrList<coordSet>&,\n"
00105                 "    const wordList&,\n"
00106                 "    const List<List<Field<Type> > >&,\n"
00107                 "    Ostream&\n"
00108                 ") const"
00109             );
00110         }
00111 };
00112 
00113 
00114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00115 
00116 } // End namespace Foam
00117 
00118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00119 
00120 #ifdef NoRepository
00121 #   include "jplotSetWriter.C"
00122 #endif
00123 
00124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00125 
00126 #endif
00127 
00128 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines