displacementMotionSolver.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::displacementMotionSolver
26 
27 Description
28  Virtual base class for displacement motion solver
29 
30  The boundary displacement is set as a boundary condition
31  on the pointDisplacement pointVectorField.
32 
33 SourceFiles
34  displacementMotionSolver.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef displacementMotionSolver_H
39 #define displacementMotionSolver_H
40 
41 #include "points0MotionSolver.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class displacementMotionSolver Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public points0MotionSolver
55 {
56 protected:
57 
58  // Protected data
59 
60  //- Point motion field
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("displacementMotionSolver");
68 
69 
70  // Constructors
71 
72  //- Construct from mesh and dictionary
74  (
75  const word& name,
76  const polyMesh&,
77  const dictionary&,
78  const word& type
79  );
80 
81  //- Disallow default bitwise copy construction
83 
84 
85  //- Destructor
86  virtual ~displacementMotionSolver();
87 
88 
89  // Member Functions
90 
91  //- Return reference to the point motion displacement field
93  {
94  return pointDisplacement_;
95  }
96 
97  //- Return const reference to the point motion displacement field
98  const pointVectorField& pointDisplacement() const
99  {
100  return pointDisplacement_;
101  }
102 
103  //- Update from another mesh using the given map
104  virtual void mapMesh(const polyMeshMap&);
105 
106 
107  // Member Operators
108 
109  //- Disallow default bitwise assignment
110  void operator=(const displacementMotionSolver&) = delete;
111 };
112 
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 } // End namespace Foam
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #endif
121 
122 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Virtual base class for displacement motion solver.
virtual ~displacementMotionSolver()
Destructor.
pointVectorField pointDisplacement_
Point motion field.
virtual void mapMesh(const polyMeshMap &)
Update from another mesh using the given map.
void operator=(const displacementMotionSolver &)=delete
Disallow default bitwise assignment.
TypeName("displacementMotionSolver")
Runtime type information.
pointVectorField & pointDisplacement()
Return reference to the point motion displacement field.
displacementMotionSolver(const word &name, const polyMesh &, const dictionary &, const word &type)
Construct from mesh and dictionary.
const word & name() const
Return name.
Definition: motionSolver.H:125
Virtual base class for displacement motion solvers.
Class containing mesh-to-mesh mapping information.
Definition: polyMeshMap.H:51
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
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