src/dynamicMesh/motionSolver/motionSolver.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::motionSolver
  26
  27 Description
  28     Virtual base class for mesh motion solver.
  29
  30 SourceFiles
  31     motionSolver.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef motionSolver_H
  36 #define motionSolver_H
  37
  38 #include "IOdictionary.H"
  39 #include "pointField.H"
  40 #include "twoDPointCorrector.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward class declarations
  48 class polyMesh;
  49 class mapPolyMesh;
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class motionSolver Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class motionSolver
  56 :
  57     public IOdictionary
  58 {
  59 private:
  60
  61     // Private data
  62
  63         //- Reference to mesh
  64         const polyMesh& mesh_;
  65
  66         //- 2-D motion corrector pointer
  67         twoDPointCorrector twoDPointCorrector_;
  68
  69
  70 public:
  71
  72     //- Runtime type information
  73     TypeName("motionSolver");
  74
  75
  76     // Declare run-time constructor selection tables
  77
  78         declareRunTimeSelectionTable
  79         (
  80             autoPtr,
  81             motionSolver,
  82             dictionary,
  83             (const polyMesh& mesh, Istream& msData),
  84             (mesh, msData)
  85         );
  86
  87
  88     // Selectors
  89
  90         //- Select constructed from polyMesh
  91         static autoPtr<motionSolver> New(const polyMesh& mesh);
  92
  93
  94     // Constructors
  95
  96         //- Construct from polyMesh
  97         motionSolver(const polyMesh& mesh);
  98
  99
 100     //- Destructor
 101     virtual ~motionSolver();
 102
 103
 104     // Member Functions
 105
 106         //- Return reference to mesh
 107         const polyMesh& mesh() const
 108         {
 109             return mesh_;
 110         }
 111
 112         //- Provide new points for motion.  Solves for motion
 113         virtual tmp<pointField> newPoints();
 114
 115         //- Provide current points for motion.  Uses current motion field
 116         virtual tmp<pointField> curPoints() const = 0;
 117
 118         virtual void twoDCorrectPoints(pointField&) const;
 119
 120         //- Solve for motion
 121         virtual void solve() = 0;
 122
 123         //- Update topology
 124         virtual void updateMesh(const mapPolyMesh&) = 0;
 125 };
 126
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 } // End namespace Foam
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 #endif
 135
 136 // ************************************************************************* //