geometrySurface.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) 2015 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::geometrySurface
26 
27 Description
28 
29 SourceFiles
30  geometrySurface.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef geometrySurface_H
35 #define geometrySurface_H
36 
37 #include "surface.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 class vtkPolyData;
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class geometrySurface Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class geometrySurface
51 :
52  public surface
53 {
54 private:
55 
56  // Private Member Functions
57 
58  //- Disallow default bitwise copy construct
60 
61  //- Disallow default bitwise assignment
62  void operator=(const geometrySurface&);
63 
64 
65 protected:
66 
67  // Protected data
68 
69  //- File names
71 
72 
73  // Protected Member Functions
74 
75  //- Add surface (file) to scene
77  (
78  const scalar position,
79  vtkRenderer* renderer,
80  const fileName& fName
81  ) const;
82 
83 
84 public:
85 
86  //- Run-time type information
87  TypeName("geometry");
88 
89 
90  // Constructors
91 
92  //- Construct from dictionary
94  (
96  const dictionary& dict,
98  );
99 
100  //- Construct from components
102  (
104  const dictionary& dict,
106  const List<fileName>& fileNames
107  );
108 
109 
110  //- Destructor
111  virtual ~geometrySurface();
112 
113 
114  // Member Functions
115 
116  //- Add surface(s) to scene
117  virtual void addGeometryToScene
118  (
119  const scalar position,
120  vtkRenderer* renderer
121  );
122 
123  //- Update actors
124  virtual void updateActors(const scalar position);
125 };
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace Foam
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #endif
135 
136 // ************************************************************************* //
surface.H
Foam::word
A class for handling words, derived from string.
Definition: word.H:59
Foam::fileName
A class for handling file names.
Definition: fileName.H:69
Foam::geometrySurface::fileNames_
List< fileName > fileNames_
File names.
Definition: geometrySurface.H:69
Foam::geometrySurface::addGeometryToScene
void addGeometryToScene(const scalar position, vtkRenderer *renderer, const fileName &fName) const
Add surface (file) to scene.
Definition: geometrySurface.C:59
Foam::runTimePostProcessing
Function object to generate images during run-time.
Definition: runTimePostProcessing.H:83
Foam::geometrySurface
Definition: geometrySurface.H:49
Foam::geometrySurface::~geometrySurface
virtual ~geometrySurface()
Destructor.
Definition: geometrySurface.C:162
Foam::geometrySurface::geometrySurface
geometrySurface(const geometrySurface &)
Disallow default bitwise copy construct.
Foam::geometrySurface::operator=
void operator=(const geometrySurface &)
Disallow default bitwise assignment.
Foam::geometryBase::colours
const HashPtrTable< DataEntry< vector >, word > & colours() const
Return reference to the colours.
Definition: geometryBase.C:143
Foam::geometrySurface::TypeName
TypeName("geometry")
Run-time type information.
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::geometryBase::parent
const runTimePostProcessing & parent() const
Return the reference to the parent function object.
Definition: geometryBase.C:118
Foam::HashPtrTable
A HashTable specialization for hashing pointers.
Definition: HashPtrTable.H:50
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
Foam::surface
Definition: surface.H:55
Foam::geometrySurface::updateActors
virtual void updateActors(const scalar position)
Update actors.
Definition: geometrySurface.C:187
Foam::DataEntry
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: DataEntry.H:52