src/sampling/sampledSet/writers/writer.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::writer
  26
  27 Description
  28     Base class for graphics format writing. Entry points are
  29     - write(..). \n
  30       Write to an Ostream a table of points with corresponding values.
  31     - write(scalar/vector/sphericalTensor/symmTensor/tensor). \n
  32       Write single scalar/vector/sphericalTensor/symmTensor/tensor.
  33       Default is to write space separated components.
  34
  35     Example:
  36     @verbatim
  37         // Construct writer of xmgr type
  38         autoPtr<writer<scalar> > scalarFormatter(writer<scalar>::New("xmgr"));
  39
  40         // Output list of points and corresponding values
  41         scalarFormatter().write
  42         (
  43             coordSet
  44             (
  45                 points,         // sample coordinates
  46                 "someLine",     // name of coordSet
  47                 "distance",     // write coordinates as distance to refPoint
  48                 points[0]       // reference point
  49             ),
  50             "U.component(0)",   // name of values
  51             vals                // values
  52         );
  53     @endverbatim
  54
  55 SourceFiles
  56     writer.C
  57
  58 \*---------------------------------------------------------------------------*/
  59
  60 #ifndef writer_H
  61 #define writer_H
  62
  63 #include "fileName.H"
  64 #include "wordList.H"
  65 #include "vector.H"
  66 #include "sphericalTensor.H"
  67 #include "diagTensor.H"
  68 #include "symmTensor.H"
  69 #include "tensor.H"
  70 #include "symmTensor4thOrder.H"
  71 #include "typeInfo.H"
  72 #include "runTimeSelectionTables.H"
  73 #include "autoPtr.H"
  74 #include "Field.H"
  75
  76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  77
  78 namespace Foam
  79 {
  80
  81 // Forward declaration of classes
  82 class coordSet;
  83
  84 /*---------------------------------------------------------------------------*\
  85                            Class writer Declaration
  86 \*---------------------------------------------------------------------------*/
  87
  88 template<class Type>
  89 class writer
  90 {
  91
  92 protected:
  93
  94     //- Generates filename from coordSet and sampled fields
  95     fileName getBaseName(const coordSet&, const wordList&) const;
  96
  97     void writeCoord(const coordSet&, const label sampleI, Ostream&) const;
  98
  99     //- Writes single-column ascii write. Column 1 is coordSet coordinate,
 100     //  columns 2 is the value. Uses write() function
 101     //  to write coordinate in correct format.
 102     void writeTable(const coordSet&, const List<Type>&, Ostream&) const;
 103
 104     //- Writes multi-column ascii write. Column 1 is coordSet coordinate,
 105     //  columns 2..n are the values. Uses write() function
 106     //  to write coordinate in correct format.
 107     void writeTable
 108     (
 109         const coordSet&,
 110         const List<const List<Type>*>&,
 111         Ostream& os
 112     ) const;
 113
 114
 115 public:
 116
 117     //- Runtime type information
 118     TypeName("writer");
 119
 120     // Declare run-time constructor selection table
 121
 122         declareRunTimeSelectionTable
 123         (
 124             autoPtr,
 125             writer,
 126             word,
 127             (),
 128             ()
 129         );
 130
 131
 132     // Selectors
 133
 134         //- Return a reference to the selected writer
 135         static autoPtr<writer> New(const word& writeFormat);
 136
 137
 138     // Constructors
 139
 140         //- Construct null
 141         writer();
 142
 143
 144     //- Destructor
 145     virtual ~writer() = 0;
 146
 147
 148     // Member Functions
 149
 150         //- Generate file name with correct extension
 151         virtual fileName getFileName
 152         (
 153             const coordSet&,
 154             const wordList&
 155         ) const = 0;
 156
 157         //- General entry point for writing.
 158         //  The data is organized in a set of point with one or more values
 159         //  per point
 160         virtual void write
 161         (
 162             const coordSet&,
 163             const wordList&,
 164             const List<const Field<Type>*>&,
 165             Ostream&
 166         ) const = 0;
 167
 168         //- General entry point for writing of multiple coordSets.
 169         //  Each coordSet (track) has same data variables.
 170         //  The data is per variable, per track, per point of track.
 171         //  If writeTracks adds connecting lines (wherever applicable)
 172         virtual void write
 173         (
 174             const bool writeTracks,
 175             const PtrList<coordSet>&,
 176             const wordList& valueSetNames,
 177             const List<List<Field<Type> > >&,
 178             Ostream&
 179         ) const = 0;
 180
 181         //- Write scalar as ascii
 182         virtual Ostream& write(const scalar, Ostream&) const;
 183
 184         template<class VSType>
 185         Ostream& writeVS(const VSType&, Ostream&) const;
 186
 187         //- Write vector. Tab separated ascii
 188         virtual Ostream& write(const vector&, Ostream&) const;
 189
 190         //- Write sphericalTensor. Tab separated ascii
 191         virtual Ostream& write(const sphericalTensor&, Ostream&) const;
 192
 193         //- Write diagTensor. Tab separated ascii
 194         virtual Ostream& write(const diagTensor&, Ostream&) const;
 195
 196         //- Write symmTensor. Tab separated ascii
 197         virtual Ostream& write(const symmTensor&, Ostream&) const;
 198
 199         //- Write tensor. Tab separated ascii
 200         virtual Ostream& write(const tensor&, Ostream&) const;
 201
 202         //- Write symmTensor4thOrder. Tab separated ascii
 203         virtual Ostream& write(const symmTensor4thOrder&, Ostream&) const;
 204
 205 };
 206
 207
 208 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 209
 210 } // End namespace Foam
 211
 212 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 213
 214 #ifdef NoRepository
 215 #   include "writer.C"
 216 #endif
 217
 218
 219 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 220
 221 #endif
 222
 223 // ************************************************************************* //