MeshedSurfaceProxy.H 6.48 KB
Newer Older
Mark Olesen's avatar
Mark Olesen committed
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
6
     \\/     M anipulation  | Copyright (C) 2016-2018 OpenCFD Ltd.
Mark Olesen's avatar
Mark Olesen committed
7 8 9 10
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

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

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

Class
    Foam::MeshedSurfaceProxy

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

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

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

#ifndef MeshedSurfaceProxy_H
#define MeshedSurfaceProxy_H

#include "pointField.H"
41
#include "labelledTri.H"
42
#include "HashSet.H"
43
#include "ListOps.H"
Mark Olesen's avatar
Mark Olesen committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
#include "surfZoneList.H"
#include "surfaceFormatsCore.H"
#include "runTimeSelectionTables.H"
#include "memberFunctionSelectionTables.H"

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

namespace Foam
{

// Forward declaration of friend functions and operators

template<class Face> class MeshedSurface;

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

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

        const pointField& points_;

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

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

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

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

79 80 81 82 83 84
    // Public typedefs

        //- Face type used
        typedef Face FaceType;


Andrew Heather's avatar
Andrew Heather committed
85 86
    // Static

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

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 = Foam::emptyLabelList
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 124
                const MeshedSurfaceProxy<Face>& surf,
                const dictionary& options
Mark Olesen's avatar
Mark Olesen committed
125
            ),
126
            (name, surf, options)
Mark Olesen's avatar
Mark Olesen committed
127 128
        );

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

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


    // Member Functions

Andrew Heather's avatar
Andrew Heather committed
149 150
        // Access

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

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

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

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

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

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

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


Andrew Heather's avatar
Andrew Heather committed
193 194
        // Write

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

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

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


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

} // End namespace Foam

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

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

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

#endif

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