ENH: sampledSet: make starting cell/position consistent with lagrangian tracking
[OpenFOAM-2.0.x.git] / src / dynamicMesh / setUpdater / setUpdater.H
blobfa95ea9bcc3580738c189f724f297273eaada2d5
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
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::setUpdater
27 Description
28     Keeps cell/face/vertex sets uptodate. Both the ones loaded and the ones
29     on disk.
31 SourceFiles
32     setUpdater.C
33     setUpdaterTemplates.C
35 \*---------------------------------------------------------------------------*/
37 #ifndef setUpdater_H
38 #define setUpdater_H
40 #include "polyMeshModifier.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                        Class setUpdater Declaration
49 \*---------------------------------------------------------------------------*/
51 class setUpdater
53     public polyMeshModifier
55     // Private Member Functions
57         //- Updates all sets
58         template<class Type>
59         void updateSets(const mapPolyMesh& morphMap) const;
61         //- Disallow default bitwise copy construct
62         setUpdater(const setUpdater&);
64         //- Disallow default bitwise assignment
65         void operator=(const setUpdater&);
68 public:
70     //- Runtime type information
71     TypeName("setUpdater");
74     // Constructors
76         //- Construct from dictionary
77         setUpdater
78         (
79             const word& name,
80             const dictionary& dict,
81             const label index,
82             const polyTopoChanger& mme
83         );
86     //- Destructor
87     virtual ~setUpdater();
90     // Member Functions
92         //- Check for topology change
93         virtual bool changeTopology() const;
95         //- Insert the layer addition/removal instructions
96         //  into the topological change
97         virtual void setRefinement(polyTopoChange&) const;
99         //- Modify motion points to comply with the topological change
100         virtual void modifyMotionPoints(pointField& motionPoints) const;
102         //- Force recalculation of locally stored data on topological change
103         virtual void updateMesh(const mapPolyMesh&);
105         //- Write
106         virtual void write(Ostream&) const;
108         //- Write dictionary
109         virtual void writeDict(Ostream&) const;
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 } // End namespace Foam
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 #ifdef NoRepository
119 #   include "setUpdaterTemplates.C"
120 #endif
123 #endif
125 // ************************************************************************* //