Commit 11e9f68f authored by Andrew J. Burns (Cont's avatar Andrew J. Burns (Cont

made changes for preparations to push to master; still need to finish...

made changes for preparations to push to master; still need to finish documentation changes and line length changes
parent 3bce6df4
......@@ -225,6 +225,7 @@ if(NOT XDMF_BUILD_CORE_ONLY)
XdmfAttributeType
XdmfCurvilinearGrid
XdmfDomain
XdmfFunction
XdmfGeometry
XdmfGeometryType
XdmfGraph
......
This diff is collapsed.
......@@ -53,12 +53,14 @@ public:
* C++
*
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline New
* @skipline //#initialization
* @until //#initialization
*
* Python
*
* @dontinclude XdmfExampleAttribute.py
* @skipline New
* @skipline #//initialization
* @until #//initialization
*
* @return constructed XdmfAttribute.
*/
......@@ -77,14 +79,22 @@ public:
* C++
*
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline Assuming
* @skipline getCenter
* @skipline //#initialization
* @until //#initialization
* @skipline //#setCenter
* @until //#setCenter
* @skipline //#getCenter
* @until //#getCenter
*
* Python
*
* @dontinclude XdmfExampleAttribute.py
* @skipline Assuming
* @skipline getCenter
* @skipline #//initialization
* @until #//initialization
* @skipline #//setCenter
* @until #//setCenter
* @skipline #//getCenter
* @until #//getCenter
*
* @return XdmfAttributeCenter of the attribute.
*/
......@@ -102,14 +112,22 @@ public:
* C++
*
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline Assuming
* @skipline getName
* @skipline //#initialization
* @until //#initialization
* @skipline //#setName
* @until //#setName
* @skipline //#getName
* @until //#getName
*
* Python
*
* @dontinclude XdmfExampleAttribute.py
* @skipline Assuming
* @skipline getName
* @skipline #//initialization
* @until #//initialization
* @skipline #//setName
* @until #//setName
* @skipline #//getName
* @until #//getName
*
* @return a string containing the name of the attribute.
*/
......@@ -123,14 +141,22 @@ public:
* C++
*
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline Assuming
* @skipline getType
* @skipline //#initialization
* @until //#initialization
* @skipline //#setType
* @until //#setType
* @skipline //#getType
* @until //#getType
*
* Python
*
* @dontinclude XdmfExampleAttribute.py
* @skipline Assuming
* @skipline getType
* @skipline #//initialization
* @until #//initialization
* @skipline #//setType
* @until #//setType
* @skipline #//getType
* @until #//getType
*
* @return XdmfAttributeType of the attribute.
*/
......@@ -144,14 +170,18 @@ public:
* C++
*
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline New
* @skipline setCenter
* @skipline //#initialization
* @until //#initialization
* @skipline //#setCenter
* @until //#setCenter
*
* Python
*
* @dontinclude XdmfExampleAttribute.py
* @skipline New
* @skipline setCenter
* @skipline #//initialization
* @until #//initialization
* @skipline #//setCenter
* @until #//setCenter
*
* @param center the XdmfAttributeCenter to set.
*/
......@@ -165,16 +195,18 @@ public:
* C++
*
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline New
* @skipline newName
* @skipline setName
* @skipline //#initialization
* @until //#initialization
* @skipline //#setName
* @until //#setName
*
* Python
*
* @dontinclude XdmfExampleAttribute.py
* @skipline New
* @skipline newName
* @skipline setName
* @skipline #//initialization
* @until #//initialization
* @skipline #//setName
* @until #//setName
*
* @param name a string containing the name to set.
*/
......@@ -188,14 +220,18 @@ public:
* C++
*
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline New
* @skipline setType
* @skipline //#initialization
* @until //#initialization
* @skipline //#setType
* @until //#setType
*
* Python
*
* @dontinclude XdmfExampleAttribute.py
* @skipline New
* @skipline setType
* @skipline #//initialization
* @until #//initialization
* @skipline #//setType
* @until #//setType
*
* @param type XdmfAttributeType to set.
*/
......
......@@ -42,14 +42,22 @@
* C++
*
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline exampleCenter
* @until }
* @skipline //#initialization
* @until //#initialization
* @skipline //#setCenter
* @until //#setCenter
* @skipline //#getCenter
* @until //#getCenter
*
* Python
*
* @dontinclude XdmfExampleAttribute.py
* @skipline exampleCenter
* @until do
* @skipline #//initialization
* @until #//initialization
* @skipline #//setCenter
* @until #//setCenter
* @skipline #//getCenter
* @until #//getCenter
*
* Grid
* Cell
......
......@@ -42,14 +42,22 @@
* C++
*
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline exampleType
* @until }
* @skipline //#initialization
* @until //#initialization
* @skipline //#setType
* @until //#setType
* @skipline //#getType
* @until //#getType
*
* Python
*
* @dontinclude XdmfExampleAttribute.py
* @skipline exampleType
* @until do
* @skipline #//initialization
* @until #//initialization
* @skipline #//setType
* @until #//setType
* @skipline #//getType
* @until #//getType
*
* Xdmf supports the following attribute types:
* NoAttributeType
......
......@@ -182,7 +182,7 @@ public:
private:
XdmfTopologyTypeCurvilinear(const XdmfCurvilinearGrid * const curvilinearGrid) :
XdmfTopologyType(0, 0, 0, "foo", XdmfTopologyType::Structured, 0x1110),
XdmfTopologyType(0, 0, std::vector<shared_ptr<const XdmfTopologyType> >(), 0, "foo", XdmfTopologyType::Structured, 0x1110),
mCurvilinearGrid(curvilinearGrid)
{
}
......
......@@ -54,15 +54,16 @@ public:
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline newPointsX
* @until New
* @skipline //#initializationdim2
* @until //#initializationdim2
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline newPointsX
* @until newPointsY
* @skipline newPointsX
* @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.
......@@ -81,16 +82,16 @@ public:
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skip 3
* @skipline newPointsX
* @until New
* @skipline //#initializationdim3
* @until //#initializationdim3
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline newPointsX
* @until newPointsZ
* @skipline newPointsZ
* @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.
......@@ -111,15 +112,16 @@ public:
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skip via
* @skipline newPoints
* @until XdmfCurvilinearGrid
* @skipline //#initializationvector
* @until //#initializationvector
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline newPoints
* @until exampleGrid
* @skipline #//initialization
* @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
*
* @param numPoints the number of points in each direction.
*
......@@ -142,14 +144,24 @@ public:
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline Assuming
* @skipline getDimensions
* @skipline //#initializationdim3
* @until //#initializationdim3
* @skipline //#setDimensions
* @until //#setDimensions
* @skipline //#getDimensions
* @until //#getDimensions
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline Assuming
* @skipline getDimensions
* @skipline #//initialization
* @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
* @skipline #//setDimensions
* @until #//setDimensions
* @skipline #//getDimensions
* @until #//getDimensions
*
* @return XdmfArray containing dimensions of this grid.
*/
......@@ -164,8 +176,12 @@ public:
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline Assuming
* @skipline const
* @skipline //#initializationdim3
* @until //#initializationdim3
* @skipline //#setDimensions
* @until //#setDimensions
* @skipline //#getDimensionsconst
* @until //#getDimensionsconst
*
* Python: Python doesn't have a constant version
*
......@@ -181,14 +197,24 @@ public:
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline Assuming
* @skipline getGeometry
* @skipline //#initializationdim3
* @until //#initializationdim3
* @skipline //#setGeometry
* @until //#setGeometry
* @skipline //#getGeometry
* @until //#getGeometry
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline Assuming
* @skipline getGeometry
* @skipline #//initialization
* @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
* @skipline #//setGeometry
* @until #//setGeometry
* @skipline #//getGeometry
* @until #//getGeometry
*
* @return the geometry associated with this grid.
*/
......@@ -203,18 +229,20 @@ public:
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline Assuming
* @skipline XdmfArray::New
* @until setDimensions
* @skipline //#initializationdim3
* @until //#initializationdim3
* @skipline //#setDimensions
* @until //#setDimensions
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline Assuming
* @skip setDimensions
* @skipline newPoints
* @until setDimensions
* Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* @skipline #//initialization
* @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
* @skipline #//setDimensions
* @until #//setDimensions
*
* @param dimensions the dimension of the grid.
*/
......@@ -228,17 +256,20 @@ public:
* C++
*
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline newData
* @until setGeometry
* @skipline //#initializationdim3
* @until //#initializationdim3
* @skipline //#setGeometry
* @until //#setGeometry
*
* Python
*
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skip setGeometry
* @skipline newPoints
* @until insert
* Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* @skipline setGeometry
* @skipline #//initialization
* @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
* @skipline #//setGeometry
* @until #//setGeometry
*
* @param geometry an XdmfGeometry to associate with this grid.
*/
......
......@@ -55,12 +55,14 @@ public:
* C++
*
* @dontinclude ExampleXdmfDomain.cpp
* @skipline New
* @skipline //#initialization
* @until //#initialization
*
* Python
*
* @dontinclude XdmfExampleDomain.py
* @skipline New
* @skipline #//initialization
* @until #//initialization
*
* @return constructed XdmfDomain.
*/
......
This diff is collapsed.
This diff is collapsed.
......@@ -51,12 +51,14 @@ public:
* C++
*
* @dontinclude ExampleXdmfGeometry.cpp
* @skipline New
* @skipline //#initialization
* @until //#initialization
*
* Python
*
* @dontinclude XdmfExampleGeometry.py
* @skipline New
* @skipline #//initialization
* @until #//initialization
*
* @return constructed XdmfGeometry.
*/
......@@ -79,14 +81,18 @@ public:
* C++
*
* @dontinclude ExampleXdmfGeometry.cpp
* @skipline Assuming
* @skipline getNumberPoints
* @skipline //#initialization
* @until //#initialization
* @skipline //#getNumberPoints
* @until //#getNumberPoints
*
* Python
*
* @dontinclude XdmfExampleGeometry.py
* @skipline Assuming
* @skipline getNumberPoints
* @skipline #//initialization
* @until #//initialization
* @skipline #//getNumberPoints
* @until #//getNumberPoints
*/
virtual unsigned int getNumberPoints() const;
......@@ -98,14 +104,18 @@ public:
* C++
*
* @dontinclude ExampleXdmfGeometry.cpp
* @skipline Assuming
* @skipline getType
* @skipline //#initialization
* @until //#initialization
* @skipline //#getType
* @until //#getType
*
* Python
*
* @dontinclude XdmfExampleGeometry.py
* @skipline Assuming
* @skipline getType
* @skipline #//initialization
* @until #//initialization
* @skipline #//getType
* @until #//getType
*
* @return XdmfGeometryType of this geometry.
*/
......@@ -119,14 +129,18 @@ public:
* C++
*
* @dontinclude ExampleXdmfGeometry.cpp
* @skipline New
* @skipline setType
* @skipline //#initialization
* @until //#initialization
* @skipline //#setType
* @until //#setType
*
* Python
*
* @dontinclude XdmfExampleGeometry.py
* @skipline New
* @skipline setType
* @skipline #//initialization
* @until #//initialization
* @skipline #//setType
* @until #//setType
*
* @param type the XdmfGeometryType to set.
*/
......
......@@ -42,14 +42,16 @@
* C++
*
* @dontinclude ExampleXdmfGeometryType.cpp
* @skipline getType
* @until }
* @skipline //#initialization
* @until //#initialization
* @skipline //#getType
* @until //#getType
*
* Python
*
* @dontinclude XdmfExampleGeometryType.py
* @skipline getType
* @until do
* @skipline #//getType
* @until #//getType
*
* Xdmf supports the following geometry types:
* NoGeometryType
......@@ -77,12 +79,14 @@ public:
* C++
*
* @dontinclude ExampleXdmfGeometryType.cpp
* @skipline getDimensions
* @skipline //#getDimensions
* @until //#getDimensions
*
* Python
*
* @dontinclude XdmfExampleGeometryType.py
* @skipline getDimensions
* @skipline #//getDimensions
* @until #//getDimensions
*
* @return an int containing number of dimensions.
*/
......@@ -96,12 +100,14 @@ public:
* C++
*
* @dontinclude ExampleXdmfGeometryType.cpp
* @skipline getName
* @skipline //#getName
* @until //#getName
*
* Python
*
* @dontinclude XdmfExampleGeometryType.py
* @skipline getName
* @skipline #//getName
* @until #//getName
*
* @return the name of this geometry type.
*/
......
......@@ -49,12 +49,14 @@ public:
* C++
*
* @dontinclude ExampleXdmfGraph.cpp
* @skipline New
* @skipline //#initialization
* @until //#initialization
*
* Python
*
* @dontinclude XdmfExampleGraph.py
* @skipline New
* @skipline #//initialization
* @until #//initialization
*
* @param numberNodes number of nodes in graph.
*
......
......@@ -71,16 +71,18 @@ public:
* C++
*
* @dontinclude ExampleXdmfGrid.cpp
* @skipline Using
* @until Assumming
* @skipline getGeometry
* @skipline //#initialization
* @until //#initialization
* @skipline //#getGeometry
* @until //#getGeometry
*
* Python
*
* @dontinclude XdmfExampleGrid.py
* @skipline Using
* @until Assumming
* @skipline getGeometry
* @skipline #//initialization
* @until #//initialization
* @skipline #//getGeometry
* @until #//getGeometry
*
* @return the geometry associated with this grid.
*/
......@@ -98,16 +100,22 @@ public:
* C++
*
* @dontinclude ExampleXdmfGrid.cpp
* @skipline Using
* @until Assumming
* @skipline getName
* @skipline //#initialization
* @until //#initialization
* @skipline //#setName
* @until //#setName
* @skipline //#getName
* @until //#getName
*
* Python
*
* @dontinclude XdmfExampleGrid.py
* @skipline Using
* @until Assumming
* @skipline getName
* @skipline #//initialization
* @until #//initialization
* @skipline #//setName
* @until #//setName
* @skipline #//getName
* @until #//getName
*
* @return the name of the grid.
*/
......@@ -121,16 +129,22 @@ public:
* C++
*
* @dontinclude ExampleXdmfGrid.cpp
* @skipline Using
* @until Assumming
* @skipline getTime
* @skipline //#initialization
* @until //#initialization
* @skipline //#setTime
* @until //#setTime
* @skipline //#getTime
* @until //#getTime
*
* Python
*
* @dontinclude XdmfExampleGrid.py
* @skipline Using
* @until Assumming
* @skipline getTime
* @skipline #//initialization
* @until #//initialization
* @skipline #//setTime
* @until #//setTime
* @skipline #//getTime
* @until #//getTime
*
* @return pointer to the XdmfTime attached to this grid. If no
* XdmfTime is attached, return a NULL pointer.
......@@ -145,9 +159,12 @@ public:
* C++
*
* @dontinclude ExampleXdmfGrid.cpp
* @skipline Using
* @until Assumming
* @skipline exampleTimeConst
* @skipline //#initialization
* @until //#initialization
* @skipline //#setTime
* @until //#setTime
* @skipline //#getTimeconst
* @until //#getTimeconst
*
* Python: Python doesn't have a constant version
*
......@@ -164,16 +181,18 @@ public:
* C++
*
* @dontinclude ExampleXdmfGrid.cpp
* @skipline Using
* @until Assumming
* @skipline getTopology
* @skipline //#initialization
* @until //#initialization
* @skipline //#getTopology
* @until //#getTopology
*
* Python
*
* @dontinclude XdmfExampleGrid.py
* @skipline Using
* @until Assumming
* @skipline getTopology
* @skipline #//initialization
* @until #//initialization
* @skipline #//getTopology
* @until #//getTopology
*
* @return the topology associated with this grid.
*/
......@@ -189,18 +208,18 @@ public:
* C++
*
* @dontinclude ExampleXdmfGrid.cpp