MeshedSurfaceProxy.H 6.55 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 9
    Copyright (C) 2011-2016 OpenFOAM Foundation
    Copyright (C) 2016-2019 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

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

#ifndef MeshedSurfaceProxy_H
#define MeshedSurfaceProxy_H

#include "pointField.H"
44
#include "labelledTri.H"
45
#include "HashSet.H"
46
#include "ListOps.H"
Mark Olesen's avatar
Mark Olesen committed
47 48 49 50 51 52 53 54 55 56
#include "surfZoneList.H"
#include "surfaceFormatsCore.H"
#include "runTimeSelectionTables.H"
#include "memberFunctionSelectionTables.H"

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

namespace Foam
{

57
// Forward declarations
Mark Olesen's avatar
Mark Olesen committed
58 59 60 61 62 63 64 65 66 67 68 69

template<class Face> class MeshedSurface;

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

template<class Face>
class MeshedSurfaceProxy
:
    public fileFormats::surfaceFormatsCore
{
70
    // Private Member Data
Mark Olesen's avatar
Mark Olesen committed
71 72 73

        const pointField& points_;

74
        const UList<Face>& faces_;
Mark Olesen's avatar
Mark Olesen committed
75

76
        const UList<surfZone>& zones_;
Mark Olesen's avatar
Mark Olesen committed
77

78
        const UList<label>& faceMap_;
Andrew Heather's avatar
Andrew Heather committed
79

Mark Olesen's avatar
Mark Olesen committed
80 81
public:

82 83 84 85 86 87
    // Public typedefs

        //- Face type used
        typedef Face FaceType;


Andrew Heather's avatar
Andrew Heather committed
88 89
    // Static

Mark Olesen's avatar
Mark Olesen committed
90 91 92
        //- Runtime type information
        ClassName("MeshedSurfaceProxy");

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 127
                const MeshedSurfaceProxy<Face>& surf,
                const dictionary& options
Mark Olesen's avatar
Mark Olesen committed
128
            ),
129
            (name, surf, options)
Mark Olesen's avatar
Mark Olesen committed
130 131
        );

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

        //- Write to file, selected based on given extension
        static void write
        (
            const fileName& name,
            const word& ext,
145 146
            const MeshedSurfaceProxy& surf,
            const dictionary& options
147
        );
Mark Olesen's avatar
Mark Olesen committed
148 149 150 151


    // Member Functions

Andrew Heather's avatar
Andrew Heather committed
152 153
        // Access

154 155 156 157 158 159
            //- The surface size is the number of faces
            inline label size() const
            {
                return faces_.size();
            }

Andrew Heather's avatar
Andrew Heather committed
160 161 162 163 164 165 166
            //- Return const access to the points
            inline const pointField& points() const
            {
                return points_;
            }

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

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

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

            //- Use faceMap?
            inline bool useFaceMap() const
            {
                return faceMap_.size() == faces_.size();
            }

192 193 194 195
            //- Count number of triangles.
            inline label nTriangles() const;


Andrew Heather's avatar
Andrew Heather committed
196 197
        // Write

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

208
            //- Generic write routine. Chooses writer based on extension.
209 210 211 212 213 214
            virtual void write
            (
                const fileName& name,
                const word& ext,
                const dictionary& options = dictionary::null
            ) const
215
            {
216
                write(name, ext, *this, options);
217 218
            }

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


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

} // End namespace Foam

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

#ifdef NoRepository
235
    #include "MeshedSurfaceProxy.C"
Mark Olesen's avatar
Mark Olesen committed
236 237 238 239 240 241 242
#endif

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

#endif

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