Commit 36ed6d02 authored by Kenneth Leiter's avatar Kenneth Leiter
Browse files

ENH: Modify documentation for completeness.

Added documentation to several methods. Modified Doxygen configuration file to
correctly process macros (tested using Doxygen 1.7.1). Correctly format
documentation to 80 characters per line.
parent 894a8618
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
# This allows you to turn on and off the auto # This allows you to turn on and off the auto
# update of the (project name)Version.hpp file # update of the (project name)Version.hpp file
SET(VERSION_CONTROL_AUTOUPDATE ON CACHE BOOL "Automaticaly Update The Version") SET(VERSION_CONTROL_AUTOUPDATE OFF CACHE BOOL "Automaticaly Update The Version")
MARK_AS_ADVANCED(VERSION_CONTROL_AUTOUPDATE) MARK_AS_ADVANCED(VERSION_CONTROL_AUTOUPDATE)
# We need to make sure we have the header file # We need to make sure we have the header file
......
#ifndef _XDMF_HPP #ifndef _XDMF_HPP
#define _XDMF_HPP #define _XDMF_HPP
/*! \mainpage XDMF API
*
* \section intro Introduction
*
* The eXtensible Data Model and Format (XDMF) is a distributed data
* hub for accessing scientific data in High Performance Computing
* (HPC) applications. XDMF defines a data model and format as well as
* facilities for accessing the data in a distributed environment.
*
* XDMF differs from other data model and format efforts in that the
* "light data" is logically (and possibly physically) separated from
* the "heavy data". Light data is considered to be both "data about
* the data" such as dimensions and name, as well as small quantities
* of computed data. Heavy data is considered to be large amounts of
* data. For example, in a three dimensional structural mechanics
* calculation, the size and dimensions of the computational grid are
* light data while the actual X, Y, and Z values for the grid are
* heavy data. Calculated values like "Pressure at a node" are heavy,
* while "Total Residual Mass" for the entire calculation is light.
* Light data is stored on disk in a machine parsable language like
* XML. Heavy data is stored in a format suitable for large amounts of
* data like HDF5.
*
* While use of the XDMF API is not necessary to produce or consume
* valid datasets, it is extremely useful for handling the wide variety
* of files that are possible and its use is highly recommended. The
* XDMF API is written in C++ and is wrapped for access from other
* languages including Python and Java.
*
* XDMF utilizes reference counting shared pointers to handle ownership
* of XDMF objects. This allows multiple objects to reference a single
* XDMF object. An object is deleted and memory is reclaimed when no
* other XDMF objects hold a reference to the object. This allows
* flexibility in constructing XDMF structures, as simple structures
* can be shared instead of copied.
*
* All XDMF objects are constructed by calling New(), which returns a
* shared pointer to a newly constructed object. All default
* constructors in the XDMF API are protected, ensuring that only
* shared pointers can be created. These pointers are freed
* automatically by the shared pointer reference counting mechanism.
*/
/* Keep all our Win32 Conversions here */ /* Keep all our Win32 Conversions here */
#ifdef _WIN32 #ifdef _WIN32
/* Used to export/import from the dlls */ /* Used to export/import from the dlls */
......
...@@ -12,11 +12,11 @@ class XdmfAttributeType; ...@@ -12,11 +12,11 @@ class XdmfAttributeType;
/** /**
* @brief Holds values located at specific parts of an XdmfGrid. * @brief Holds values located at specific parts of an XdmfGrid.
* *
* XdmfAttribute holds values centered at specific locations of an XdmfGrid. * XdmfAttribute holds values centered at specific locations of an
* An attribute contains two properties that should be set, * XdmfGrid. An attribute contains two properties that should be set,
* XdmfAttributeCenter, which describes where the values are centered, and * XdmfAttributeCenter, which describes where the values are centered,
* XdmfAttributeType, which describes what types of values the attribute * and XdmfAttributeType, which describes what types of values the
* contains. * attribute contains.
*/ */
class XDMF_EXPORT XdmfAttribute : public XdmfArray { class XDMF_EXPORT XdmfAttribute : public XdmfArray {
......
...@@ -8,10 +8,10 @@ ...@@ -8,10 +8,10 @@
/** /**
* @brief Property describing where XdmfAttribute values are centered. * @brief Property describing where XdmfAttribute values are centered.
* *
* XdmfAttributeCenter is a property used by XdmfAttribute to specify where * XdmfAttributeCenter is a property used by XdmfAttribute to specify
* its values are centered on an XdmfGrid. A specific XdmfAttributeCenter can * where its values are centered on an XdmfGrid. A specific
* be created by calling on of the static methods in the class, i.e. * XdmfAttributeCenter can be created by calling on of the static
* XdmfAttributeCenter::Cell(). * methods in the class, i.e. XdmfAttributeCenter::Cell().
* *
* Xdmf supports the following attribute centers: * Xdmf supports the following attribute centers:
* Grid * Grid
...@@ -42,10 +42,11 @@ class XDMF_EXPORT XdmfAttributeCenter : public XdmfItemProperty { ...@@ -42,10 +42,11 @@ class XDMF_EXPORT XdmfAttributeCenter : public XdmfItemProperty {
protected: protected:
/** /**
* Protected constructor for XdmfAttributeCenter. The constructor is * Protected constructor for XdmfAttributeCenter. The constructor
* protected because all attribute centers supported by Xdmf should be * is protected because all attribute centers supported by Xdmf
* accessed through more specific static methods that construct * should be accessed through more specific static methods that
* XdmfAttributeCenters - i.e. XdmfAttributeCenter::Node(). * construct XdmfAttributeCenters -
* i.e. XdmfAttributeCenter::Node().
* *
* @param name the name of the XdmfAttributeCenter to construct. * @param name the name of the XdmfAttributeCenter to construct.
*/ */
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
#include "XdmfItemProperty.hpp" #include "XdmfItemProperty.hpp"
/** /**
* @brief Property describing the type of values an XdmfAttribute contains. * @brief Property describing the type of values an XdmfAttribute
* contains.
* *
* XdmfAttributeType is a property used by XdmfAttribute to specify what type * XdmfAttributeType is a property used by XdmfAttribute to specify
* of values the XdmfAttribute contains. A specific XdmfAttributeType can be * what type of values the XdmfAttribute contains. A specific
* created by calling one of the static methods in the class, * XdmfAttributeType can be created by calling one of the static
* i.e. XdmfAttributeType::Scalar(). * methods in the class, i.e. XdmfAttributeType::Scalar().
* *
* Xdmf supports the following attribute types: * Xdmf supports the following attribute types:
* NoAttributeType * NoAttributeType
......
...@@ -9,14 +9,14 @@ class XdmfArray; ...@@ -9,14 +9,14 @@ class XdmfArray;
#include "XdmfGrid.hpp" #include "XdmfGrid.hpp"
/** /**
* @brief A curvilinear (or structured) grid consisting of cells and points * @brief A curvilinear (or structured) grid consisting of cells and
* arranged on a regular lattice in space. * points arranged on a regular lattice in space.
* *
* XdmfCurvilinearGrid represents a mesh of cells and points arranged with * XdmfCurvilinearGrid represents a mesh of cells and points arranged
* regular topology and irregular geometry. * with regular topology and irregular geometry.
* *
* In order to define a curvilinear grid, the dimensions of the grid must be * In order to define a curvilinear grid, the dimensions of the grid
* supplied along with the coordinates of each point. * must be supplied along with the coordinates of each point.
* *
*/ */
class XDMF_EXPORT XdmfCurvilinearGrid : public XdmfGrid { class XDMF_EXPORT XdmfCurvilinearGrid : public XdmfGrid {
...@@ -40,7 +40,7 @@ class XDMF_EXPORT XdmfCurvilinearGrid : public XdmfGrid { ...@@ -40,7 +40,7 @@ class XDMF_EXPORT XdmfCurvilinearGrid : public XdmfGrid {
* *
* @param xNumPoints the number of points in the x direction. * @param xNumPoints the number of points in the x direction.
* @param yNumPoints the number of points in the y direction. * @param yNumPoints the number of points in the y direction.
* @param yNumPoints the number of points in the z direction. * @param zNumPoints the number of points in the z direction.
* *
* @return constructed curvilinear grid. * @return constructed curvilinear grid.
*/ */
...@@ -65,15 +65,16 @@ class XDMF_EXPORT XdmfCurvilinearGrid : public XdmfGrid { ...@@ -65,15 +65,16 @@ class XDMF_EXPORT XdmfCurvilinearGrid : public XdmfGrid {
static const std::string ItemTag; static const std::string ItemTag;
/** /**
* Get the dimensions of the grid, the number of points in each direction. * Get the dimensions of the grid, the number of points in each
* direction.
* *
* @return XdmfArray containing dimensions of this grid. * @return XdmfArray containing dimensions of this grid.
*/ */
boost::shared_ptr<XdmfArray> getDimensions(); boost::shared_ptr<XdmfArray> getDimensions();
/** /**
* Get the dimensions of the grid, the number of points in each direction * Get the dimensions of the grid, the number of points in each
* (const version). * direction (const version).
* *
* @return XdmfArray containing the dimensions of this grid. * @return XdmfArray containing the dimensions of this grid.
*/ */
...@@ -87,7 +88,8 @@ class XDMF_EXPORT XdmfCurvilinearGrid : public XdmfGrid { ...@@ -87,7 +88,8 @@ class XDMF_EXPORT XdmfCurvilinearGrid : public XdmfGrid {
boost::shared_ptr<XdmfGeometry> getGeometry(); boost::shared_ptr<XdmfGeometry> getGeometry();
/** /**
* Set the dimensions of the grid, the number of points in each direction. * Set the dimensions of the grid, the number of points in each
* direction.
* *
* @param dimensions the dimension of the grid. * @param dimensions the dimension of the grid.
*/ */
......
...@@ -15,9 +15,9 @@ class XdmfUnstructuredGrid; ...@@ -15,9 +15,9 @@ class XdmfUnstructuredGrid;
/** /**
* @brief The root XdmfItem that holds XdmfGrids. * @brief The root XdmfItem that holds XdmfGrids.
* *
* XdmfDomain is the top XdmfItem in an Xdmf structure. * XdmfDomain is the top XdmfItem in an Xdmf structure. It can store
* It can store a number of grids and provides methods to insert, retrieve, * a number of grids and provides methods to insert, retrieve, and
* and remove these grids. * remove these grids.
*/ */
class XDMF_EXPORT XdmfDomain : public virtual XdmfItem { class XDMF_EXPORT XdmfDomain : public virtual XdmfItem {
......
...@@ -11,10 +11,10 @@ class XdmfGeometryType; ...@@ -11,10 +11,10 @@ class XdmfGeometryType;
/** /**
* @brief Handles the coordinate positions of points in an XdmfGrid. * @brief Handles the coordinate positions of points in an XdmfGrid.
* *
* XdmfGeometry is a required part of an XdmfGrid. It stores the coordinate * XdmfGeometry is a required part of an XdmfGrid. It stores the
* locations of all points contained in an XdmfGrid. XdmfGeometry contains an * coordinate locations of all points contained in an
* XdmfGeometryType property which should be set that specifies the types of * XdmfGrid. XdmfGeometry contains an XdmfGeometryType property which
* coordinate values stored. * should be set that specifies the types of coordinate values stored.
*/ */
class XDMF_EXPORT XdmfGeometry : public XdmfArray { class XDMF_EXPORT XdmfGeometry : public XdmfArray {
......
...@@ -6,13 +6,13 @@ ...@@ -6,13 +6,13 @@
#include "XdmfItemProperty.hpp" #include "XdmfItemProperty.hpp"
/** /**
* @brief Property describing the types of coordinate values stored in an * @brief Property describing the types of coordinate values stored in
* XdmfGeometry. * an XdmfGeometry.
* *
* XdmfGeometryType is a property used by XdmfGeometry to specify the type of * XdmfGeometryType is a property used by XdmfGeometry to specify the
* coordinate values stored in the XdmfGeometry. A specific XdmfGeometryType * type of coordinate values stored in the XdmfGeometry. A specific
* can be created by calling one of the static methods in the class, i.e. * XdmfGeometryType can be created by calling one of the static
* XdmfAttributeType::XYZ(). * methods in the class, i.e. XdmfAttributeType::XYZ().
* *
* Xdmf supports the following geometry types: * Xdmf supports the following geometry types:
* NoGeometryType * NoGeometryType
...@@ -52,10 +52,10 @@ class XDMF_EXPORT XdmfGeometryType : public XdmfItemProperty { ...@@ -52,10 +52,10 @@ class XDMF_EXPORT XdmfGeometryType : public XdmfItemProperty {
protected: protected:
/** /**
* Protected constructor for XdmfGeometryType. The constructor is protected * Protected constructor for XdmfGeometryType. The constructor is
* because all geometry types supported by Xdmf should be accessed through * protected because all geometry types supported by Xdmf should be
* more specific static methods that construct XdmfGeometryTypes - i.e. * accessed through more specific static methods that construct
* XdmfGeometryType::XYZ(). * XdmfGeometryTypes - i.e. XdmfGeometryType::XYZ().
* *
* @param name a std::string containing the name of the geometry type.. * @param name a std::string containing the name of the geometry type..
* @param dimensions an int containing the dimensions of the geometry type. * @param dimensions an int containing the dimensions of the geometry type.
......
...@@ -14,17 +14,19 @@ class XdmfTopology; ...@@ -14,17 +14,19 @@ class XdmfTopology;
#include "XdmfItem.hpp" #include "XdmfItem.hpp"
/** /**
* @brief A mesh containing elements, points, and fields attached to the mesh. * @brief A mesh containing elements, points, and fields attached to
* the mesh.
* *
* XdmfGrid represents a mesh. It is required to contain two other Xdmf data * XdmfGrid represents a mesh. It is required to contain two other
* structures, an XdmfGeometry that stores point locations and an XdmfTopology * Xdmf data structures, an XdmfGeometry that stores point locations
* that store connectivity information. XdmfAttributes can be inserted into * and an XdmfTopology that store connectivity
* the XdmfGrid to specify fields centered on various parts of the mesh. * information. XdmfAttributes can be inserted into the XdmfGrid to
* XdmfSets can be inserted into XdmfGrids to specify collections of mesh * specify fields centered on various parts of the mesh. XdmfSets can
* elements. * be inserted into XdmfGrids to specify collections of mesh elements.
* *
* XdmfGrid is an abstract base class. There are several implementations for * XdmfGrid is an abstract base class. There are several
* representing both structured and unstructured grids. * implementations for representing both structured and unstructured
* grids.
*/ */
class XDMF_EXPORT XdmfGrid : public virtual XdmfItem { class XDMF_EXPORT XdmfGrid : public virtual XdmfItem {
...@@ -73,16 +75,16 @@ class XDMF_EXPORT XdmfGrid : public virtual XdmfItem { ...@@ -73,16 +75,16 @@ class XDMF_EXPORT XdmfGrid : public virtual XdmfItem {
/** /**
* Get the time associated with this grid. * Get the time associated with this grid.
* *
* @return pointer to the XdmfTime attached to this grid. If no XdmfTime is * @return pointer to the XdmfTime attached to this grid. If no
* attached, return a NULL pointer. * XdmfTime is attached, return a NULL pointer.
*/ */
boost::shared_ptr<XdmfTime> getTime(); boost::shared_ptr<XdmfTime> getTime();
/** /**
* Get the time associated with this grid (const version). * Get the time associated with this grid (const version).
* *
* @return pointer to the XdmfTime attached to this grid. If no XdmfTime is * @return pointer to the XdmfTime attached to this grid. If no
* attached, return a NULL pointer. * XdmfTime is attached, return a NULL pointer.
*/ */
boost::shared_ptr<const XdmfTime> getTime() const; boost::shared_ptr<const XdmfTime> getTime() const;
......
...@@ -12,13 +12,13 @@ class XdmfGridCollectionType; ...@@ -12,13 +12,13 @@ class XdmfGridCollectionType;
/** /**
* @brief A spatial or temporal collection of XdmfGrids. * @brief A spatial or temporal collection of XdmfGrids.
* *
* A temporal collection is timestep data. Each child grid represents the * A temporal collection is timestep data. Each child grid represents
* state at a single timestep. * the state at a single timestep. A spatial collection consists of
* A spatial collection consists of XdmfGrids that are arranged together in * XdmfGrids that are arranged together in space. E.g. a partitioned
* space. E.g. a partitioned mesh. * mesh.
* *
* It is valid to nest collections. A spatial collection inside a temporal * It is valid to nest collections. A spatial collection inside a
* collection is commonly used. * temporal collection is commonly used.
*/ */
class XDMF_EXPORT XdmfGridCollection : public XdmfDomain, class XDMF_EXPORT XdmfGridCollection : public XdmfDomain,
public XdmfGrid { public XdmfGrid {
...@@ -52,14 +52,15 @@ class XDMF_EXPORT XdmfGridCollection : public XdmfDomain, ...@@ -52,14 +52,15 @@ class XDMF_EXPORT XdmfGridCollection : public XdmfDomain,
using XdmfGrid::insert; using XdmfGrid::insert;
/** /**
* Insert an information into the grid collection.. * Insert an information into the grid collection.
* *
* @param information an XdmfInformation to attach to this item. * @param information an XdmfInformation to attach to this item.
*/ */
void insert(const boost::shared_ptr<XdmfInformation> information); void insert(const boost::shared_ptr<XdmfInformation> information);
/** /**
* Set the XdmfGridCollectionType associated with this grid collection. * Set the XdmfGridCollectionType associated with this grid
* collection.
* *
* @param type the XdmfGridCollectionType to set. * @param type the XdmfGridCollectionType to set.
*/ */
......
...@@ -8,10 +8,11 @@ ...@@ -8,10 +8,11 @@
/** /**
* @brief Property describing the type of an XdmfGridCollection. * @brief Property describing the type of an XdmfGridCollection.
* *
* XdmfGridCollectionType is a property used by XdmfGridCollection to specify * XdmfGridCollectionType is a property used by XdmfGridCollection to
* what type of collection the XdmfGridCollection contains. A specific * specify what type of collection the XdmfGridCollection contains. A
* XdmfGridCollectionType can be created by calling one of the static methods * specific XdmfGridCollectionType can be created by calling one of
* in the class, i.e. XdmfGridCollectionType::Temporal(). * the static methods in the class,
* i.e. XdmfGridCollectionType::Temporal().
* *
* Xdmf supports the following collection types: * Xdmf supports the following collection types:
* NoCollectionType * NoCollectionType
...@@ -37,10 +38,11 @@ class XDMF_EXPORT XdmfGridCollectionType : public XdmfItemProperty { ...@@ -37,10 +38,11 @@ class XDMF_EXPORT XdmfGridCollectionType : public XdmfItemProperty {
protected: protected:
/** /**
* Protected constructor for XdmfGridCollectionType. The constructor is * Protected constructor for XdmfGridCollectionType. The constructor
* protected because all collection types supported by Xdmf should be * is protected because all collection types supported by Xdmf
* accessed through more specific static methods that construct * should be accessed through more specific static methods that
* XdmfGridCollectionType - i.e. XdmfGridCollectionType::Temporal(). * construct XdmfGridCollectionType -
* i.e. XdmfGridCollectionType::Temporal().
* *
* @param name the name of the XdmfGridCollectionType to construct. * @param name the name of the XdmfGridCollectionType to construct.
*/ */
......
...@@ -11,20 +11,23 @@ class XdmfHeavyDataController; ...@@ -11,20 +11,23 @@ class XdmfHeavyDataController;
#include "XdmfItem.hpp" #include "XdmfItem.hpp"
/** /**
* @brief Boundary communicator map for partitioned spatial collections. * @brief Boundary communicator map for partitioned spatial
* collections.
* *
* Provides mechanism for mapping nodes across partition boundaries. Each * Provides mechanism for mapping nodes across partition
* partitioned grid contains its own map, mapping its own nodes to all other * boundaries. Each partitioned grid contains its own map, mapping its
* nodes in the global system. * own nodes to all other nodes in the global system.
* *
* There are two methods for constructing XdmfMaps: * There are two methods for constructing XdmfMaps:
* Calling New() with no parameters will construct an empty map. The map can be *
* filled manually with subsequent insert commands. * Calling New() with no parameters will construct an empty map. The
* map can be filled manually with subsequent insert commands.
*
* Calling New(const std::vector<boost::shared_ptr<XdmfAttribute> > & * Calling New(const std::vector<boost::shared_ptr<XdmfAttribute> > &
* globalNodeIds) will construct XdmfMaps for each grid in an entire global * globalNodeIds) will construct XdmfMaps for each grid in an entire
* system. Each entry in the vector contains the globalNodeIds for that * global system. Each entry in the vector contains the globalNodeIds
* partition. The constructor accepts global node ids for each partition to * for that partition. The constructor accepts global node ids for
* construct the proper XdmfMaps. * each partition to construct the proper XdmfMaps.
*/ */
class XDMF_EXPORT XdmfMap : public XdmfItem { class XDMF_EXPORT XdmfMap : public XdmfItem {
...@@ -38,8 +41,9 @@ class XDMF_EXPORT XdmfMap : public XdmfItem { ...@@ -38,8 +41,9 @@ class XDMF_EXPORT XdmfMap : public XdmfItem {
static boost::shared_ptr<XdmfMap> New(); static boost::shared_ptr<XdmfMap> New();
/** /**
* Create XdmfMaps for each grid in a domain decomposed mesh. Each entry in * Create XdmfMaps for each grid in a domain decomposed mesh. Each
* the globalNodeIds vector contains the global node ids for that partition. * entry in the globalNodeIds vector contains the global node ids
* for that partition.
* *
* @param globalNodeIds a vector of attributes containing globalNodeId * @param globalNodeIds a vector of attributes containing globalNodeId
* values for each partition to be mapped. * values for each partition to be mapped.
...@@ -57,7 +61,8 @@ class XDMF_EXPORT XdmfMap : public XdmfItem { ...@@ -57,7 +61,8 @@ class XDMF_EXPORT XdmfMap : public XdmfItem {
std::map<std::string, std::string> getItemProperties() const; std::map<std::string, std::string> getItemProperties() const;
/** /**
* Given a local node id return a map containing equivalent remote node ids * Given a local node id return a map containing equivalent remote
* node ids
*/ */
std::map<unsigned int, unsigned int> std::map<unsigned int, unsigned int>
getRemoteNodeIds(const unsigned int localNodeId); getRemoteNodeIds(const unsigned int localNodeId);
...@@ -71,7 +76,8 @@ class XDMF_EXPORT XdmfMap : public XdmfItem { ...@@ -71,7 +76,8 @@ class XDMF_EXPORT XdmfMap : public XdmfItem {
const unsigned int remoteLocalNodeId); const unsigned int remoteLocalNodeId);
/** /**
* Returns whether the map is initialized (contains values in memory). * Returns whether the map is initialized (contains values in
* memory).
*/ */
bool isInitialized() const; bool isInitialized() const;
......
...@@ -8,10 +8,10 @@ ...@@ -8,10 +8,10 @@
/** /**
* @brief Reads an Xdmf file stored on disk into memory. * @brief Reads an Xdmf file stored on disk into memory.
* *
* Reads an Xdmf file stored on disk into an Xdmf structure in memory. All * Reads an Xdmf file stored on disk into an Xdmf structure in
* light data is parsed in order to create appropriate Xdmf objects. Heavy * memory. All light data is parsed in order to create appropriate
* data controllers are created and attached to XdmfArrays but no heavy data * Xdmf objects. Heavy data controllers are created and attached to
* is read into memory. * XdmfArrays but no heavy data is read into memory.
*/ */
class XDMF_EXPORT XdmfReader : public XdmfCoreReader { class XDMF_EXPORT XdmfReader : public XdmfCoreReader {
......
...@@ -9,15 +9,15 @@ class XdmfArray; ...@@ -9,15 +9,15 @@ class XdmfArray;
#include "XdmfGrid.hpp" #include "XdmfGrid.hpp"
/** /**
* @brief A rectilinear grid consists of cells and points arranged on a * @brief A rectilinear grid consists of cells and points arranged on
* regular lattice in space. * a regular lattice in space.
* *
* XdmfRectilinearGrid represents a mesh of cells and points arranged on a * XdmfRectilinearGrid represents a mesh of cells and points arranged
* regular lattice in space. Points are arranged along coordinate axes, but * on a regular lattice in space. Points are arranged along coordinate
* the spacing between points may vary. * axes, but the spacing between points may vary.
* *
* In order to define a rectilinear grid, the coordinates along each axis * In order to define a rectilinear grid, the coordinates along each
* direction must be specified. * axis direction must be specified.
* *
*/ */
class XDMF_EXPORT XdmfRectilinearGrid : public XdmfGrid { class XDMF_EXPORT XdmfRectilinearGrid : public XdmfGrid {
...@@ -68,18 +68,19 @@ class XDMF_EXPORT XdmfRectilinearGrid : public XdmfGrid { ...@@ -68,18 +68,19 @@ class XDMF_EXPORT XdmfRectilinearGrid : public XdmfGrid {
/** /**
* Get the coordinates of the grid along a single axis. * Get the coordinates of the grid along a single axis.
* *
* @param axisIndex the index of the axis to retrieve, (i.e. 0 for x-axis). * @param axisIndex the index of the axis to retrieve, (i.e. 0 for
* If no array exists at the index, return NULL. * x-axis). If no array exists at the index, return NULL.
* *
* @return array of coordinates along * @return array of coordinates along
*/ */
boost::shared_ptr<XdmfArray> getCoordinates(const unsigned int axisIndex); boost::shared_ptr<XdmfArray> getCoordinates(const unsigned int axisIndex);
/** /**
* Get the coordinates of the grid along a single axis (const version). * Get the coordinates of the grid along a single axis (const
* version).
* *
* @param axisIndex the index of the axis to retrieve (i.e. 0 for x-axis). * @param axisIndex the index of the axis to retrieve (i.e. 0 for
* If no array exists at the index, return NULL. * x-axis). If no array exists at the index, return NULL.
*