/usr/include/XdmfRectilinearGrid.hpp is in libxdmf-dev 3.0+git20160803-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 | /*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfRectilinearGrid.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 XDMFRECTILINEARGRID_HPP_
#define XDMFRECTILINEARGRID_HPP_
// C Compatible Includes
#include "Xdmf.hpp"
#include "XdmfGrid.hpp"
#ifdef __cplusplus
// Forward Declarations
class XdmfArray;
/**
* @brief A rectilinear grid consists of cells and points arranged on
* a regular lattice in space.
*
* XdmfRectilinearGrid represents a mesh of cells and points arranged
* on a regular lattice in space. Points are arranged along coordinate
* axes, but the spacing between points may vary.
*
* In order to define a rectilinear grid, the coordinates along each
* axis direction must be specified.
*
*/
class XDMF_EXPORT XdmfRectilinearGrid : public XdmfGrid {
public:
/**
* Create a new rectilinear grid (Two dimensional).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRectilinearGrid.cpp
* @skipline //#initvalues
* @until //#initvalues
* @skipline //#initialization2
* @until //#initialization2
*
* Python
*
* @dontinclude XdmfExampleRectilinearGrid.py
* @skipline #//initvalues
* @until #//initvalues
* @skipline #//initialization2
* @until #//initialization2
*
* @param xCoordinates The coordinates of points along the x axis
* @param yCoordinates The coordinates of points along the y axis.
*
* @return Constructed rectilinear grid.
*/
static shared_ptr<XdmfRectilinearGrid>
New(const shared_ptr<XdmfArray> xCoordinates,
const shared_ptr<XdmfArray> yCoordinates);
/**
* Create a new rectilinear grid (Three dimensional).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRectilinearGrid.cpp
* @skipline //#initvalues
* @until //#initvalues
* @skipline //#initialization3
* @until //#initialization3
*
* Python
*
* @dontinclude XdmfExampleRectilinearGrid.py
* @skipline #//initvalues
* @until #//initvalues
* @skipline #//initialization3
* @until #//initialization3
*
* @param xCoordinates The coordinates of points along the x axis
* @param yCoordinates The coordinates of points along the y axis.
* @param zCoordinates The coordinates of points along the z axis.
*
* @return Constructed rectilinear grid.
*/
static shared_ptr<XdmfRectilinearGrid>
New(const shared_ptr<XdmfArray> xCoordinates,
const shared_ptr<XdmfArray> yCoordinates,
const shared_ptr<XdmfArray> zCoordinates);
/**
* Create a new rectilinear grid (N dimensional).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRectilinearGrid.cpp
* @skipline //#initvalues
* @until //#initvalues
* @skipline //#initializationvector
* @until //#initializationvector
*
* Python
*
* @dontinclude XdmfExampleRectilinearGrid.py
* @skipline #//initvalues
* @until #//initvalues
* @skipline #//initializationvector
* @until #//initializationvector
*
* @param axesCoordinates The coordinates of points along each axis.
*
* @return Constructed rectilinear grid.
*/
static shared_ptr<XdmfRectilinearGrid>
New(const std::vector<shared_ptr<XdmfArray> > & axesCoordinates);
virtual ~XdmfRectilinearGrid();
LOKI_DEFINE_VISITABLE(XdmfRectilinearGrid, XdmfGrid)
static const std::string ItemTag;
/**
* Get the coordinates of the grid along a single axis.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRectilinearGrid.cpp
* @skipline //#initvalues
* @until //#initvalues
* @skipline //#initialization2
* @until //#initialization2
* @skipline //#getCoodinatessingle
* @until //#getCoodinatessingle
*
* Python
*
* @dontinclude XdmfExampleRectilinearGrid.py
* @skipline #//initvalues
* @until #//initvalues
* @skipline #//initialization2
* @until #//initialization2
* @skipline #//getCoodinatessingle
* @until #//getCoodinatessingle
*
* @param axisIndex The index of the axis to retrieve, (i.e. 0 for
* x-axis). If no array exists at the index,
* return NULL.
*
* @return Array of coordinates along requested axis
*/
shared_ptr<XdmfArray> getCoordinates(const unsigned int axisIndex);
/**
* Get the coordinates of the grid along a single axis (const
* version).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRectilinearGrid.cpp
* @skipline //#initvalues
* @until //#initvalues
* @skipline //#initialization2
* @until //#initialization2
* @skipline //#getCoodinatessingleconst
* @until //#getCoodinatessingleconst
*
* Python: does not support a constant version of this function
*
* @param axisIndex The index of the axis to retrieve (i.e. 0 for
* x-axis). If no array exists at the index,
* return NULL.
*
* @return Array of coordinates along requeste axis
*/
shared_ptr<const XdmfArray>
getCoordinates(const unsigned int axisIndex) const;
/**
* Get the coordinates of the grid along all axes.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRectilinearGrid.cpp
* @skipline //#initvalues
* @until //#initvalues
* @skipline //#initializationvector
* @until //#initializationvector
* @skipline //#getCoodinatesvector
* @until //#getCoodinatesvector
*
* Python
*
* @dontinclude XdmfExampleRectilinearGrid.py
* @skipline #//initvalues
* @until #//initvalues
* @skipline #//initializationvector
* @until #//initializationvector
* @skipline #//getCoodinatesvector
* @until #//getCoodinatesvector
*
* @return Vector containing an array of coordinates along each
* direction.
*/
std::vector<shared_ptr<XdmfArray> > getCoordinates();
/**
* Get the coordinates of the grid along all axes (const version).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRectilinearGrid.cpp
* @skipline //#initvalues
* @until //#initvalues
* @skipline //#initializationvector
* @until //#initializationvector
* @skipline //#getCoodinatesvectorconst
* @until //#getCoodinatesvectorconst
*
* Python: does not support a constant version of this function
*
* @return Vector containing an array of coordinates along each
* direction.
*/
const std::vector<shared_ptr<XdmfArray> > getCoordinates() const;
/**
* Get the dimensions of the grid, the number of points in each
* direction.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRectilinearGrid.cpp
* @skipline //#initvalues
* @until //#initvalues
* @skipline //#initializationvector
* @until //#initializationvector
* @skipline //#getDimensions
* @until //#getDimensions
*
* Python
*
* @dontinclude XdmfExampleRectilinearGrid.py
* @skipline #//initvalues
* @until #//initvalues
* @skipline #//initializationvector
* @until #//initializationvector
* @skipline #//getDimensions
* @until #//getDimensions
*
* @return XdmfArray containing dimensions of this grid.
*/
shared_ptr<XdmfArray> getDimensions();
/**
* Get the dimensions of the grid, the number of points in each
* direction (const version).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRectilinearGrid.cpp
* @skipline //#initvalues
* @until //#initvalues
* @skipline //#initializationvector
* @until //#initializationvector
* @skipline //#getDimensionsconst
* @until //#getDimensionsconst
*
* Python: Doesn't support a constant version of this function
*
* @return XdmfArray containing the dimensions of this grid.
*/
shared_ptr<const XdmfArray> getDimensions() const;
virtual void read();
virtual void release();
/**
* Set the coordinates of the grid along a single axis.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRectilinearGrid.cpp
* @skipline //#initvalues
* @until //#initvalues
* @skipline //#initialization3
* @until //#initialization3
* @skipline //#setCoordinatessingle
* @until //#setCoordinatessingle
*
* Python
*
* @dontinclude XdmfExampleRectilinearGrid.py
* @skipline #//initvalues
* @until #//initvalues
* @skipline #//initialization3
* @until #//initialization3
* @skipline #//setCoordinatessingle
* @until #//setCoordinatessingle
*
* @param axisIndex The index of the axis to set
* (i.e. 0 for x-axis).
* @param axisCoordinates The coordinates of points along
* a single axis to set.
*/
void setCoordinates(const unsigned int axisIndex,
const shared_ptr<XdmfArray> axisCoordinates);
/**
* Set the coordinates of the grid along all axes.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRectilinearGrid.cpp
* @skipline //#initvalues
* @until //#initvalues
* @skipline //#initializationvector
* @until //#initializationvector
* @skipline //#setCoordinatesvector
* @until //#setCoordinatesvector
*
* Python
*
* @dontinclude XdmfExampleRectilinearGrid.py
* @skipline #//initvalues
* @until #//initvalues
* @skipline #//initializationvector
* @until #//initializationvector
* @skipline #//setCoordinatesvector
* @until #//setCoordinatesvector
*
* @param axesCoordinates The coordinates of points
* along each axis.
*/
void
setCoordinates(const std::vector<shared_ptr<XdmfArray> > axesCoordinates);
XdmfRectilinearGrid(XdmfRectilinearGrid &);
protected:
XdmfRectilinearGrid(const std::vector<shared_ptr<XdmfArray> > & axesCoordinates);
void copyGrid(shared_ptr<XdmfGrid> sourceGrid);
void populateItem(const std::map<std::string, std::string> & itemProperties,
const std::vector<shared_ptr<XdmfItem> > & childItems,
const XdmfCoreReader * const reader);
private:
/**
* PIMPL
*/
class XdmfRectilinearGridImpl;
XdmfRectilinearGrid(const XdmfRectilinearGrid &); // Not implemented.
void operator=(const XdmfRectilinearGrid &); // Not implemented.
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
struct XDMFRECTILINEARGRID; // Simply as a typedef to ensure correct typing
typedef struct XDMFRECTILINEARGRID XDMFRECTILINEARGRID;
XDMF_EXPORT XDMFRECTILINEARGRID * XdmfRectilinearGridNew(XDMFARRAY ** axesCoordinates, unsigned int numCoordinates, int passControl);
XDMF_EXPORT XDMFRECTILINEARGRID * XdmfRectilinearGridNew2D(XDMFARRAY * xCoordinates, XDMFARRAY * yCoordinates, int passControl);
XDMF_EXPORT XDMFRECTILINEARGRID * XdmfRectilinearGridNew3D(XDMFARRAY * xCoordinates, XDMFARRAY * yCoordinates, XDMFARRAY * zCoordinates, int passControl);
XDMF_EXPORT XDMFARRAY * XdmfRectilinearGridGetCoordinatesByIndex(XDMFRECTILINEARGRID * grid, unsigned int axisIndex, int * status);
XDMF_EXPORT XDMFARRAY ** XdmfRectilinearGridGetCoordinates(XDMFRECTILINEARGRID * grid, int * status);
XDMF_EXPORT int XdmfRectilinearGridGetNumberCoordinates(XDMFRECTILINEARGRID * grid, int * status);
XDMF_EXPORT XDMFARRAY * XdmfRectilinearGridGetDimensions(XDMFRECTILINEARGRID * grid, int * status);
XDMF_EXPORT void XdmfRectilinearGridSetCoordinates(XDMFRECTILINEARGRID * grid, XDMFARRAY ** axesCoordinates, unsigned int numCoordinates, int passControl, int * status);
XDMF_EXPORT void XdmfRectilinearGridSetCoordinatesByIndex(XDMFRECTILINEARGRID * grid, unsigned int index, XDMFARRAY * coordinates, int passControl, int * status);
XDMF_ITEM_C_CHILD_DECLARE(XdmfRectilinearGrid, XDMFRECTILINEARGRID, XDMF)
XDMF_GRID_C_CHILD_DECLARE(XdmfRectilinearGrid, XDMFRECTILINEARGRID, XDMF)
#ifdef __cplusplus
}
#endif
#endif /* XDMFRECTILINEARGRID_HPP_ */
|