dynamicMotionSolverFvMesh.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2017 OpenFOAM Foundation
9  Copyright (C) 2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::dynamicMotionSolverFvMesh
29 
30 Description
31  The dynamicMotionSolverFvMesh
32 
33 SourceFiles
34  dynamicMotionSolverFvMesh.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef dynamicMotionSolverFvMesh_H
39 #define dynamicMotionSolverFvMesh_H
40 
41 #include "dynamicFvMesh.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 class motionSolver;
49 
50 /*---------------------------------------------------------------------------*\
51  Class dynamicMotionSolverFvMesh Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public dynamicFvMesh
57 {
58  // Private data
59 
60  autoPtr<motionSolver> motionPtr_;
61 
62 
63  // Private Member Functions
64 
65  //- No copy construct
67 
68  //- No copy assignment
69  void operator=(const dynamicMotionSolverFvMesh&) = delete;
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("dynamicMotionSolverFvMesh");
76 
77 
78  // Constructors
79 
80  //- Construct from IOobject
81  dynamicMotionSolverFvMesh(const IOobject& io, const bool doInit=true);
82 
83  //- Construct from components without boundary.
84  // Boundary is added using addFvPatches() member function
86  (
87  const IOobject& io,
89  faceList&& faces,
90  labelList&& allOwner,
91  labelList&& allNeighbour,
92  const bool syncPar = true
93  );
94 
95 
96  //- Destructor
97  virtual ~dynamicMotionSolverFvMesh() = default;
98 
99 
100  // Member Functions
101 
102  //- Initialise all non-demand-driven data
103  virtual bool init(const bool doInit);
104 
105  //- Return the motionSolver
106  const motionSolver& motion() const;
107 
108  //- Update the mesh for both mesh motion and topology change
109  virtual bool update();
110 };
111 
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
virtual bool init(const bool doInit)
Initialise all non-demand-driven data.
virtual bool update()
Update the mesh for both mesh motion and topology change.
Virtual base class for mesh motion solver.
Definition: motionSolver.H:54
virtual const pointField & points() const
Return raw points.
Definition: polyMesh.C:1078
virtual const faceList & faces() const
Return raw faces.
Definition: polyMesh.C:1103
Abstract base class for geometry and/or topology changing fvMesh.
Definition: dynamicFvMesh.H:74
virtual ~dynamicMotionSolverFvMesh()=default
Destructor.
const motionSolver & motion() const
Return the motionSolver.
Pointer management similar to std::unique_ptr, with some additional methods and type checking...
Definition: HashPtrTable.H:48
The dynamicMotionSolverFvMesh.
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, IOobject::NO_REGISTER)
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition: IOobject.H:172
TypeName("dynamicMotionSolverFvMesh")
Runtime type information.
Namespace for OpenFOAM.