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