MeshedSurfaceProxy.H 6.8 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

        //- Face type used
        typedef Face FaceType;


84 85
    //- Declare type-name (with debug switch)
    ClassName("MeshedSurfaceProxy");
Andrew Heather's avatar
Andrew Heather committed
86

87 88

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

90 91 92 93
        //- 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
94 95 96 97 98 99 100 101
        static bool canWriteType(const word& ext, const bool verbose=false);


    // Constructors

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

Andrew Heather's avatar
Andrew Heather committed
108

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


    // Member Function Selectors

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

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

        //- Write to file, selected based on given extension
        static void write
        (
            const fileName& name,
            const word& ext,
144
            const MeshedSurfaceProxy& surf,
145 146
            IOstreamOption streamOpt = IOstreamOption(),
            const dictionary& options = dictionary::null
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
            //- The surface size is the number of faces
155
            label size() const
156 157 158 159
            {
                return faces_.size();
            }

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

            //- Return const access to the faces
167
            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
            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
            const labelUList& faceMap() const
Andrew Heather's avatar
Andrew Heather committed
182 183 184 185
            {
                return faceMap_;
            }

186 187
            //- Can/should use faceMap?
            bool useFaceMap() const
Andrew Heather's avatar
Andrew Heather committed
188 189 190 191
            {
                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
            //- Generic write routine. Chooses writer based on its extension.
            virtual void write
            (
                const fileName& name,
202
                IOstreamOption streamOpt = IOstreamOption(),
203 204
                const dictionary& options = dictionary::null
            ) const
Andrew Heather's avatar
Andrew Heather committed
205
            {
206
                write(name, *this, streamOpt, options);
Andrew Heather's avatar
Andrew Heather committed
207 208
            }

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

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


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

} // End namespace Foam

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

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

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

#endif

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