ensightOutputSurface.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2020 OpenCFD Ltd.
-------------------------------------------------------------------------------
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::ensightOutputSurface
 
Description
    A variant of ensightFaces that holds references to contiguous
    points/faces with its own encapsulated write methods.
    The surface is assumed to have been merged prior, thus the output is
    serial-only.
 
Note
    The primary use is for the Foam::surfaceWriters::ensightWriter
    but can be used independently as well.
 
SourceFiles
    ensightOutputSurface.C
    ensightOutputSurfaceTemplates.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef ensightOutputSurface_H
#define ensightOutputSurface_H
 
#include "ensightFaces.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                    Class ensightOutputSurface Declaration
\*---------------------------------------------------------------------------*/
 
class ensightOutputSurface
:
    public ensightFaces
{
    // Private Data
 
        //- The referenced pointField
        const pointField& points_;
 
        //- The referenced faces
        const faceList& faces_;
 
 
    // Private Member Functions
 
        //- No copy construct
        ensightOutputSurface(const ensightOutputSurface&) = delete;
 
        //- No copy assignment
        void operator=(const ensightOutputSurface&) = delete;
 
 
public:
 
    // Constructors
 
        //- Construct from points and faces.
        //- Part receives the specified name (default: "surface").
        ensightOutputSurface
        (
            const pointField& points,
            const faceList& faces,
            const string& description = "surface"
        );
 
 
    //- Destructor
    virtual ~ensightOutputSurface() = default;
 
 
    // Member Functions
 
        //- Write processor-local geometry (serial-only)
        void write(ensightGeoFile& os) const;
 
        //- Write a field of face or point values (serial-only)
        template<class Type>
        void writeData
        (
            ensightFile& os,
            const Field<Type>& fld,
            const bool isPointData = false
        ) const;
 
        //- Write a field of face values (serial-only)
        template<class Type>
        void writeFaceData(ensightFile& os, const Field<Type>& fld) const;
 
        //- Write a field of point values (serial-only)
        template<class Type>
        void writePointData(ensightFile& os, const Field<Type>& fld) const;
 
 
    // Housekeeping
 
        //- Cannot write geometry with a mesh reference
        virtual void write(ensightGeoFile&, const polyMesh&, bool) const
        {}
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "ensightOutputSurfaceTemplates.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //