XdmfGeometry.hpp 7.28 KB
Newer Older
Kenneth Leiter's avatar
Kenneth Leiter committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*****************************************************************************/
/*                                    XDMF                                   */
/*                       eXtensible Data Model and Format                    */
/*                                                                           */
/*  Id : XdmfGeometry.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.                                                 */
/*                                                                           */
/*****************************************************************************/

Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
24 25 26
#ifndef XDMFGEOMETRY_HPP_
#define XDMFGEOMETRY_HPP_

27
// C Compatible Includes
28
#include "Xdmf.hpp"
29
#include "XdmfArray.hpp"
30 31 32
#include "XdmfGeometryType.hpp"

#ifdef __cplusplus
33

34 35 36
/**
 * @brief Handles the coordinate positions of points in an XdmfGrid.
 *
37 38 39 40
 * XdmfGeometry is a required part of an XdmfGrid. It stores the
 * coordinate locations of all points contained in an
 * XdmfGrid. XdmfGeometry contains an XdmfGeometryType property which
 * should be set that specifies the types of coordinate values stored.
41
 */
42
class XDMF_EXPORT XdmfGeometry : public XdmfArray {
Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
43

44
public:
Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
45

46 47 48
  /**
   * Create a new XdmfGeometry.
   *
49 50 51 52
   * Example of use:
   *
   * C++
   *
53
   * @dontinclude ExampleXdmfGeometry.cpp
54 55
   * @skipline //#initialization
   * @until //#initialization
56 57 58
   *
   * Python
   *
59
   * @dontinclude XdmfExampleGeometry.py
60 61
   * @skipline #//initialization
   * @until #//initialization
62
   *
63
   * @return    Constructed XdmfGeometry.
64
   */
65
  static shared_ptr<XdmfGeometry> New();
66

67
  virtual ~XdmfGeometry();
68

69
  LOKI_DEFINE_VISITABLE(XdmfGeometry, XdmfArray)
70
  static const std::string ItemTag;
71

72
  std::map<std::string, std::string> getItemProperties() const;
73

74
  std::string getItemTag() const;
75

76 77
  /**
   * Get the number of points stored in this geometry.
78 79 80 81 82
   *
   * Example of use:
   *
   * C++
   *
83
   * @dontinclude ExampleXdmfGeometry.cpp
84 85 86 87
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#getNumberPoints
   * @until //#getNumberPoints
88 89 90
   *
   * Python
   *
91
   * @dontinclude XdmfExampleGeometry.py
92 93 94 95
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//getNumberPoints
   * @until #//getNumberPoints
96 97
   */
  virtual unsigned int getNumberPoints() const;
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
  /**
   * Gets the origin of the geometry. This value defaults to (0, 0, 0)
   *
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfGeometry.cpp
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#getOrigin
   * @until //#getOrigin
   *
   * Python
   *
   * @dontinclude XdmfExampleGeometry.py
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//getOrigin
   * @until #//getOrigin
   *
   * @return    A vector containing the current location
   *            of the origin of this geometry
   */
  std::vector<double> getOrigin() const;

125 126 127
  /**
   * Get the XdmfGeometryType associated with this geometry.
   *
128 129 130 131
   * Example of use:
   *
   * C++
   *
132
   * @dontinclude ExampleXdmfGeometry.cpp
133 134 135 136
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#getType
   * @until //#getType
137 138 139
   *
   * Python
   *
140
   * @dontinclude XdmfExampleGeometry.py
141 142 143 144
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//getType
   * @until #//getType
145
   *
146
   * @return    XdmfGeometryType of this geometry.
147
   */
148
  shared_ptr<const XdmfGeometryType> getType() const;
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
  /**
   * Sets the origin of the geometry.
   *
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfGeometry.cpp
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setOrigin
   * @until //#setOrigin
   *
   * Python
   *
   * @dontinclude XdmfExampleGeometry.py
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setOrigin
   * @until #//setOrigin
   *
   * @param     newX    The new X value of the origin.
   * @param     newY    The new Y value of the origin.
   * @param     newZ    The new Z value of the origin.
   */
  void setOrigin(double newX, double newY, double newZ = 0.0);

  void setOrigin(std::vector<double> newOrigin);

179 180 181
  /**
   * Set the XdmfGeometryType associated with this geometry.
   *
182 183 184 185
   * Example of use:
   *
   * C++
   *
186
   * @dontinclude ExampleXdmfGeometry.cpp
187 188 189 190
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setType
   * @until //#setType
191 192 193
   *
   * Python
   *
194
   * @dontinclude XdmfExampleGeometry.py
195 196 197 198
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setType
   * @until #//setType
199
   *
200
   * @param     type    The XdmfGeometryType to set.
201
   */
202
  void setType(const shared_ptr<const XdmfGeometryType> type);
203

204 205
  XdmfGeometry(XdmfGeometry &);

206
protected:
Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
207

208
  XdmfGeometry();
Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
209

210 211
  virtual void
  populateItem(const std::map<std::string, std::string> & itemProperties,
212
               const std::vector<shared_ptr<XdmfItem> > & childItems,
213
               const XdmfCoreReader * const reader);
Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
214

215
private:
Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
216

217 218 219 220
  XdmfGeometry(const XdmfGeometry &);  // Not implemented.
  void operator=(const XdmfGeometry &);  // Not implemented.

  int mNumberPoints;
221
  shared_ptr<const XdmfGeometryType> mType;
222 223

  std::vector<double> mOrigin;
Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
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
#endif

#ifdef __cplusplus
extern "C" {
#endif

// C wrappers go here

struct XDMFGEOMETRY; // Simply as a typedef to ensure correct typing
typedef struct XDMFGEOMETRY XDMFGEOMETRY; 

XDMF_EXPORT XDMFGEOMETRY * XdmfGeometryNew();

XDMF_EXPORT unsigned int XdmfGeometryGetNumberPoints(XDMFGEOMETRY * geometry);

XDMF_EXPORT double * XdmfGeometryGetOrigin(XDMFGEOMETRY * geometry);

XDMF_EXPORT int XdmfGeometryGetOriginSize(XDMFGEOMETRY * geometry);

XDMF_EXPORT int XdmfGeometryGetType(XDMFGEOMETRY * geometry);

XDMF_EXPORT void XdmfGeometrySetOrigin(XDMFGEOMETRY * geometry, double newX, double newY, double newZ);

XDMF_EXPORT void XdmfGeometrySetOriginArray(XDMFGEOMETRY * geometry, double * originVals, unsigned int numDims);

XDMF_EXPORT void XdmfGeometrySetType(XDMFGEOMETRY * geometry, int type, int * status);

XDMF_ITEM_C_CHILD_DECLARE(XdmfGeometry, XDMFGEOMETRY, XDMF)
XDMF_ARRAY_C_CHILD_DECLARE(XdmfGeometry, XDMFGEOMETRY, XDMF)

#ifdef __cplusplus
}
#endif

Ken Leiter (Civ's avatar
Ken Leiter (Civ committed
260
#endif /* XDMFGEOMETRY_HPP_ */