/usr/include/XdmfCurvilinearGrid.hpp is in libxdmf-dev 3.0+git20160803-3.
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 | /*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfCurvilinearGrid.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 XDMFCURVILINEARGRID_HPP_
#define XDMFCURVILINEARGRID_HPP_
// C Compatible Includes
#include "Xdmf.hpp"
#include "XdmfGrid.hpp"
#ifdef __cplusplus
// Forward Declarations
class XdmfArray;
/**
* @brief A curvilinear (or structured) grid consisting of cells and
* points arranged on a regular lattice in space.
*
* XdmfCurvilinearGrid represents a mesh of cells and points arranged
* with regular topology and irregular geometry.
*
* In order to define a curvilinear grid, the dimensions of the grid
* must be supplied along with the coordinates of each point.
*
*/
class XDMF_EXPORT XdmfCurvilinearGrid : public XdmfGrid {
public:
/**
* Create a new curvilinear grid (Two dimensional).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline //#initializationdim2
* @until //#initializationdim2
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//constructor2
* @until #//constructor2
*
* @param xNumPoints The number of points in the x direction.
* @param yNumPoints The number of points in the y direction.
*
* @return Constructed curvilinear grid.
*/
static shared_ptr<XdmfCurvilinearGrid>
New(const unsigned int xNumPoints,
const unsigned int yNumPoints);
/**
* Create a new curvilinear grid (Three dimensional).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline //#initializationdim3
* @until //#initializationdim3
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//constructor3
* @until #//constructor3
*
* @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.
*
* @return Constructed curvilinear grid.
*/
static shared_ptr<XdmfCurvilinearGrid>
New(const unsigned int xNumPoints,
const unsigned int yNumPoints,
const unsigned int zNumPoints);
/**
* Create a new curvilinear grid (N dimensional).
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline //#initializationvector
* @until //#initializationvector
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
*
* @param numPoints The number of points in each direction.
*
* @return Constructed curvilinear grid.
*/
static shared_ptr<XdmfCurvilinearGrid>
New(const shared_ptr<XdmfArray> numPoints);
virtual ~XdmfCurvilinearGrid();
LOKI_DEFINE_VISITABLE(XdmfCurvilinearGrid, XdmfGrid)
static const std::string ItemTag;
/**
* Get the dimensions of the grid, the number of points in each
* direction.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline //#initializationdim3
* @until //#initializationdim3
* @skipline //#setDimensions
* @until //#setDimensions
* @skipline //#getDimensions
* @until //#getDimensions
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
* @skipline #//setDimensions
* @until #//setDimensions
* @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 ExampleXdmfCurvilinearGrid.cpp
* @skipline //#initializationdim3
* @until //#initializationdim3
* @skipline //#setDimensions
* @until //#setDimensions
* @skipline //#getDimensionsconst
* @until //#getDimensionsconst
*
* Python: Python doesn't have a constant version
*
* @return XdmfArray containing the dimensions of this grid.
*/
shared_ptr<const XdmfArray> getDimensions() const;
/**
* Get the geometry associated with this grid.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline //#initializationdim3
* @until //#initializationdim3
* @skipline //#setGeometry
* @until //#setGeometry
* @skipline //#getGeometry
* @until //#getGeometry
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
* @skipline #//setGeometry
* @until #//setGeometry
* @skipline #//getGeometry
* @until #//getGeometry
*
* @return The geometry associated with this grid.
*/
shared_ptr<XdmfGeometry> getGeometry();
using XdmfGrid::getGeometry;
virtual void read();
virtual void release();
/**
* Set the dimensions of the grid, the number of points in each
* direction.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline //#initializationdim3
* @until //#initializationdim3
* @skipline //#setDimensions
* @until //#setDimensions
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
* @skipline #//setDimensions
* @until #//setDimensions
*
* @param dimensions The dimension of the grid.
*/
void setDimensions(const shared_ptr<XdmfArray> dimensions);
/**
* Set the geometry associated with this grid.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline //#initializationdim3
* @until //#initializationdim3
* @skipline //#setGeometry
* @until //#setGeometry
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
* @skipline #//setGeometry
* @until #//setGeometry
*
* @param geometry An XdmfGeometry to associate with this grid.
*/
void setGeometry(const shared_ptr<XdmfGeometry> geometry);
XdmfCurvilinearGrid(XdmfCurvilinearGrid &);
protected:
XdmfCurvilinearGrid(const shared_ptr<XdmfArray> numPoints);
void
populateItem(const std::map<std::string, std::string> & itemProperties,
const std::vector<shared_ptr<XdmfItem> > & childItems,
const XdmfCoreReader * const reader);
private:
/**
* PIMPL
*/
class XdmfCurvilinearGridImpl;
XdmfCurvilinearGrid(const XdmfCurvilinearGrid &); // Not implemented.
void operator=(const XdmfCurvilinearGrid &); // Not implemented.
void
copyGrid(shared_ptr<XdmfGrid> sourceGrid);
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
struct XDMFCURVILINEARGRID; // Simply as a typedef to ensure correct typing
typedef struct XDMFCURVILINEARGRID XDMFCURVILINEARGRID;
XDMF_EXPORT XDMFCURVILINEARGRID * XdmfCurvilinearGridNew2D(unsigned int xNumPoints,
unsigned int yNumPoints);
XDMF_EXPORT XDMFCURVILINEARGRID * XdmfCurvilinearGridNew3D(unsigned int xNumPoints,
unsigned int yNumPoints,
unsigned int zNumPoints);
XDMF_EXPORT XDMFCURVILINEARGRID * XdmfCurvilinearGridNew(XDMFARRAY * numPoints, int * status);
XDMF_EXPORT XDMFARRAY * XdmfCurvilinearGridGetDimensions(XDMFCURVILINEARGRID * grid, int * status);
XDMF_EXPORT XDMFGEOMETRY * XdmfCurvilinearGridGetGeometry(XDMFCURVILINEARGRID * grid);
XDMF_EXPORT void XdmfCurvilinearGridSetDimensions(XDMFCURVILINEARGRID * grid, XDMFARRAY * dimensions, int passControl, int * status);
XDMF_EXPORT void XdmfCurvilinearGridSetGeometry(XDMFCURVILINEARGRID * grid, XDMFGEOMETRY * geometry, int passControl);
XDMF_ITEM_C_CHILD_DECLARE(XdmfCurvilinearGrid, XDMFCURVILINEARGRID, XDMF)
XDMF_GRID_C_CHILD_DECLARE(XdmfCurvilinearGrid, XDMFCURVILINEARGRID, XDMF)
#ifdef __cplusplus
}
#endif
#endif /* XDMFCURVILINEARGRID_HPP_ */
|