Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / OpenFOAM / meshes / polyMesh / mapPolyMesh / morphFieldMapper.H
blobd4d26e75a08c4a1703e2566ca1f42951a00db07e
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
11     OpenFOAM is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by
13     the Free Software Foundation, either version 3 of the License, or
14     (at your option) any later version.
16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
19     for more details.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::morphFieldMapper
27 Description
28     Abstract base class to hold the Field mapping for mesh morphs.
30 \*---------------------------------------------------------------------------*/
32 #ifndef morphFieldMapper_H
33 #define morphFieldMapper_H
35 #include "Field.H"
36 #include "Map.H"
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 namespace Foam
43 /*---------------------------------------------------------------------------*\
44                            Class morphFieldMapper Declaration
45 \*---------------------------------------------------------------------------*/
47 class morphFieldMapper
49     public FieldMapper
52 public:
54     // Constructors
56         //- Null constructor
57         morphFieldMapper()
58         {}
61     //- Destructor
62     virtual ~morphFieldMapper()
63     {}
66     // Member Functions
68         //- Return size of field before mapping
69         virtual label sizeBeforeMapping() const = 0;
71         //- Are there any inserted objects
72         virtual bool insertedObjects() const = 0;
74         //- Return list of inserted objects
75         virtual const labelList& insertedObjectLabels() const = 0;
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 } // End namespace Foam
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 #endif
88 // ************************************************************************* //