MeshedSurfaceProxy.H 6.86 KB
Newer Older
Mark Olesen's avatar
Mark Olesen committed
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
OpenFOAM bot's avatar
OpenFOAM bot committed
6 7
     \\/     M anipulation  |
-------------------------------------------------------------------------------
OpenFOAM bot's avatar
OpenFOAM bot committed
8
    Copyright (C) 2011-2016 OpenFOAM Foundation
9
    Copyright (C) 2016-2020 OpenCFD Ltd.
Mark Olesen's avatar
Mark Olesen committed
10 11 12 13
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

14 15 16 17
    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.
Mark Olesen's avatar
Mark Olesen committed
18 19 20 21 22 23 24

    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
25
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
Mark Olesen's avatar
Mark Olesen committed
26 27 28 29 30 31 32 33 34 35

Class
    Foam::MeshedSurfaceProxy

Description
    A proxy for writing MeshedSurface, UnsortedMeshedSurface and surfMesh
    to various file formats.

SourceFiles
    MeshedSurfaceProxy.C
36
    MeshedSurfaceProxys.C
Mark Olesen's avatar
Mark Olesen committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

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

#ifndef MeshedSurfaceProxy_H
#define MeshedSurfaceProxy_H

#include "pointField.H"
#include "surfZoneList.H"
#include "surfaceFormatsCore.H"
#include "runTimeSelectionTables.H"
#include "memberFunctionSelectionTables.H"

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

namespace Foam
{

54
// Forward Declarations
Mark Olesen's avatar
Mark Olesen committed
55 56 57 58 59 60 61 62 63 64 65
template<class Face> class MeshedSurface;

/*---------------------------------------------------------------------------*\
                     Class MeshedSurfaceProxy Declaration
\*---------------------------------------------------------------------------*/

template<class Face>
class MeshedSurfaceProxy
:
    public fileFormats::surfaceFormatsCore
{
66
    // Private Data
Mark Olesen's avatar
Mark Olesen committed
67 68 69

        const pointField& points_;

70
        const UList<Face>& faces_;
Mark Olesen's avatar
Mark Olesen committed
71

72
        const UList<surfZone>& zones_;
Mark Olesen's avatar
Mark Olesen committed
73

74
        const UList<label>& faceMap_;
Andrew Heather's avatar
Andrew Heather committed
75

Mark Olesen's avatar
Mark Olesen committed
76 77
public:

78
    // Public Typedefs
79

80 81 82 83 84
        //- The face type
        typedef Face face_type;

        //- The point type
        typedef point point_type;
85 86


87 88
    //- Declare type-name (with debug switch)
    ClassName("MeshedSurfaceProxy");
Andrew Heather's avatar
Andrew Heather committed
89

90 91

    // Static Functions
Mark Olesen's avatar
Mark Olesen committed
92

93 94 95 96
        //- The file format types that can be written via MeshedSurfaceProxy
        static wordHashSet writeTypes();

        //- Can this file format type be written via MeshedSurfaceProxy?
Mark Olesen's avatar
Mark Olesen committed
97 98 99 100 101 102 103 104
        static bool canWriteType(const word& ext, const bool verbose=false);


    // Constructors

        //- Construct from component references
        MeshedSurfaceProxy
        (
105
            const pointField& pointLst,
106 107
            const UList<Face>& faceLst,
            const UList<surfZone>& zoneLst = List<surfZone>(),
108
            const labelUList& faceMap = labelUList::null()
Mark Olesen's avatar
Mark Olesen committed
109 110
        );

Andrew Heather's avatar
Andrew Heather committed
111

112
    //- Destructor
113
    virtual ~MeshedSurfaceProxy() = default;
Mark Olesen's avatar
Mark Olesen committed
114 115 116 117 118 119 120 121 122 123 124 125


    // Member Function Selectors

        declareMemberFunctionSelectionTable
        (
            void,
            MeshedSurfaceProxy,
            write,
            fileExtension,
            (
                const fileName& name,
126
                const MeshedSurfaceProxy<Face>& surf,
127
                IOstreamOption streamOpt,
128
                const dictionary& options
Mark Olesen's avatar
Mark Olesen committed
129
            ),
130
            (name, surf, streamOpt, options)
Mark Olesen's avatar
Mark Olesen committed
131 132
        );

133
        //- Write to file, select based on its extension
134 135
        static void write
        (
136
            const fileName& name,
137
            const MeshedSurfaceProxy& surf,
138 139
            IOstreamOption streamOpt = IOstreamOption(),
            const dictionary& options = dictionary::null
140 141 142 143 144 145 146
        );

        //- Write to file, selected based on given extension
        static void write
        (
            const fileName& name,
            const word& ext,
147
            const MeshedSurfaceProxy& surf,
148 149
            IOstreamOption streamOpt = IOstreamOption(),
            const dictionary& options = dictionary::null
150
        );
Mark Olesen's avatar
Mark Olesen committed
151 152 153 154


    // Member Functions

Andrew Heather's avatar
Andrew Heather committed
155 156
        // Access

157
            //- The surface size is the number of faces
158
            label size() const
159 160 161 162
            {
                return faces_.size();
            }

Andrew Heather's avatar
Andrew Heather committed
163
            //- Return const access to the points
164
            const pointField& points() const
Andrew Heather's avatar
Andrew Heather committed
165 166 167 168 169
            {
                return points_;
            }

            //- Return const access to the faces
170
            const UList<Face>& surfFaces() const
Andrew Heather's avatar
Andrew Heather committed
171 172 173 174 175 176 177
            {
                return faces_;
            }

            //- Const access to the surface zones.
            //  If zones are defined, they must be contiguous and cover the
            //  entire surface
178
            const UList<surfZone>& surfZones() const
Andrew Heather's avatar
Andrew Heather committed
179 180 181 182 183
            {
                return zones_;
            }

            //- Const access to the faceMap, zero-sized when unused
184
            const labelUList& faceMap() const
Andrew Heather's avatar
Andrew Heather committed
185 186 187 188
            {
                return faceMap_;
            }

189 190
            //- Can/should use faceMap?
            bool useFaceMap() const
Andrew Heather's avatar
Andrew Heather committed
191 192 193 194
            {
                return faceMap_.size() == faces_.size();
            }

195 196 197 198
            //- Count number of triangles.
            inline label nTriangles() const;


Andrew Heather's avatar
Andrew Heather committed
199 200
        // Write

201 202 203 204
            //- Generic write routine. Chooses writer based on its extension.
            virtual void write
            (
                const fileName& name,
205
                IOstreamOption streamOpt = IOstreamOption(),
206 207
                const dictionary& options = dictionary::null
            ) const
Andrew Heather's avatar
Andrew Heather committed
208
            {
209
                write(name, *this, streamOpt, options);
Andrew Heather's avatar
Andrew Heather committed
210 211
            }

212
            //- Generic write routine. Chooses writer based on extension.
213 214 215 216
            virtual void write
            (
                const fileName& name,
                const word& ext,
217
                IOstreamOption streamOpt = IOstreamOption(),
218 219
                const dictionary& options = dictionary::null
            ) const
220
            {
221
                write(name, ext, *this, streamOpt, options);
222 223
            }

Andrew Heather's avatar
Andrew Heather committed
224
            //- Write to database
225 226
            virtual void write
            (
227
                const Time& t,
228 229
                const word& surfName = word::null
            ) const;
Mark Olesen's avatar
Mark Olesen committed
230 231 232 233 234 235 236 237 238 239
};


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

} // End namespace Foam

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

#ifdef NoRepository
240
    #include "MeshedSurfaceProxy.C"
Mark Olesen's avatar
Mark Olesen committed
241 242 243 244 245 246 247
#endif

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

#endif

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