mixerFvMesh.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 | Copyright (C) 2011 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::mixerFvMesh
26 
27 Description
28  A rotating slider mesh
29 
30 SourceFiles
31  mixerFvMesh.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef mixerFvMesh_H
36 #define mixerFvMesh_H
37 
38 #include "topoChangerFvMesh.H"
39 #include "cylindricalCS.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // Forward declaration of classes
47 
48 /*---------------------------------------------------------------------------*\
49  Class mixerFvMesh Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class mixerFvMesh
53 :
54  public topoChangerFvMesh
55 {
56  // Private data
57 
58  //- Motion dictionary
60 
61  //- Coordinate system
63 
64  // - Rotational speed in rotations per minute (rpm)
65  scalar rpm_;
66 
67  //- Markup field for points. Moving points marked with 1
69 
70 
71  // Private Member Functions
72 
73  //- Disallow default bitwise copy construct
74  mixerFvMesh(const mixerFvMesh&);
75 
76  //- Disallow default bitwise assignment
77  void operator=(const mixerFvMesh&);
78 
79 
80  //- Add mixer zones and modifiers
81  void addZonesAndModifiers();
82 
83  //- Calculate moving masks
84  void calcMovingMasks() const;
85 
86  //- Return moving points mask
87  const scalarField& movingPointsMask() const;
88 
89 
90 public:
91 
92  //- Runtime type information
93  TypeName("mixerFvMesh");
94 
95 
96  // Constructors
97 
98  //- Construct from IOobject
99  explicit mixerFvMesh(const IOobject& io);
100 
101 
102  //- Destructor
103  virtual ~mixerFvMesh();
104 
105 
106  // Member Functions
107 
108  //- Return coordinate system
109  const coordinateSystem& cs() const
110  {
111  return csPtr_();
112  }
113 
114  //- Update the mesh for both mesh motion and topology change
115  virtual bool update();
116 };
117 
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 } // End namespace Foam
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 #endif
126 
127 // ************************************************************************* //
Foam::mixerFvMesh::cs
const coordinateSystem & cs() const
Return coordinate system.
Definition: mixerFvMesh.H:108
Foam::IOobject
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
Foam::mixerFvMesh::mixerFvMesh
mixerFvMesh(const mixerFvMesh &)
Disallow default bitwise copy construct.
topoChangerFvMesh.H
Foam::mixerFvMesh::rpm_
scalar rpm_
Definition: mixerFvMesh.H:64
Foam::mixerFvMesh::addZonesAndModifiers
void addZonesAndModifiers()
Add mixer zones and modifiers.
Definition: mixerFvMesh.C:45
Foam::mixerFvMesh::TypeName
TypeName("mixerFvMesh")
Runtime type information.
Foam::mixerFvMesh
A rotating slider mesh.
Definition: mixerFvMesh.H:51
Foam::Field
Pre-declare SubField and related Field type.
Definition: Field.H:57
Foam::mixerFvMesh::operator=
void operator=(const mixerFvMesh &)
Disallow default bitwise assignment.
cylindricalCS.H
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
Foam::mixerFvMesh::movingPointsMask
const scalarField & movingPointsMask() const
Return moving points mask.
Definition: mixerFvMesh.C:328
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::mixerFvMesh::update
virtual bool update()
Update the mesh for both mesh motion and topology change.
Definition: mixerFvMesh.C:339
Foam::autoPtr
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
Foam::mixerFvMesh::movingPointsMaskPtr_
scalarField * movingPointsMaskPtr_
Markup field for points. Moving points marked with 1.
Definition: mixerFvMesh.H:67
Foam::topoChangerFvMesh
Abstract base class for a topology changing fvMesh.
Definition: topoChangerFvMesh.H:50
Foam::mixerFvMesh::csPtr_
autoPtr< coordinateSystem > csPtr_
Coordinate system.
Definition: mixerFvMesh.H:61
Foam::mixerFvMesh::calcMovingMasks
void calcMovingMasks() const
Calculate moving masks.
Definition: mixerFvMesh.C:195
Foam::mixerFvMesh::~mixerFvMesh
virtual ~mixerFvMesh()
Destructor.
Definition: mixerFvMesh.C:320
Foam::coordinateSystem
Base class for other coordinate system specifications.
Definition: coordinateSystem.H:85
Foam::mixerFvMesh::motionDict_
dictionary motionDict_
Motion dictionary.
Definition: mixerFvMesh.H:58