/usr/include/XdmfRegularGrid.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 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 | /*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfRegularGrid.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 XDMFREGULARGRID_HPP_
#define XDMFREGULARGRID_HPP_
// C Compatible Includes
#include "Xdmf.hpp"
#include "XdmfGrid.hpp"
#ifdef __cplusplus
// Forward Declarations
class XdmfArray;
/**
* @brief A regular grid consists of congruent points arranged
* regularly in space.
*
* XdmfRegularGrid represents a regular mesh of congruent points
* arranged in space. In order to define a regular grid, three sets of
* terms need to be supplied:
*
* Brick Size (Dx, Dy, (Dz)) - Size of an individual brick.
* Dimensions (X, Y, (Z)) - Number of points in X, Y, and Z directions
* Origin Location (X, Y, (Z)) - Location of the origin of the mesh in space.
*/
class XDMF_EXPORT XdmfRegularGrid : public XdmfGrid {
public:
/**
* Create a new structured grid (Two dimensional).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRegularGrid.cpp
* @skipline //#initvalue
* @until //#initvalue
* @skipline //#initialization2
* @until //#initialization2
*
* Python
*
* @dontinclude XdmfExampleRegularGrid.py
* @skipline #//initvalue
* @until #//initvalue
* @skipline #//initialization2
* @until #//initialization2
*
* @param xBrickSize The size of the brick in the x direction.
* @param yBrickSize The size of the brick in the y direction.
* @param xNumPoints The number of points in the x direction.
* @param yNumPoints The number of points in the y direction.
* @param xOrigin The x coordinate of the origin.
* @param yOrigin The y coordinate of the origin.
*
* @return Constructed structured grid.
*/
static shared_ptr<XdmfRegularGrid> New(const double xBrickSize,
const double yBrickSize,
const unsigned int xNumPoints,
const unsigned int yNumPoints,
const double xOrigin,
const double yOrigin);
/**
* Create a new structured grid (Three dimensional).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRegularGrid.cpp
* @skipline //#initvalue
* @until //#initvalue
* @skipline //#initialization3
* @until //#initialization3
*
* Python
*
* @dontinclude XdmfExampleRegularGrid.py
* @skipline #//initvalue
* @until #//initvalue
* @skipline #//initialization3
* @until #//initialization3
*
* @param xBrickSize The size of the brick in the x direction.
* @param yBrickSize The size of the brick in the y direction.
* @param zBrickSize The size of the brick in the z direction.
* @param xNumPoints The number of points in the x direction.
* @param yNumPoints The number of points in the y direction.
* @param zNumPoints The number of points in the z direction.
* @param xOrigin The x coordinate of the origin.
* @param yOrigin The y coordinate of the origin.
* @param zOrigin The z coordinate of the origin.
*
* @return Constructed structured grid.
*/
static shared_ptr<XdmfRegularGrid> New(const double xBrickSize,
const double yBrickSize,
const double zBrickSize,
const unsigned int xNumPoints,
const unsigned int yNumPoints,
const unsigned int zNumPoints,
const double xOrigin,
const double yOrigin,
const double zOrigin);
/**
* Create a new structured grid (N dimensional).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRegularGrid.cpp
* @skipline //#initializationvector
* @until //#initializationvector
*
* Python
*
* @dontinclude XdmfExampleRegularGrid.py
* @skipline #//initializationvector
* @until #//initializationvector
*
* @param brickSize The size of the brick in each direction.
* @param numPoints The number of points in each direction.
* @param origin The coordinates of the origin.
*
* @return Constructed structured grid.
*/
static shared_ptr<XdmfRegularGrid>
New(const shared_ptr<XdmfArray> brickSize,
const shared_ptr<XdmfArray> numPoints,
const shared_ptr<XdmfArray> origin);
virtual ~XdmfRegularGrid();
LOKI_DEFINE_VISITABLE(XdmfRegularGrid, XdmfGrid)
static const std::string ItemTag;
/**
* Get the size of the bricks composing the grid.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRegularGrid.cpp
* @skipline //#initvalue
* @until //#initvalue
* @skipline //#initialization2
* @until //#initialization2
* @skipline //#getBrickSize
* @until //#getBrickSize
*
* Python
*
* @dontinclude XdmfExampleRegularGrid.py
* @skipline #//initvalue
* @until #//initvalue
* @skipline #//initialization2
* @until #//initialization2
* @skipline #//getBrickSize
* @until #//getBrickSize
*
* @return XdmfArray containing brick sizes for this grid.
*/
shared_ptr<XdmfArray> getBrickSize();
/**
* Get the size of the bricks composing the grid (const version).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRegularGrid.cpp
* @skipline //#initvalue
* @until //#initvalue
* @skipline //#initialization2
* @until //#initialization2
* @skipline //#getBrickSizeconst
* @until //#getBrickSizeconst
*
* Python: Does not support a constant version of this function
*
* @return XdmfArray containing brick sizes for this grid.
*/
shared_ptr<const XdmfArray> getBrickSize() const;
/**
* Get the dimensions of the grid, the number of points in each
* direction.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRegularGrid.cpp
* @skipline //#initvalue
* @until //#initvalue
* @skipline //#initialization2
* @until //#initialization2
* @skipline //#getDimensions
* @until //#getDimensions
*
* Python
*
* @dontinclude XdmfExampleRegularGrid.py
* @skipline #//initvalue
* @until #//initvalue
* @skipline #//initialization2
* @until #//initialization2
* @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 ExampleXdmfRegularGrid.cpp
* @skipline //#initvalue
* @until //#initvalue
* @skipline //#initialization2
* @until //#initialization2
* @skipline //#getDimensionsconst
* @until //#getDimensionsconst
*
* Python: Does not support a constant version of this function
*
* @return XdmfArray containing the dimensions of this grid.
*/
shared_ptr<const XdmfArray> getDimensions() const;
/**
* Get the location of the origin of the grid.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRegularGrid.cpp
* @skipline //#initvalue
* @until //#initvalue
* @skipline //#initialization2
* @until //#initialization2
* @skipline //#getOrigin
* @until //#getOrigin
*
* Python
*
* @dontinclude XdmfExampleRegularGrid.py
* @skipline #//initvalue
* @until #//initvalue
* @skipline #//initialization2
* @until #//initialization2
* @skipline #//getOrigin
* @until #//getOrigin
*
* @return XdmfArray containing the location of the origin of the
* grid.
*/
shared_ptr<XdmfArray> getOrigin();
/**
* Get the location of the origin of the grid.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRegularGrid.cpp
* @skipline //#initvalue
* @until //#initvalue
* @skipline //#initialization2
* @until //#initialization2
* @skipline //#getOriginconst
* @until //#getOriginconst
*
* Python: Does not support a constant version of this function
*
* @return XdmfArray containing the location of the origin of the
* grid (const version).
*/
shared_ptr<const XdmfArray> getOrigin() const;
virtual void read();
virtual void release();
/**
* Set the size of the points composing the grid.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRegularGrid.cpp
* @skipline //#initializationvector
* @until //#initializationvector
* @skipline //#setBrickSize
* @until //#setBrickSize
*
* Python
*
* @dontinclude XdmfExampleRegularGrid.py
* @skipline #//initializationvector
* @until #//initializationvector
* @skipline #//setBrickSize
* @until #//setBrickSize
*
* @param brickSize The sizes of the points composing the mesh. This
* should have the same number of terms as the
* dimensionality of the mesh.
*/
void setBrickSize(const shared_ptr<XdmfArray> brickSize);
/**
* Set the dimensions of the grid, the number of points in each
* direction.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRegularGrid.cpp
* @skipline //#initializationvector
* @until //#initializationvector
* @skipline //#setDimensions
* @until //#setDimensions
*
* Python
*
* @dontinclude XdmfExampleRegularGrid.py
* @skipline #//initializationvector
* @until #//initializationvector
* @skipline #//setDimensions
* @until #//setDimensions
*
* @param dimensions The dimension of the grid.
*/
void setDimensions(const shared_ptr<XdmfArray> dimensions);
/**
* Set the origin of the grid.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfRegularGrid.cpp
* @skipline //#initializationvector
* @until //#initializationvector
* @skipline //#setOrigin
* @until //#setOrigin
*
* Python
*
* @dontinclude XdmfExampleRegularGrid.py
* @skipline #//initializationvector
* @until #//initializationvector
* @skipline #//setOrigin
* @until #//setOrigin
*
* @param origin Location of the origin of the grid. This should
* have the same number of terms as the dimensionality
* of the mesh.
*/
void setOrigin(const shared_ptr<XdmfArray> origin);
XdmfRegularGrid(XdmfRegularGrid &);
protected:
XdmfRegularGrid(const shared_ptr<XdmfArray> brickSize,
const shared_ptr<XdmfArray> numPoints,
const shared_ptr<XdmfArray> origin);
virtual 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 XdmfRegularGridImpl;
XdmfRegularGrid(const XdmfRegularGrid &); // Not implemented.
void operator=(const XdmfRegularGrid &); // Not implemented.
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
struct XDMFREGULARGRID; // Simply as a typedef to ensure correct typing
typedef struct XDMFREGULARGRID XDMFREGULARGRID;
XDMF_EXPORT XDMFREGULARGRID * XdmfRegularGridNew2D(double xBrickSize,
double yBrickSize,
unsigned int xNumPoints,
unsigned int yNumPoints,
double xOrigin,
double yOrigin);
XDMF_EXPORT XDMFREGULARGRID * XdmfRegularGridNew3D(double xBrickSize,
double yBrickSize,
double zBrickSize,
unsigned int xNumPoints,
unsigned int yNumPoints,
unsigned int zNumPoints,
double xOrigin,
double yOrigin,
double zOrigin);
XDMF_EXPORT XDMFREGULARGRID * XdmfRegularGridNew(XDMFARRAY * brickSize,
XDMFARRAY * numPoints,
XDMFARRAY * origin,
int passControl);
XDMF_EXPORT XDMFARRAY * XdmfRegularGridGetBrickSize(XDMFREGULARGRID * grid, int * status);
XDMF_EXPORT XDMFARRAY * XdmfRegularGridGetDimensions(XDMFREGULARGRID * grid, int * status);
XDMF_EXPORT XDMFARRAY * XdmfRegularGridGetOrigin(XDMFREGULARGRID * grid, int * status);
XDMF_EXPORT void XdmfRegularGridSetBrickSize(XDMFREGULARGRID * grid, XDMFARRAY * brickSize, int passControl, int * status);
XDMF_EXPORT void XdmfRegularGridSetDimensions(XDMFREGULARGRID * grid, XDMFARRAY * dimensions, int passControl, int * status);
XDMF_EXPORT void XdmfRegularGridSetOrigin(XDMFREGULARGRID * grid, XDMFARRAY * origin, int passControl, int * status);
XDMF_ITEM_C_CHILD_DECLARE(XdmfRegularGrid, XDMFREGULARGRID, XDMF)
XDMF_GRID_C_CHILD_DECLARE(XdmfRegularGrid, XDMFREGULARGRID, XDMF)
#ifdef __cplusplus
}
#endif
#endif /* XDMFREGULARGRID_HPP_ */
|