MeshedSurfaceProxy.H 6.56 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 6 7 8
    \\  /    A nd           | Copyright (C) 2016-2018 OpenCFD Ltd.
     \\/     M anipulation  |
-------------------------------------------------------------------------------
                            | Copyright (C) 2011-2016 OpenFOAM Foundation
Mark Olesen's avatar
Mark Olesen committed
9 10 11 12
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

13 14 15 16
    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
17 18 19 20 21 22 23

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

Class
    Foam::MeshedSurfaceProxy

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

SourceFiles
    MeshedSurfaceProxy.C
35
    MeshedSurfaceProxys.C
Mark Olesen's avatar
Mark Olesen committed
36 37 38 39 40 41 42

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

#ifndef MeshedSurfaceProxy_H
#define MeshedSurfaceProxy_H

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

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

namespace Foam
{

56
// Forward declarations
Mark Olesen's avatar
Mark Olesen committed
57 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 Member 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

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

81 82 83 84 85 86
    // Public typedefs

        //- Face type used
        typedef Face FaceType;


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

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

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


    // Constructors

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

Andrew Heather's avatar
Andrew Heather committed
110

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


    // Member Function Selectors

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

131
        //- Write to file, select based on its extension
132 133
        static void write
        (
134
            const fileName& name,
135 136
            const MeshedSurfaceProxy& surf,
            const dictionary& options
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 145
            const MeshedSurfaceProxy& surf,
            const dictionary& options
146
        );
Mark Olesen's avatar
Mark Olesen committed
147 148 149 150


    // Member Functions

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

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

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

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

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

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

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

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


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

197 198 199 200 201 202
            //- 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
203
            {
204
                write(name, *this, options);
Andrew Heather's avatar
Andrew Heather committed
205 206
            }

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

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


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

} // End namespace Foam

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

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

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

#endif

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