motionSmootherData.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2013 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::motionSmootherData
28 
29 Description
30 
31 SourceFiles
32  motionSmootherData.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef motionSmootherData_H
37 #define motionSmootherData_H
38 
39 #include "pointFields.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class motionSmootherData Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 {
52 protected:
53 
54  // Private data
55 
56  //- Displacement field
58 
59  //- Scale factor for displacement
61 
62  //- Starting mesh position
64 
65 
66 public:
67 
68  // Constructors
69 
70  //- Construct read
71  explicit motionSmootherData(const pointMesh& pMesh);
72 
73  //- Construct from pointDisplacement
75 
76 
77  // Member Functions
78 
79  //- Reference to displacement field
81 
82  //- Reference to displacement field
83  const pointVectorField& displacement() const;
84 
85  //- Reference to scale field
86  const pointScalarField& scale() const;
87 
88  //- Starting mesh position
89  const pointField& oldPoints() const;
90 
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
Foam::motionSmootherData::scale_
pointScalarField scale_
Scale factor for displacement.
Definition: motionSmootherData.H:59
Foam::motionSmootherData::displacement_
pointVectorField displacement_
Displacement field.
Definition: motionSmootherData.H:56
Foam::motionSmootherData
Definition: motionSmootherData.H:49
Foam::motionSmootherData::oldPoints
const pointField & oldPoints() const
Starting mesh position.
Definition: motionSmootherData.C:120
Foam::motionSmootherData::scale
const pointScalarField & scale() const
Reference to scale field.
Definition: motionSmootherData.C:114
Foam::Field< vector >
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::pointMesh
Mesh representing a set of points created from polyMesh.
Definition: pointMesh.H:51
Foam::motionSmootherData::oldPoints_
pointField oldPoints_
Starting mesh position.
Definition: motionSmootherData.H:62
Foam::GeometricField< vector, pointPatchField, pointMesh >
Foam::motionSmootherData::motionSmootherData
motionSmootherData(const pointMesh &pMesh)
Construct read.
Definition: motionSmootherData.C:33
pointFields.H
Foam::motionSmootherData::displacement
pointVectorField & displacement()
Reference to displacement field.
Definition: motionSmootherData.C:102