points0MotionSolver.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) 2016-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::points0MotionSolver
26 
27 Description
28  Virtual base class for displacement motion solvers.
29 
30 SourceFiles
31  points0MotionSolver.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef points0MotionSolver_H
36 #define points0MotionSolver_H
37 
38 #include "motionSolver.H"
39 #include "pointFields.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class polyTopoChangeMap;
47 
48 /*---------------------------------------------------------------------------*\
49  Class points0MotionSolver Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public motionSolver
55 {
56 
57 protected:
58 
59  // Protected data
60 
61  //- Starting points
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("points0MotionSolver");
69 
70 
71  // Constructors
72 
73  //- Construct from mesh and dictionary
75  (
76  const word& name,
77  const polyMesh&,
78  const dictionary&,
79  const word& type
80  );
81 
82  //- Disallow default bitwise copy construction
84 
85 
86  //- Destructor
87  virtual ~points0MotionSolver();
88 
89 
90  // Member Functions
91 
93 
94  //- Return reference to the reference field
96  {
97  return points0_;
98  }
99 
100  //- Return reference to the reference field
101  const pointField& points0() const
102  {
103  return points0_;
104  }
105 
106  //- Update local data for geometry changes
107  virtual void movePoints(const pointField&);
108 
109  //- Update local data for topology changes
110  virtual void topoChange(const polyTopoChangeMap&);
111 
112  //- Update from another mesh using the given map
113  // Resets points0 to the points of the new mesh
114  virtual void mapMesh(const polyMeshMap&);
115 
116  //- Update corresponding to the given distribution map
117  virtual void distribute(const polyDistributionMap&);
118 
119  //- Write points0 if the mesh topology changed
120  virtual bool write() const;
121 
122 
123  // Member Operators
124 
125  //- Disallow default bitwise assignment
126  void operator=(const points0MotionSolver&) = delete;
127 };
128 
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 } // End namespace Foam
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 #endif
137 
138 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Virtual base class for mesh motion solver.
Definition: motionSolver.H:57
const word & name() const
Return name.
Definition: motionSolver.H:125
const polyMesh & mesh() const
Return reference to mesh.
Definition: motionSolver.H:137
Virtual base class for displacement motion solvers.
points0MotionSolver(const word &name, const polyMesh &, const dictionary &, const word &type)
Construct from mesh and dictionary.
void operator=(const points0MotionSolver &)=delete
Disallow default bitwise assignment.
virtual ~points0MotionSolver()
Destructor.
virtual void topoChange(const polyTopoChangeMap &)
Update local data for topology changes.
TypeName("points0MotionSolver")
Runtime type information.
virtual void distribute(const polyDistributionMap &)
Update corresponding to the given distribution map.
static pointVectorField readPoints0(const polyMesh &mesh)
virtual void mapMesh(const polyMeshMap &)
Update from another mesh using the given map.
virtual void movePoints(const pointField &)
Update local data for geometry changes.
virtual bool write() const
Write points0 if the mesh topology changed.
pointVectorField points0_
Starting points.
pointField & points0()
Return reference to the reference field.
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.
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