componentVelocityMotionSolver.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-2020 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::componentVelocityMotionSolver
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 pointMotionUX pointScalarField.
32 
33 SourceFiles
34  componentVelocityMotionSolver.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef componentVelocityMotionSolver_H
39 #define componentVelocityMotionSolver_H
40 
41 #include "motionSolver.H"
42 #include "pointFields.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 class mapPolyMesh;
50 
51 /*---------------------------------------------------------------------------*\
52  Class componentVelocityMotionSolver Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public motionSolver
58 {
59 protected:
60 
61  // Protected data
62 
63  //- The component name to solve for
65 
66  //- The component to solve for
68 
69  //- Point motion field
71 
72 
73 private:
74 
75  // Private Member Functions
76 
77  //- Return the component corresponding to the given component name
78  direction cmpt(const word& cmptName) const;
79 
80 
81 public:
82 
83  //- Runtime type information
84  TypeName("componentVelocityMotionSolver");
85 
86 
87  // Constructors
88 
89  //- Construct from mesh and dictionary
91  (
92  const polyMesh&,
93  const dictionary&,
94  const word& type
95  );
96 
97  //- Disallow default bitwise copy construction
99  (
101  );
102 
103 
104  //- Destructor
106 
107 
108  // Member Functions
109 
110  //- Non-const access to the pointMotionU in order to allow changes
111  // to the boundary motion
113  {
114  return pointMotionU_;
115  }
116 
117  //- Update local data for geometry changes
118  virtual void movePoints(const pointField&);
119 
120  //- Update local data for topology changes
121  virtual void updateMesh(const mapPolyMesh&);
122 
123 
124  // Member Operators
125 
126  //- Disallow default bitwise assignment
127  void operator=(const componentVelocityMotionSolver&) = delete;
128 };
129 
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 } // End namespace Foam
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 #endif
138 
139 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
uint8_t direction
Definition: direction.H:45
Virtual base class for mesh motion solver.
Definition: motionSolver.H:55
void operator=(const componentVelocityMotionSolver &)=delete
Disallow default bitwise assignment.
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition: mapPolyMesh.H:158
Virtual base class for velocity motion solver.
TypeName("componentVelocityMotionSolver")
Runtime type information.
A class for handling words, derived from string.
Definition: word.H:59
componentVelocityMotionSolver(const polyMesh &, const dictionary &, const word &type)
Construct from mesh and dictionary.
virtual void updateMesh(const mapPolyMesh &)
Update local data for topology changes.
virtual void movePoints(const pointField &)
Update local data for geometry changes.
word cmptName_
The component name to solve for.
pointScalarField pointMotionU_
Point motion field.
pointScalarField & pointMotionU()
Non-const access to the pointMotionU in order to allow changes.
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488
direction cmpt_
The component to solve for.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Namespace for OpenFOAM.