vtkSurfaceWriter.H 5.62 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
OpenFOAM bot's avatar
OpenFOAM bot committed
5
    \\  /    A nd           | www.openfoam.com
6 7
     \\/     M anipulation  |
-------------------------------------------------------------------------------
OpenFOAM bot's avatar
OpenFOAM bot committed
8
    Copyright (C) 2011 OpenFOAM Foundation
9
    Copyright (C) 2015-2020 OpenCFD Ltd.
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Class
    Foam::surfaceWriters::vtkWriter

Description
    A surfaceWriter for VTK legacy (.vtk) or XML (.vtp) format.

    The formatOptions for vtk:
    \table
        Property    | Description                           | Required | Default
        format      | ascii or binary format                | no  | binary
        legacy      | Legacy VTK output                     | no  | false
        precision   | Write precision in ascii         | no | same as IOstream
    \endtable

    For example,
    \verbatim
    formatOptions
    {
        vtk
        {
            format      binary;
            legacy      false;
            precision   10;
        }
    }
    \endverbatim

    \heading Output file locations

    The \c rootdir normally corresponds to something like
    \c postProcessing/\<name\>

    \subheading Geometry and Fields
    \verbatim
    rootdir
    `-- timeName
        `-- surfaceName.{vtk,vtp}
    \endverbatim

SourceFiles
    vtkSurfaceWriter.C

\*---------------------------------------------------------------------------*/

#ifndef vtkSurfaceWriter_H
#define vtkSurfaceWriter_H

#include "surfaceWriter.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

namespace vtk
{
83
// Forward Declarations
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
class outputOptions;
class surfaceWriter;
}

namespace surfaceWriters
{

/*---------------------------------------------------------------------------*\
                          Class vtkWriter Declaration
\*---------------------------------------------------------------------------*/

class vtkWriter
:
    public surfaceWriter
{
    // Private Data

        //- The VTK output format type.
        //  Stored as a raw value to avoid a header dependency on fileFormats
        unsigned fmtType_;

        //- ASCII write precision
        unsigned precision_;

        //- Backend writer - master only
        autoPtr<Foam::vtk::surfaceWriter> writer_;


    // Private Member Functions

        //- Templated write field operation
        template<class Type>
        fileName writeTemplate
        (
            const word& fieldName,          //!< Name of field
            const Field<Type>& localValues  //!< Local field values to write
        );


public:

125
    //- Declare type-name, virtual type (without debug switch)
126 127 128 129 130
    TypeNameNoDebug("vtk");


    // Constructors

131
        //- Default construct
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
        vtkWriter();

        //- Construct with some output options
        explicit vtkWriter(const vtk::outputOptions& opts);

        //- Construct with some output options
        explicit vtkWriter(const dictionary& options);

        //- Construct from components
        //  The file name is with/without an extension.
        vtkWriter
        (
            const meshedSurf& surf,
            const fileName& outputPath,
            bool parallel = Pstream::parRun(),
            const dictionary& options = dictionary()
        );

        //- Construct from components with specified output path.
        //  The file name is with/without an extension.
        vtkWriter
        (
            const pointField& points,
            const faceList& faces,
            const fileName& outputPath,
            bool parallel = Pstream::parRun(),
            const dictionary& options = dictionary()
        );


162
    //- Destructor. Calls close()
163
    virtual ~vtkWriter();
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204


    // Member Functions

        //- Finish output, clears backend.
        virtual void close(); // override

        //- Begin time step. Clears existing backend.
        virtual void beginTime(const Time& t); // override

        //- Begin time step. Clears existing backend.
        virtual void beginTime(const instant& inst); // override

        //- End time step. Clears existing backend.
        virtual void endTime(); // override


    // Write

        //- Write surface geometry to file.
        virtual fileName write(); // override

        declareSurfaceWriterWriteMethod(label);
        declareSurfaceWriterWriteMethod(scalar);
        declareSurfaceWriterWriteMethod(vector);
        declareSurfaceWriterWriteMethod(sphericalTensor);
        declareSurfaceWriterWriteMethod(symmTensor);
        declareSurfaceWriterWriteMethod(tensor);
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace surfaceWriters
} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //