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

Class
    Foam::MeshedSurfaceProxy

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

34 35 36
    The constructor interface is fat and ugly, but is largely encapsulated
    by conversion operators in other classes.

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

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

#ifndef MeshedSurfaceProxy_H
#define MeshedSurfaceProxy_H

#include "pointField.H"
#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
template<class Face> class MeshedSurface;

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

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

        const pointField& points_;

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

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

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

79 80 81
        const UList<label>& faceIds_;


Mark Olesen's avatar
Mark Olesen committed
82 83
public:

84
    // Public Typedefs
85

86 87 88 89 90
        //- The face type
        typedef Face face_type;

        //- The point type
        typedef point point_type;
91 92


93 94
    //- Declare type-name (with debug switch)
    ClassName("MeshedSurfaceProxy");
Andrew Heather's avatar
Andrew Heather committed
95

96 97

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

99 100 101 102
        //- The file format types that can be written via MeshedSurfaceProxy
        static wordHashSet writeTypes();

        //- Can this file format type be written via MeshedSurfaceProxy?
103
        static bool canWriteType(const word& fileType, bool verbose=false);
Mark Olesen's avatar
Mark Olesen committed
104 105 106 107 108 109 110


    // Constructors

        //- Construct from component references
        MeshedSurfaceProxy
        (
111
            const pointField& pointLst,
112
            const UList<Face>& faceLst,
113 114 115
            const UList<surfZone>& zoneLst = UList<surfZone>::null(),
            const labelUList& faceMap = labelUList::null(),
            const labelUList& faceIdLst = labelUList::null()
Mark Olesen's avatar
Mark Olesen committed
116 117
        );

Andrew Heather's avatar
Andrew Heather committed
118

119
    //- Destructor
120
    virtual ~MeshedSurfaceProxy() = default;
Mark Olesen's avatar
Mark Olesen committed
121 122 123 124 125 126 127 128 129 130 131 132


    // Member Function Selectors

        declareMemberFunctionSelectionTable
        (
            void,
            MeshedSurfaceProxy,
            write,
            fileExtension,
            (
                const fileName& name,
133
                const MeshedSurfaceProxy<Face>& surf,
134
                IOstreamOption streamOpt,
135
                const dictionary& options
Mark Olesen's avatar
Mark Olesen committed
136
            ),
137
            (name, surf, streamOpt, options)
Mark Olesen's avatar
Mark Olesen committed
138 139
        );

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

149 150
        //- Write to file with given format type.
        //  If the format type is "", uses the file extension.
151 152 153
        static void write
        (
            const fileName& name,
154
            const word& fileType,
155
            const MeshedSurfaceProxy& surf,
156 157
            IOstreamOption streamOpt = IOstreamOption(),
            const dictionary& options = dictionary::null
158
        );
Mark Olesen's avatar
Mark Olesen committed
159 160 161 162


    // Member Functions

Andrew Heather's avatar
Andrew Heather committed
163 164
        // Access

165
            //- The surface size is the number of faces
166
            label size() const
167 168 169 170
            {
                return faces_.size();
            }

Andrew Heather's avatar
Andrew Heather committed
171
            //- Return const access to the points
172
            const pointField& points() const
Andrew Heather's avatar
Andrew Heather committed
173 174 175 176 177
            {
                return points_;
            }

            //- Return const access to the faces
178
            const UList<Face>& surfFaces() const
Andrew Heather's avatar
Andrew Heather committed
179 180 181 182 183 184 185
            {
                return faces_;
            }

            //- Const access to the surface zones.
            //  If zones are defined, they must be contiguous and cover the
            //  entire surface
186
            const UList<surfZone>& surfZones() const
Andrew Heather's avatar
Andrew Heather committed
187 188 189 190 191
            {
                return zones_;
            }

            //- Const access to the faceMap, zero-sized when unused
192
            const labelUList& faceMap() const
Andrew Heather's avatar
Andrew Heather committed
193 194 195 196
            {
                return faceMap_;
            }

197 198 199 200 201 202
            //- Const access to the faceIds, zero-sized when unused
            const labelUList& faceIds() const
            {
                return faceIds_;
            }

203 204
            //- Can/should use faceMap?
            bool useFaceMap() const
Andrew Heather's avatar
Andrew Heather committed
205 206 207 208
            {
                return faceMap_.size() == faces_.size();
            }

209 210 211 212 213 214
            //- Possible to use faceIds?
            bool useFaceIds() const
            {
                return faceIds_.size() == faces_.size();
            }

215 216 217 218
            //- Count number of triangles.
            inline label nTriangles() const;


219
    // Write
Andrew Heather's avatar
Andrew Heather committed
220

221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
        //- Write to file, choosing writer based on the file extension.
        virtual void write
        (
            const fileName& name,
            IOstreamOption streamOpt = IOstreamOption(),
            const dictionary& options = dictionary::null
        ) const
        {
            write(name, *this, streamOpt, options);
        }

        //- Write to file with given format type.
        //  If the format type is "", uses the file extension.
        virtual void write
        (
            const fileName& name,
            const word& fileType,
            IOstreamOption streamOpt = IOstreamOption(),
            const dictionary& options = dictionary::null
        ) const
        {
            write(name, fileType, *this, streamOpt, options);
        }
244

245 246 247 248 249 250
        //- Write to database
        virtual void write
        (
            const Time& t,
            const word& surfName = word::null
        ) const;
Mark Olesen's avatar
Mark Olesen committed
251 252 253 254 255 256 257 258 259 260
};


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

} // End namespace Foam

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

#ifdef NoRepository
261
    #include "MeshedSurfaceProxy.C"
Mark Olesen's avatar
Mark Olesen committed
262 263 264 265 266 267 268
#endif

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

#endif

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