A security patch will be applied between 1pm - 1:30pm, (UTC-0400), today- Aug 5th. No downtime is expected, but the site could be slow during that time.

Commit 8a80f9a7 authored by Andrew J. Burns (Cont's avatar Andrew J. Burns (Cont
Browse files

Added subset; modified Array's interaction with Function; added new...

Added subset; modified Array's interaction with Function; added new functionality to XdmfInformation subarrays; adjusted documentation to make more uniform
parent 101ba7bc
...@@ -62,7 +62,7 @@ public: ...@@ -62,7 +62,7 @@ public:
* @skipline #//initialization * @skipline #//initialization
* @until #//initialization * @until #//initialization
* *
* @return constructed XdmfAttribute. * @return Constructed XdmfAttribute.
*/ */
static shared_ptr<XdmfAttribute> New(); static shared_ptr<XdmfAttribute> New();
...@@ -129,7 +129,7 @@ public: ...@@ -129,7 +129,7 @@ public:
* @skipline #//getName * @skipline #//getName
* @until #//getName * @until #//getName
* *
* @return a string containing the name of the attribute. * @return A string containing the name of the attribute.
*/ */
std::string getName() const; std::string getName() const;
...@@ -183,7 +183,7 @@ public: ...@@ -183,7 +183,7 @@ public:
* @skipline #//setCenter * @skipline #//setCenter
* @until #//setCenter * @until #//setCenter
* *
* @param center the XdmfAttributeCenter to set. * @param center The XdmfAttributeCenter to set.
*/ */
void setCenter(const shared_ptr<const XdmfAttributeCenter> center); void setCenter(const shared_ptr<const XdmfAttributeCenter> center);
...@@ -208,7 +208,7 @@ public: ...@@ -208,7 +208,7 @@ public:
* @skipline #//setName * @skipline #//setName
* @until #//setName * @until #//setName
* *
* @param name a string containing the name to set. * @param name A string containing the name to set.
*/ */
void setName(const std::string & name); void setName(const std::string & name);
......
...@@ -93,7 +93,7 @@ protected: ...@@ -93,7 +93,7 @@ protected:
* construct XdmfAttributeCenters - * construct XdmfAttributeCenters -
* i.e. XdmfAttributeCenter::Node(). * i.e. XdmfAttributeCenter::Node().
* *
* @param name the name of the XdmfAttributeCenter to construct. * @param name The name of the XdmfAttributeCenter to construct.
*/ */
XdmfAttributeCenter(const std::string & name); XdmfAttributeCenter(const std::string & name);
......
...@@ -96,7 +96,7 @@ protected: ...@@ -96,7 +96,7 @@ protected:
* accessed through more specific static methods that construct * accessed through more specific static methods that construct
* XdmfAttributeTypes - i.e. XdmfAttributeType::Scalar(). * XdmfAttributeTypes - i.e. XdmfAttributeType::Scalar().
* *
* @param name the name of the XdmfAttributeType to construct. * @param name The name of the XdmfAttributeType to construct.
*/ */
XdmfAttributeType(const std::string & name); XdmfAttributeType(const std::string & name);
......
...@@ -65,10 +65,10 @@ public: ...@@ -65,10 +65,10 @@ public:
* @skipline #//constructor2 * @skipline #//constructor2
* @until #//constructor2 * @until #//constructor2
* *
* @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.
* *
* @return constructed curvilinear grid. * @return Constructed curvilinear grid.
*/ */
static shared_ptr<XdmfCurvilinearGrid> static shared_ptr<XdmfCurvilinearGrid>
New(const unsigned int xNumPoints, New(const unsigned int xNumPoints,
...@@ -93,11 +93,11 @@ public: ...@@ -93,11 +93,11 @@ public:
* @skipline #//constructor3 * @skipline #//constructor3
* @until #//constructor3 * @until #//constructor3
* *
* @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 zNumPoints 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.
*/ */
static shared_ptr<XdmfCurvilinearGrid> static shared_ptr<XdmfCurvilinearGrid>
New(const unsigned int xNumPoints, New(const unsigned int xNumPoints,
...@@ -123,9 +123,9 @@ public: ...@@ -123,9 +123,9 @@ public:
* @skipline #//constructorvector * @skipline #//constructorvector
* @until #//constructorvector * @until #//constructorvector
* *
* @param numPoints the number of points in each direction. * @param numPoints The number of points in each direction.
* *
* @return constructed curvilinear grid. * @return Constructed curvilinear grid.
*/ */
static shared_ptr<XdmfCurvilinearGrid> static shared_ptr<XdmfCurvilinearGrid>
New(const shared_ptr<XdmfArray> numPoints); New(const shared_ptr<XdmfArray> numPoints);
...@@ -216,7 +216,7 @@ public: ...@@ -216,7 +216,7 @@ public:
* @skipline #//getGeometry * @skipline #//getGeometry
* @until #//getGeometry * @until #//getGeometry
* *
* @return the geometry associated with this grid. * @return The geometry associated with this grid.
*/ */
shared_ptr<XdmfGeometry> getGeometry(); shared_ptr<XdmfGeometry> getGeometry();
...@@ -244,7 +244,7 @@ public: ...@@ -244,7 +244,7 @@ public:
* @skipline #//setDimensions * @skipline #//setDimensions
* @until #//setDimensions * @until #//setDimensions
* *
* @param dimensions the dimension of the grid. * @param dimensions The dimension of the grid.
*/ */
void setDimensions(const shared_ptr<XdmfArray> dimensions); void setDimensions(const shared_ptr<XdmfArray> dimensions);
...@@ -271,7 +271,7 @@ public: ...@@ -271,7 +271,7 @@ public:
* @skipline #//setGeometry * @skipline #//setGeometry
* @until #//setGeometry * @until #//setGeometry
* *
* @param geometry an XdmfGeometry to associate with this grid. * @param geometry An XdmfGeometry to associate with this grid.
*/ */
void setGeometry(const shared_ptr<XdmfGeometry> geometry); void setGeometry(const shared_ptr<XdmfGeometry> geometry);
......
...@@ -64,7 +64,7 @@ public: ...@@ -64,7 +64,7 @@ public:
* @skipline #//initialization * @skipline #//initialization
* @until #//initialization * @until #//initialization
* *
* @return constructed XdmfDomain. * @return Constructed XdmfDomain.
*/ */
static shared_ptr<XdmfDomain> New(); static shared_ptr<XdmfDomain> New();
......
...@@ -60,7 +60,7 @@ public: ...@@ -60,7 +60,7 @@ public:
* @skipline #//initialization * @skipline #//initialization
* @until #//initialization * @until #//initialization
* *
* @return constructed XdmfGeometry. * @return Constructed XdmfGeometry.
*/ */
static shared_ptr<XdmfGeometry> New(); static shared_ptr<XdmfGeometry> New();
...@@ -142,7 +142,7 @@ public: ...@@ -142,7 +142,7 @@ public:
* @skipline #//setType * @skipline #//setType
* @until #//setType * @until #//setType
* *
* @param type the XdmfGeometryType to set. * @param type The XdmfGeometryType to set.
*/ */
void setType(const shared_ptr<const XdmfGeometryType> type); void setType(const shared_ptr<const XdmfGeometryType> type);
......
...@@ -88,7 +88,7 @@ public: ...@@ -88,7 +88,7 @@ public:
* @skipline #//getDimensions * @skipline #//getDimensions
* @until #//getDimensions * @until #//getDimensions
* *
* @return an int containing number of dimensions. * @return An int containing number of dimensions.
*/ */
virtual unsigned int getDimensions() const; virtual unsigned int getDimensions() const;
...@@ -109,7 +109,7 @@ public: ...@@ -109,7 +109,7 @@ public:
* @skipline #//getName * @skipline #//getName
* @until #//getName * @until #//getName
* *
* @return the name of this geometry type. * @return The name of this geometry type.
*/ */
std::string getName() const; std::string getName() const;
......
...@@ -60,7 +60,7 @@ public: ...@@ -60,7 +60,7 @@ public:
* *
* @param numberNodes number of nodes in graph. * @param numberNodes number of nodes in graph.
* *
* @return constructed XdmfGraph. * @return Constructed XdmfGraph.
*/ */
static shared_ptr<XdmfGraph> New(const unsigned int numberNodes); static shared_ptr<XdmfGraph> New(const unsigned int numberNodes);
......
...@@ -84,7 +84,7 @@ public: ...@@ -84,7 +84,7 @@ public:
* @skipline #//getGeometry * @skipline #//getGeometry
* @until #//getGeometry * @until #//getGeometry
* *
* @return the geometry associated with this grid. * @return The geometry associated with this grid.
*/ */
shared_ptr<const XdmfGeometry> getGeometry() const; shared_ptr<const XdmfGeometry> getGeometry() const;
...@@ -117,7 +117,7 @@ public: ...@@ -117,7 +117,7 @@ public:
* @skipline #//getName * @skipline #//getName
* @until #//getName * @until #//getName
* *
* @return the name of the grid. * @return The name of the grid.
*/ */
std::string getName() const; std::string getName() const;
...@@ -146,7 +146,7 @@ public: ...@@ -146,7 +146,7 @@ public:
* @skipline #//getTime * @skipline #//getTime
* @until #//getTime * @until #//getTime
* *
* @return pointer to the XdmfTime attached to this grid. If no * @return Pointer to the XdmfTime attached to this grid. If no
* XdmfTime is attached, return a NULL pointer. * XdmfTime is attached, return a NULL pointer.
*/ */
shared_ptr<XdmfTime> getTime(); shared_ptr<XdmfTime> getTime();
...@@ -168,7 +168,7 @@ public: ...@@ -168,7 +168,7 @@ public:
* *
* Python: Python doesn't have a constant version * Python: Python doesn't have a constant version
* *
* @return pointer to the XdmfTime attached to this grid. If no * @return Pointer to the XdmfTime attached to this grid. If no
* XdmfTime is attached, return a NULL pointer. * XdmfTime is attached, return a NULL pointer.
*/ */
shared_ptr<const XdmfTime> getTime() const; shared_ptr<const XdmfTime> getTime() const;
...@@ -194,7 +194,7 @@ public: ...@@ -194,7 +194,7 @@ public:
* @skipline #//getTopology * @skipline #//getTopology
* @until #//getTopology * @until #//getTopology
* *
* @return the topology associated with this grid. * @return The topology associated with this grid.
*/ */
shared_ptr<const XdmfTopology> getTopology() const; shared_ptr<const XdmfTopology> getTopology() const;
...@@ -221,7 +221,7 @@ public: ...@@ -221,7 +221,7 @@ public:
* @skipline #//setName * @skipline #//setName
* @until #//setName * @until #//setName
* *
* @param name name of the grid to set. * @param name Name of the grid to set.
*/ */
void setName(const std::string & name); void setName(const std::string & name);
...@@ -246,7 +246,7 @@ public: ...@@ -246,7 +246,7 @@ public:
* @skipline #//setTime * @skipline #//setTime
* @until #//setTime * @until #//setTime
* *
* @param time an XdmfTime to associate with this grid. * @param time An XdmfTime to associate with this grid.
*/ */
void setTime(const shared_ptr<XdmfTime> time); void setTime(const shared_ptr<XdmfTime> time);
......
...@@ -65,7 +65,7 @@ public: ...@@ -65,7 +65,7 @@ public:
* @skipline #//initalization * @skipline #//initalization
* @until #//initalization * @until #//initalization
* *
* @return constructed XdmfGridCollection. * @return Constructed XdmfGridCollection.
*/ */
static shared_ptr<XdmfGridCollection> New(); static shared_ptr<XdmfGridCollection> New();
...@@ -127,7 +127,7 @@ public: ...@@ -127,7 +127,7 @@ public:
* @skipline #//insert * @skipline #//insert
* @until #//insert * @until #//insert
* *
* @param information an XdmfInformation to attach to this item. * @param information An XdmfInformation to attach to this item.
*/ */
void insert(const shared_ptr<XdmfInformation> information); void insert(const shared_ptr<XdmfInformation> information);
...@@ -153,7 +153,7 @@ public: ...@@ -153,7 +153,7 @@ public:
* @skipline #//setType * @skipline #//setType
* @until #//setType * @until #//setType
* *
* @param type the XdmfGridCollectionType to set. * @param type The XdmfGridCollectionType to set.
*/ */
void setType(const shared_ptr<const XdmfGridCollectionType> type); void setType(const shared_ptr<const XdmfGridCollectionType> type);
......
...@@ -56,7 +56,7 @@ public: ...@@ -56,7 +56,7 @@ public:
* @skipline #//initialization * @skipline #//initialization
* @until #//initialization * @until #//initialization
* *
* @return constructed XdmfItemFactory. * @return Constructed XdmfItemFactory.
*/ */
static shared_ptr<XdmfItemFactory> New(); static shared_ptr<XdmfItemFactory> New();
......
...@@ -79,7 +79,7 @@ public: ...@@ -79,7 +79,7 @@ public:
* @skipline #//initialization * @skipline #//initialization
* @until #//initialization * @until #//initialization
* *
* @return constructed XdmfMap. * @return Constructed XdmfMap.
*/ */
static shared_ptr<XdmfMap> New(); static shared_ptr<XdmfMap> New();
...@@ -102,11 +102,12 @@ public: ...@@ -102,11 +102,12 @@ public:
* @skipline #//initializationnode * @skipline #//initializationnode
* @until #//initializationnode * @until #//initializationnode
* *
* @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.
* *
* @return constructed XdmfMaps for each partition. The size of the vector * @return Constructed XdmfMaps for each partition. The
* will be the same as the globalNodeIds vector. * size of the vector will be the same as the
* globalNodeIds vector.
*/ */
static std::vector<shared_ptr<XdmfMap> > static std::vector<shared_ptr<XdmfMap> >
New(const std::vector<shared_ptr<XdmfAttribute> > & globalNodeIds); New(const std::vector<shared_ptr<XdmfAttribute> > & globalNodeIds);
...@@ -139,7 +140,7 @@ public: ...@@ -139,7 +140,7 @@ public:
* @skipline #//getMap * @skipline #//getMap
* @until #//getMap * @until #//getMap
* *
* @return stored boundary communicator map. * @return Stored boundary communicator map.
*/ */
std::map<task_id, node_id_map> getMap() const; std::map<task_id, node_id_map> getMap() const;
...@@ -168,7 +169,7 @@ public: ...@@ -168,7 +169,7 @@ public:
* @skipline #//getName * @skipline #//getName
* @until #//getName * @until #//getName
* *
* @return name of boundary communicator map. * @return Name of boundary communicator map.
*/ */
std::string getName() const; std::string getName() const;
...@@ -194,10 +195,10 @@ public: ...@@ -194,10 +195,10 @@ public:
* @skipline #//getRemoteNodeIds * @skipline #//getRemoteNodeIds
* @until #//getRemoteNodeIds * @until #//getRemoteNodeIds
* *
* @param remoteTaskId task id to retrieve mapping for. * @param remoteTaskId Task id to retrieve mapping for.
* *
* @return a map of local node ids to a vector of remote node ids on * @return A map of local node ids to a vector of
* remoteTaskId. * remote node ids on remoteTaskId.
*/ */
node_id_map getRemoteNodeIds(const task_id remoteTaskId); node_id_map getRemoteNodeIds(const task_id remoteTaskId);
...@@ -228,8 +229,8 @@ public: ...@@ -228,8 +229,8 @@ public:
* *
* @param remoteTaskId task id where the remoteLoalNodeId is * @param remoteTaskId task id where the remoteLoalNodeId is
* located. * located.
* @param localNodeId the node id of the node being mapped. * @param localNodeId The node id of the node being mapped.
* @param remoteLocalNodeId a node id on the remoteTaskId that the * @param remoteLocalNodeId A node id on the remoteTaskId that the
* localNodeId is mapped to. * localNodeId is mapped to.
*/ */
void insert(const task_id remoteTaskId, void insert(const task_id remoteTaskId,
...@@ -329,11 +330,11 @@ public: ...@@ -329,11 +330,11 @@ public:
* @skipline #//setHeavyDataController * @skipline #//setHeavyDataController
* @until #//setHeavyDataController * @until #//setHeavyDataController
* *
* @param remoteTaskIdsControllers a vector of XdmfHeavyDataControllers * @param remoteTaskIdsControllers A vector of XdmfHeavyDataControllers
* to the remote task ids dataset. * to the remote task ids dataset.
* @param localNodeIdsControllers a vector of XdmfHeavyDataControllers * @param localNodeIdsControllers A vector of XdmfHeavyDataControllers
* to the local node ids dataset. * to the local node ids dataset.
* @param remoteLocalNodeIdsControllers a vector of XdmfHeavyDataControllers * @param remoteLocalNodeIdsControllers A vector of XdmfHeavyDataControllers
* to the remote local node ids dataset. * to the remote local node ids dataset.
*/ */
void void
...@@ -362,7 +363,7 @@ public: ...@@ -362,7 +363,7 @@ public:
* @skipline #//setMap * @skipline #//setMap
* @until #//setMap * @until #//setMap
* *
* @param map the boundary communicator map to store. * @param map The boundary communicator map to store.
*/ */
void setMap(std::map<task_id, node_id_map> map); void setMap(std::map<task_id, node_id_map> map);
...@@ -387,7 +388,7 @@ public: ...@@ -387,7 +388,7 @@ public:
* @skipline #//setName * @skipline #//setName
* @until #//setName * @until #//setName
* *
* @param name the name of the boundary communicator map to set. * @param name The name of the boundary communicator map to set.
*/ */
void setName(const std::string & name); void setName(const std::string & name);
......
...@@ -57,7 +57,7 @@ public: ...@@ -57,7 +57,7 @@ public:
* @skipline #//initialization * @skipline #//initialization
* @until #//initialization * @until #//initialization
* *
* @return constructed XdmfReader. * @return Constructed XdmfReader.
*/ */
static shared_ptr<XdmfReader> New(); static shared_ptr<XdmfReader> New();
......
...@@ -68,10 +68,10 @@ public: ...@@ -68,10 +68,10 @@ public:
* @skipline #//initialization2 * @skipline #//initialization2
* @until #//initialization2 * @until #//initialization2
* *
* @param xCoordinates the coordinates of points along the x axis * @param xCoordinates The coordinates of points along the x axis
* @param yCoordinates the coordinates of points along the y axis. * @param yCoordinates The coordinates of points along the y axis.
* *
* @return constructed rectilinear grid. * @return Constructed rectilinear grid.
*/ */
static shared_ptr<XdmfRectilinearGrid> static shared_ptr<XdmfRectilinearGrid>
New(const shared_ptr<XdmfArray> xCoordinates, New(const shared_ptr<XdmfArray> xCoordinates,
...@@ -98,11 +98,11 @@ public: ...@@ -98,11 +98,11 @@ public:
* @skipline #//initialization3 * @skipline #//initialization3
* @until #//initialization3 * @until #//initialization3
* *
* @param xCoordinates the coordinates of points along the x axis * @param xCoordinates The coordinates of points along the x axis
* @param yCoordinates the coordinates of points along the y axis. * @param yCoordinates The coordinates of points along the y axis.
* @param zCoordinates the coordinates of points along the z axis. * @param zCoordinates The coordinates of points along the z axis.
* *
* @return constructed rectilinear grid. * @return Constructed rectilinear grid.
*/ */
static shared_ptr<XdmfRectilinearGrid> static shared_ptr<XdmfRectilinearGrid>
New(const shared_ptr<XdmfArray> xCoordinates, New(const shared_ptr<XdmfArray> xCoordinates,
...@@ -130,9 +130,9 @@ public: ...@@ -130,9 +130,9 @@ public:
* @skipline #//initializationvector * @skipline #//initializationvector
* @until #//initializationvector * @until #//initializationvector
* *
* @param axesCoordinates the coordinates of points along each axis. * @param axesCoordinates The coordinates of points along each axis.
* *
* @return constructed rectilinear grid. * @return Constructed rectilinear grid.
*/ */
static shared_ptr<XdmfRectilinearGrid> static shared_ptr<XdmfRectilinearGrid>
New(const std::vector<shared_ptr<XdmfArray> > & axesCoordinates); New(const std::vector<shared_ptr<XdmfArray> > & axesCoordinates);
...@@ -167,11 +167,11 @@ public: ...@@ -167,11 +167,11 @@ public:
* @skipline #//getCoodinatessingle * @skipline #//getCoodinatessingle
* @until #//getCoodinatessingle * @until #//getCoodinatessingle
* *
* @param axisIndex the index of the axis to retrieve, (i.e. 0 for * @param axisIndex The index of the axis to retrieve, (i.e. 0 for
* x-axis). If no array exists at the index, * x-axis). If no array exists at the index,
* return NULL. * return NULL.
* *