DOC: Corrected class names in the file descriptions
[freefoam.git] / src / fvMotionSolver / fvMotionSolvers / displacement / displacementFvMotionSolver / displacementFvMotionSolver.H
blob8fa9d7cfbd61567392efc84b87b28a73a71539b0
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-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::displacementFvMotionSolver
27 Description
28     Base class for fvMotionSolvers which calculate displacement.
30 SourceFiles
31     displacementFvMotionSolver.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef displacementFvMotionSolver_H
36 #define displacementFvMotionSolver_H
38 #include <fvMotionSolvers/fvMotionSolver.H>
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46         Class displacementFvMotionSolver Declaration
47 \*---------------------------------------------------------------------------*/
49 class displacementFvMotionSolver
51     public fvMotionSolver
53     // Private data
55         //- Reference point field
56         pointField points0_;
59     // Private Member Functions
61         //- Disallow default bitwise copy construct
62         displacementFvMotionSolver
63         (
64             const displacementFvMotionSolver&
65         );
67         //- Disallow default bitwise assignment
68         void operator=(const displacementFvMotionSolver&);
71 public:
73     //- Runtime type information
74     TypeName("displacementInterpolation");
77     // Constructors
79         //- Construct from polyMesh and data stream
80         displacementFvMotionSolver
81         (
82             const polyMesh&,
83             Istream& msDataUnused
84         );
87     // Destructor
89         ~displacementFvMotionSolver();
92     // Member Functions
94         //- Return reference to the reference field
95         const pointField& points0() const
96         {
97             return points0_;
98         }
100         //- Update topology
101         virtual void updateMesh(const mapPolyMesh&);
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 } // End namespace Foam
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 #endif
113 // ************************ vim: set sw=4 sts=4 et: ************************ //