Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / immersedBoundary / immersedBoundaryDynamicMesh / movingImmersedBoundary / movingImmersedBoundary.H
blob58dbef9efc0c33ab4c8eaccf9e225c0571fcd451
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     |
5     \\  /    A nd           | For copyright notice see file Copyright
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::movingImmersedBoundary
27 Description
28     Moving immesed boundary.  Motion is prescribed using a solid body motion
29     function.
31 SourceFiles
32     movingImmersedBoundary.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef movingImmersedBoundary_H
37 #define movingImmersedBoundary_H
39 #include "fvMesh.H"
40 #include "solidBodyMotionFunction.H"
41 #include "triSurfaceMesh.H"
42 #include "fvPatchFields.H"
43 #include "immersedBoundaryFvPatchFields.H"
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 namespace Foam
50 /*---------------------------------------------------------------------------*\
51                     Class movingImmersedBoundary Declaration
52 \*---------------------------------------------------------------------------*/
54 class movingImmersedBoundary
56     // Private data
58         //- Patch name
59         const word name_;
61         //- Mesh reference
62         const fvMesh& mesh_;
64         //- Overset region motion control function
65         autoPtr<solidBodyMotionFunction> sbmfPtr_;
67         //- Reference tri surface mesh position
68         triSurfaceMesh refIbSurface_;
71     // Private Member Functions
73         //- Disallow default bitwise copy construct
74         movingImmersedBoundary(const movingImmersedBoundary&);
76         //- Disallow default bitwise assignment
77         void operator=(const movingImmersedBoundary&);
80 public:
82     // Constructors
84         //- Construct from dictionary
85         movingImmersedBoundary
86         (
87             const word& name,
88             const fvMesh& mesh,
89             const dictionary& dict
90         );
93     //- Destructor
94     ~movingImmersedBoundary();
96     // Member Functions
98         //- Return name
99         const word& name() const
100         {
101             return name_;
102         }
104         //- Return mesh
105         const fvMesh& mesh() const
106         {
107             return mesh_;
108         }
110         //- Move immersed boundary patch points
111         void movePoints() const;
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 } // End namespace Foam
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 #endif
123 // ************************************************************************* //