displacementComponentLaplacianFvMotionSolver.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) 2011-2022 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::displacementComponentLaplacianFvMotionSolver
26 
27 Description
28  Mesh motion solver for an fvMesh. Based on solving the cell-centre
29  Laplacian for the given component of the motion displacement.
30 
31 SourceFiles
32  displacementComponentLaplacianFvMotionSolver.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef displacementComponentLaplacianFvMotionSolver_H
37 #define displacementComponentLaplacianFvMotionSolver_H
38 
40 #include "fvMotionSolver.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 // Forward class declarations
48 class motionDiffusivity;
49 
50 /*---------------------------------------------------------------------------*\
51  Class displacementComponentLaplacianFvMotionSolver Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
57  public fvMotionSolver
58 {
59  // Private Data
60 
61  //- Cell-centre motion field
62  mutable volScalarField cellDisplacement_;
63 
64  //- Optionally read point-position field. Used only for position
65  // boundary conditions.
66  mutable autoPtr<pointVectorField> pointLocation_;
67 
68  //- Diffusivity used to control the motion
69  autoPtr<motionDiffusivity> diffusivityPtr_;
70 
71  //- Frozen points (that are not on patches). -1 or points that are
72  // fixed to be at points0_ location
73  label frozenPointsZone_;
74 
75 
76  // Private Member Functions
77 
78  //- Return the component corresponding to the given component name
79  direction cmpt(const word& cmptName) const;
80 
81 
82 public:
83 
84  //- Runtime type information
85  TypeName("displacementComponentLaplacian");
86 
87 
88  // Constructors
89 
90  //- Construct from polyMesh and dictionary
92  (
93  const word& name,
94  const polyMesh&,
95  const dictionary&
96  );
97 
98  //- Disallow default bitwise copy construction
100  (
102  ) = delete;
103 
104 
105  //- Destructor
107 
108 
109  // Member Functions
110 
111  //- Non-const access to the cellDisplacement in order to allow
112  // changes to the boundary motion
114  {
115  return cellDisplacement_;
116  }
117 
118  //- Return point location obtained from the current motion field
119  virtual tmp<pointField> curPoints() const;
120 
121  //- Solve for motion
122  virtual void solve();
123 
124  //- Update corresponding to the given map
125  virtual void topoChange(const polyTopoChangeMap&);
126 
127  //- Update from another mesh using the given map
128  virtual void mapMesh(const polyMeshMap&);
129 
130 
131  // Member Operators
132 
133  //- Disallow default bitwise assignment
134  void operator=
135  (
137  ) = delete;
138 };
139 
140 
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 
143 } // End namespace Foam
144 
145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146 
147 #endif
148 
149 // ************************************************************************* //
Generic GeometricField class.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
Virtual base class for displacement motion solver.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
Mesh motion solver for an fvMesh. Based on solving the cell-centre Laplacian for the given component ...
virtual tmp< pointField > curPoints() const
Return point location obtained from the current motion field.
virtual void topoChange(const polyTopoChangeMap &)
Update corresponding to the given map.
displacementComponentLaplacianFvMotionSolver(const word &name, const polyMesh &, const dictionary &)
Construct from polyMesh and dictionary.
virtual void mapMesh(const polyMeshMap &)
Update from another mesh using the given map.
volScalarField & cellDisplacement()
Non-const access to the cellDisplacement in order to allow.
TypeName("displacementComponentLaplacian")
Runtime type information.
Base class for fvMesh based motionSolvers.
const word & name() const
Return name.
Definition: motionSolver.H:125
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 managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
uint8_t direction
Definition: direction.H:45