fvMotionSolver.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2012-2022 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::fvMotionSolver
26 
27 Description
28  Base class for fvMesh based motionSolvers.
29 
30 SourceFiles
31  fvMotionSolver.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef fvMotionSolver_H
36 #define fvMotionSolver_H
37 
38 #include "fvMesh.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class velocityMotionSolver Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class fvMotionSolver
50 {
51 
52 protected:
53 
54  // Protected data
55 
56  //- The fvMesh to be moved
57  const fvMesh& fvMesh_;
58 
59 
60  // Protected Member Functions
61 
62  //- Create the corresponding patch types for cellMotion from those
63  // of the given pointMotion
64  template<class Type>
66  (
67  const typename PointField<Type>::
68  Boundary& pmUbf
69  ) const;
70 
71 public:
72 
73  //- Runtime type information
74  ClassName("displacementMotionSolver");
75 
76  // Constructors
77 
78  //- Construct from polyMesh
79  fvMotionSolver(const polyMesh&);
80 
81 
82  // Member Functions
83 
84  //- Return reference to the fvMesh to be moved
85  const fvMesh& mesh() const
86  {
87  return fvMesh_;
88  }
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #ifdef NoRepository
99  #include "fvMotionSolverTemplates.C"
100 #endif
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Base class for fvMesh based motionSolvers.
const fvMesh & fvMesh_
The fvMesh to be moved.
const fvMesh & mesh() const
Return reference to the fvMesh to be moved.
ClassName("displacementMotionSolver")
Runtime type information.
fvMotionSolver(const polyMesh &)
Construct from polyMesh.
wordList cellMotionBoundaryTypes(const typename PointField< Type >::Boundary &pmUbf) const
Create the corresponding patch types for cellMotion from those.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
Namespace for OpenFOAM.