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