src/vofDynamicMesh/lnInclude/floatingBodyFvMesh.H

   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.
  10
  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.
  15
  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.
  20
  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
  24
  25 Class
  26     floatingBodyFvMesh
  27
  28 Description
  29     Multi-body motion with GGI interfaces.
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
  33
  34 SourceFiles
  35     floatingBodyFvMesh.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef floatingBodyFvMesh_H
  40 #define floatingBodyFvMesh_H
  41
  42 #include "topoChangerFvMesh.H"
  43 #include "floatingBodies.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 class motionSolver;
  51
  52 /*---------------------------------------------------------------------------*\
  53                         Class floatingBodyFvMesh Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class floatingBodyFvMesh
  57 :
  58     public topoChangerFvMesh
  59 {
  60     // Private data
  61
  62         //- Motion dictionary
  63         dictionary dict_;
  64
  65         //- List of bodies
  66         floatingBodies bodies_;
  67
  68         //- Number of steps between mesh motion updates
  69         label nSteps_;
  70
  71         //- Mesh motion solver
  72         autoPtr<motionSolver> motionPtr_;
  73
  74
  75     // Private Member Functions
  76
  77         //- Disallow default bitwise copy construct
  78         floatingBodyFvMesh(const floatingBodyFvMesh&);
  79
  80         //- Disallow default bitwise assignment
  81         void operator=(const floatingBodyFvMesh&);
  82
  83
  84 public:
  85
  86     //- Runtime type information
  87     TypeName("floatingBodyFvMesh");
  88
  89
  90     // Constructors
  91
  92         //- Construct from IOobject
  93         explicit floatingBodyFvMesh(const IOobject& io);
  94
  95
  96     // Destructor
  97
  98         ~floatingBodyFvMesh();
  99
 100
 101     // Member Functions
 102
 103         //- Update the mesh for both mesh motion and topology change
 104         virtual bool update();
 105 };
 106
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 } // End namespace Foam
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 #endif
 115
 116 // ************************************************************************* //