src/vofDynamicMesh/lnInclude/threeDofMotion.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     threeDofMotion
  27
  28 Description
  29     Dynamic mesh class accomodating solid body motion based on a
  30     3-DOF translational solver.
  31
  32 SourceFiles
  33     threeDofMotion.C
  34
  35 Author
  36     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef threeDofMotion_H
  41 #define threeDofMotion_H
  42
  43 #include "dynamicFvMesh.H"
  44 #include "translationODE.H"
  45 #include "polyPatchID.H"
  46 #include "ODESolver.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 class motionSolver;
  54
  55 /*---------------------------------------------------------------------------*\
  56                         Class threeDofMotion Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class threeDofMotion
  60 :
  61     public dynamicFvMesh
  62 {
  63     // Private data
  64
  65         //- Motion dictionary
  66         dictionary dict_;
  67
  68         //- 3-DOF equation
  69         translationODE equation_;
  70
  71         //- ODE solver
  72         autoPtr<ODESolver> solver_;
  73
  74         //- ODE solver accuracy
  75         scalar epsilon_;
  76
  77         //- Mesh motion solver
  78         autoPtr<motionSolver> motionPtr_;
  79
  80         //- Identifier of a hull patch
  81         polyPatchID hullPatch_;
  82
  83         //- Current time index
  84         label curTimeIndex_;
  85
  86         //- Force at the beginning of time-step
  87         vector oldForce_;
  88
  89
  90     // Private Member Functions
  91
  92         //- Disallow default bitwise copy construct
  93         threeDofMotion(const threeDofMotion&);
  94
  95         //- Disallow default bitwise assignment
  96         void operator=(const threeDofMotion&);
  97
  98
  99         //- Return the effective viscous stress (laminar + turbulent).
 100         tmp<volSymmTensorField> devRhoReff() const;
 101
 102         //- Return force on the hull
 103         vector hullForce() const;
 104
 105
 106 public:
 107
 108     //- Runtime type information
 109     TypeName("threeDofMotion");
 110
 111
 112     // Constructors
 113
 114         //- Construct from IOobject
 115         threeDofMotion(const IOobject& io);
 116
 117
 118     // Destructor
 119
 120         virtual ~threeDofMotion();
 121
 122
 123     // Member Functions
 124
 125         //- Update the mesh for both mesh motion and topology change
 126         virtual bool update();
 127 };
 128
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 } // End namespace Foam
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 #endif
 137
 138 // ************************************************************************* //