All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
motionSmootherData.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) 2013-2019 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::motionSmootherData
26 
27 Description
28 
29 SourceFiles
30  motionSmootherData.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef motionSmootherData_H
35 #define motionSmootherData_H
36 
37 #include "pointFields.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class motionSmootherData Declaration
46 \*---------------------------------------------------------------------------*/
47 
49 {
50 protected:
51 
52  // Private Data
53 
54  //- Displacement field
56 
57  //- Scale factor for displacement
59 
60  //- Starting mesh position
62 
63 
64 public:
65 
66  // Constructors
67 
68  //- Construct read
70  (
71  const pointMesh&
72  );
73 
74  //- Construct from pointDisplacement
76  (
77  const pointVectorField&
78  );
79 
80 
81  // Member Functions
82 
83  //- Reference to displacement field
85 
86  //- Reference to displacement field
87  const pointVectorField& displacement() const;
88 
89  //- Reference to scale field
90  const pointScalarField& scale() const;
91 
92  //- Starting mesh position
93  const pointField& oldPoints() const;
94 
95 };
96 
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 } // End namespace Foam
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
pointVectorField displacement_
Displacement field.
motionSmootherData(const pointMesh &)
Construct read.
Mesh representing a set of points created from polyMesh.
Definition: pointMesh.H:48
pointScalarField scale_
Scale factor for displacement.
const pointField & oldPoints() const
Starting mesh position.
pointField oldPoints_
Starting mesh position.
const pointScalarField & scale() const
Reference to scale field.
Namespace for OpenFOAM.
pointVectorField & displacement()
Reference to displacement field.