Clean up
[ShipHydroSIG.git] / src / vofDynamicMesh / lnInclude / floatingBodies.H
blob7da0752dd4aea7b503b81edbfda3c362fc835168
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright held by original author
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     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, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     floatingBodies
28 Description
29     A list of floating bodies.
31 Author
32     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
34 \*---------------------------------------------------------------------------*/
36 #ifndef floatingBodies_H
37 #define floatingBodies_H
39 #include "PtrList.H"
40 #include "floatingBody.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                        Class floatingBodies Declaration
49 \*---------------------------------------------------------------------------*/
51 class floatingBodies
53     public PtrList<floatingBody>
55 private:
57     // Private Member Functions
59         //- Disallow default bitwise copy construct
60         floatingBodies(const floatingBodies&);
62         //- Disallow default bitwise assignment
63         void operator=(const floatingBodies&);
66 public:
68     // Constructors
70         //- Construct from Istream
71         floatingBodies
72         (
73             const fvMesh& mesh,
74             Istream& is
75         )
76         {
77             PtrList<entry> entries(is);
79             setSize(entries.size());
81             forAll (entries, i)
82             {
83                 this->set
84                 (
85                     i,
86                     new floatingBody
87                     (
88                         entries[i].keyword(),
89                         mesh,
90                         entries[i].dict()
91                     )
92                 );
93             }
94         }
97     // Destructor - default
100     // Member Functions
102         //- Set boundary motion for all bodies
103         void setMotion(tetPointVectorField& motionU)
104         {
105             PtrList<floatingBody>& bodies = *this;
107             forAll (bodies, bodyI)
108             {
109                 bodies[bodyI].setMotion(motionU);
110             }
111         }
113         //- Correct motion for all bodies
114         void correctMotion(vectorField& newAllPoints) const
115         {
116             const PtrList<floatingBody>& bodies = *this;
118             forAll (bodies, bodyI)
119             {
120                 bodies[bodyI].correctMotion(newAllPoints);
121             }
122         }
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 } // End namespace Foam
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 #endif
134 // ************************************************************************* //