velocityMotionSolver.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-2023 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::velocityMotionSolver
26 
27 Description
28  Virtual base class for velocity motion solver
29 
30  The boundary displacement is set as a boundary condition
31  on the pointMotionU pointVectorField.
32 
33 SourceFiles
34  velocityMotionSolver.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef velocityMotionSolver_H
39 #define velocityMotionSolver_H
40 
41 #include "motionSolver.H"
42 #include "pointFields.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 class polyTopoChangeMap;
50 
51 /*---------------------------------------------------------------------------*\
52  Class velocityMotionSolver Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public motionSolver
58 {
59 protected:
60 
61  // Protected data
62 
63  //- Point motion field
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("velocityMotionSolver");
71 
72 
73  // Constructors
74 
75  //- Construct from mesh and dictionary
77  (
78  const word& name,
79  const polyMesh&,
80  const dictionary&,
81  const word& type
82  );
83 
84  //- Disallow default bitwise copy construction
86 
87 
88  //- Destructor
89  virtual ~velocityMotionSolver();
90 
91 
92  // Member Functions
93 
94  //- Return reference to the point motion velocity field
96  {
97  return pointMotionU_;
98  }
99 
100  //- Return const reference to the point motion velocity field
101  const pointVectorField& pointMotionU() const
102  {
103  return pointMotionU_;
104  }
105 
106  //- Update local data for geometry changes
107  virtual void movePoints(const pointField&);
108 
109  //- Update corresponding to the given map
110  virtual void topoChange(const polyTopoChangeMap&);
111 
112  //- Update from another mesh using the given map
113  virtual void mapMesh(const polyMeshMap&);
114 
115  //- Update corresponding to the given distribution map
116  virtual void distribute(const polyDistributionMap&);
117 
118 
119  // Member Operators
120 
121  //- Disallow default bitwise assignment
122  void operator=(const velocityMotionSolver&) = delete;
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
Virtual base class for mesh motion solver.
Definition: motionSolver.H:57
const word & name() const
Return name.
Definition: motionSolver.H:125
Class containing mesh-to-mesh mapping information after a mesh distribution where we send parts of me...
Class containing mesh-to-mesh mapping information.
Definition: polyMeshMap.H:51
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Virtual base class for velocity motion solver.
velocityMotionSolver(const word &name, const polyMesh &, const dictionary &, const word &type)
Construct from mesh and dictionary.
virtual void topoChange(const polyTopoChangeMap &)
Update corresponding to the given map.
virtual void distribute(const polyDistributionMap &)
Update corresponding to the given distribution map.
virtual ~velocityMotionSolver()
Destructor.
void operator=(const velocityMotionSolver &)=delete
Disallow default bitwise assignment.
TypeName("velocityMotionSolver")
Runtime type information.
virtual void mapMesh(const polyMeshMap &)
Update from another mesh using the given map.
pointVectorField pointMotionU_
Point motion field.
virtual void movePoints(const pointField &)
Update local data for geometry changes.
pointVectorField & pointMotionU()
Return reference to the point motion velocity field.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488