/[escript]/trunk/tools/libescriptreader/src/escriptreader/MeshWithElements.h
ViewVC logotype

Contents of /trunk/tools/libescriptreader/src/escriptreader/MeshWithElements.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2206 - (show annotations)
Fri Jan 9 03:50:29 2009 UTC (12 years, 5 months ago) by caltinay
File MIME type: text/plain
File size: 2246 byte(s)
Added some more doxygen docu to escriptreader classes.

1
2 /*******************************************************
3 *
4 * Copyright (c) 2003-2008 by University of Queensland
5 * Earth Systems Science Computational Center (ESSCC)
6 * http://www.uq.edu.au/esscc
7 *
8 * Primary Business: Queensland, Australia
9 * Licensed under the Open Software License version 3.0
10 * http://www.opensource.org/licenses/osl-3.0.php
11 *
12 *******************************************************/
13
14 //
15 // MeshWithElements.h
16 //
17 #ifndef __MESHWITHELEMENTS_H__
18 #define __MESHWITHELEMENTS_H__
19
20 #include <escriptreader/Mesh.h>
21
22 class DBfile;
23
24 namespace EscriptReader {
25
26 class ElementData;
27
28 /// \brief A full escript domain including elements.
29 ///
30 /// This class represents a mesh including cells, faces, contact elements and
31 /// points if applicable.
32 class MeshWithElements : public Mesh
33 {
34 public:
35 /// \brief Default constructor.
36 MeshWithElements();
37
38 /// \brief Copy constructor.
39 MeshWithElements(const MeshWithElements& m);
40
41 /// \brief Virtual destructor.
42 virtual ~MeshWithElements();
43
44 virtual bool readFromNc(const std::string& filename);
45 virtual void handleGhostZones(int ownIndex);
46 virtual void removeGhostZones();
47 virtual bool writeToSilo(DBfile* dbfile, const std::string& pathInSilo);
48
49 /// \brief
50 StringVec getMeshNames() const;
51
52 /// \brief
53 StringVec getVarNames() const;
54
55 /// \brief
56 ElementData* getElementsByName(const std::string name) const;
57
58 /// \brief
59 Mesh* getMeshByName(const std::string name) const;
60
61 /// \brief
62 const IntVec& getVarDataByName(const std::string name) const;
63
64 /// \brief Returns a pointer to the elements.
65 ElementData* getElements() { return cells; }
66
67 /// \brief Returns a pointer to the face elements.
68 ElementData* getFaceElements() { return faces; }
69
70 /// \brief Returns a pointer to the contact elements.
71 ElementData* getContactElements() { return contacts; }
72
73 /// \brief Returns a pointer to the point "elements".
74 ElementData* getPoints() { return points; }
75
76 private:
77 IntVec nodeTag, nodeGDOF, nodeGNI, nodeGRDFI, nodeGRNI;
78 ElementData* cells;
79 ElementData* faces;
80 ElementData* contacts;
81 ElementData* points;
82 };
83
84 } // namespace EscriptReader
85
86 #endif // __MESHWITHELEMENTS_H__
87

  ViewVC Help
Powered by ViewVC 1.1.26