src/ODE/sixDOF/sixDOFbodies/sixDOFbodies.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     sixDOFbodies
  27
  28 Description
  29     6-DOF solver for multiple bodies
  30
  31 Author
  32     Dubravko Matijasevic, FSB Zagreb.  All rights reserved.
  33
  34 SourceFiles
  35     sixDOFbodies.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef sixDOFbodies_H
  40 #define sixDOFbodies_H
  41
  42 #include "Time.H"
  43 #include "IOdictionary.H"
  44 #include "sixDOFqODE.H"
  45 #include "ODESolver.H"
  46 #include "finiteRotation.H"
  47 #include "primitiveFields.H"
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 namespace Foam
  52 {
  53
  54 /*---------------------------------------------------------------------------*\
  55                         Class sixDOFbodies Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 class sixDOFbodies
  59 :
  60     public IOdictionary
  61 {
  62     // Private data
  63
  64         //- Reference to time
  65         const Time& runTime_;
  66
  67         // Pointer list of Foam::sixDOFqODE objects
  68         PtrList<sixDOFqODE> odes_;
  69
  70         // Pointer list of Foam::sixDOFqODE solvers
  71         PtrList<ODESolver> solvers_;
  72
  73         // Name list of solved bodies
  74         const wordList names_;
  75
  76
  77     // Private Member Functions
  78
  79         //- Disallow default bitwise copy construct
  80         sixDOFbodies(const sixDOFbodies&);
  81
  82         //- Disallow default bitwise assignment
  83         void operator=(const sixDOFbodies&);
  84
  85         //- Set bodies
  86         void setBodies();
  87
  88
  89 public:
  90
  91     // Constructors
  92
  93         //- Construct from Time
  94         sixDOFbodies(const Time& runTime);
  95
  96
  97     // Destructor
  98
  99         ~sixDOFbodies()
 100         {}
 101
 102
 103     // Member Functions
 104
 105         //- Return list of names
 106         const wordList& names() const;
 107
 108         //- Return list of bodies
 109         const PtrList<sixDOFqODE>& operator()() const;
 110
 111         //- Solve ODEs and update position
 112         void solve();
 113 };
 114
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 } // End namespace Foam
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #endif
 123
 124 // ************************************************************************* //