1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfGridCollection.hpp */
/* */
/* Author: */
/* Kenneth Leiter */
/* kenneth.leiter@arl.army.mil */
/* US Army Research Laboratory */
/* Aberdeen Proving Ground, MD */
/* */
/* Copyright @ 2011 US Army Research Laboratory */
/* All Rights Reserved */
/* See Copyright.txt for details */
/* */
/* This software is distributed WITHOUT ANY WARRANTY; without */
/* even the implied warranty of MERCHANTABILITY or FITNESS */
/* FOR A PARTICULAR PURPOSE. See the above copyright notice */
/* for more information. */
/* */
/*****************************************************************************/
#ifndef XDMFGRIDCOLLECTION_HPP_
#define XDMFGRIDCOLLECTION_HPP_
// C Compatible Includes
#include "Xdmf.hpp"
#include "XdmfDomain.hpp"
#include "XdmfGrid.hpp"
#include "XdmfGridCollectionType.hpp"
#ifdef __cplusplus
/**
* @brief A spatial or temporal collection of XdmfGrids.
*
* A temporal collection is timestep data. Each child grid represents
* the state at a single timestep. A spatial collection consists of
* XdmfGrids that are arranged together in space. E.g. a partitioned
* mesh.
*
* It is valid to nest collections. A spatial collection inside a
* temporal collection is commonly used.
*/
class XDMF_EXPORT XdmfGridCollection : public virtual XdmfDomain,
public XdmfGrid {
public:
/**
* Create a new XdmfGridCollection.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfGridCollection.cpp
* @skipline //#initalization
* @until //#initalization
*
* Python
*
* @dontinclude XdmfExampleGridCollection.py
* @skipline #//initalization
* @until #//initalization
*
* @return Constructed XdmfGridCollection.
*/
static shared_ptr<XdmfGridCollection> New();
virtual ~XdmfGridCollection();
LOKI_DEFINE_VISITABLE(XdmfGridCollection, XdmfGrid)
static const std::string ItemTag;
std::map<std::string, std::string> getItemProperties() const;
std::string getItemTag() const;
/**
* Get the XdmfGridCollectionType associated with this grid collection.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfGridCollection.cpp
* @skipline //#initalization
* @until //#initalization
* @skipline //#getType
* @until //#getType
*
* Python
*
* @dontinclude XdmfExampleGridCollection.py
* @skipline #//initalization
* @until #//initalization
* @skipline #//getType
* @until #//getType
*
* @return XdmfGridCollectionType of this collection.
*/
shared_ptr<const XdmfGridCollectionType> getType() const;
using XdmfDomain::insert;
using XdmfGrid::insert;
/**
* Insert an information into the grid collection.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfGridCollection.cpp
* @skipline //#initalization
* @until //#initalization
* @skipline //#insert
* @until //#insert
*
* Python
*
* @dontinclude XdmfExampleGridCollection.py
* @skipline #//initalization
* @until #//initalization
* @skipline #//insert
* @until #//insert
*
* @param information An XdmfInformation to attach to this item.
*/
void insert(const shared_ptr<XdmfInformation> information);
void read();
void release();
/**
* Set the XdmfGridCollectionType associated with this grid
* collection.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfGridCollection.cpp
* @skipline //#initalization
* @until //#initalization
* @skipline //#setType
* @until //#setType
*
* Python
*
* @dontinclude XdmfExampleGridCollection.py
* @skipline #//initalization
* @until #//initalization
* @skipline #//setType
* @until #//setType
*
* @param type The XdmfGridCollectionType to set.
*/
void setType(const shared_ptr<const XdmfGridCollectionType> type);
void traverse(const shared_ptr<XdmfBaseVisitor> visitor);
XdmfGridCollection(XdmfGridCollection &);
protected:
XdmfGridCollection();
virtual void
populateItem(const std::map<std::string, std::string> & itemProperties,
const std::vector<shared_ptr<XdmfItem> > & childItems,
const XdmfCoreReader * const reader);
void copyGrid(shared_ptr<XdmfGrid> sourceGrid);
private:
/**
* PIMPL
*/
class XdmfGridCollectionImpl;
XdmfGridCollection(const XdmfGridCollection &); // Not implemented.
void operator=(const XdmfGridCollection &); // Not implemented.
shared_ptr<const XdmfGridCollectionType> mType;
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
#ifndef XDMFGRIDCOLLECTIONCDEFINE
#define XDMFGRIDCOLLECTIONCDEFINE
struct XDMFGRIDCOLLECTION; // Simply as a typedef to ensure correct typing
typedef struct XDMFGRIDCOLLECTION XDMFGRIDCOLLECTION;
#endif
XDMF_EXPORT XDMFGRIDCOLLECTION * XdmfGridCollectionNew();
XDMF_EXPORT int XdmfGridCollectionGetType(XDMFGRIDCOLLECTION * collection, int * status);
XDMF_EXPORT void XdmfGridCollectionSetType(XDMFGRIDCOLLECTION * collection, int type, int * status);
XDMF_DOMAIN_C_CHILD_DECLARE(XdmfGridCollection, XDMFGRIDCOLLECTION, XDMF)
XDMF_GRID_C_CHILD_DECLARE(XdmfGridCollection, XDMFGRIDCOLLECTION, XDMF)
XDMF_ITEM_C_CHILD_DECLARE(XdmfGridCollection, XDMFGRIDCOLLECTION, XDMF)
#ifdef __cplusplus
}
#endif
#endif /* XDMFGRID_HPP_ */
|
