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

more example files added, DSM example created but currently being debugged.

parent bef0a664
project(Xdmf) project(Xdmf)
cmake_minimum_required(VERSION 2.6) cmake_minimum_required(VERSION 2.6)
#Needed to build DSM because relative paths are used to add its libraries
if (POLICY CMP0015)
cmake_policy(SET CMP0015 NEW)
endif (POLICY CMP0015)
if(MSVC10) if(MSVC10)
SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR}) SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR})
SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR}) SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR})
......
...@@ -52,15 +52,13 @@ public: ...@@ -52,15 +52,13 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfAttribute.cpp
* shared_ptr<XdmfAttribute> exampleAttribute = XdmfAttribute::New(); * @skipline New
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleAttribute.py
* exampleAttribute = XdmfAttribute.New() * @skipline New
* @endcode
* *
* @return constructed XdmfAttribute. * @return constructed XdmfAttribute.
*/ */
...@@ -78,19 +76,15 @@ public: ...@@ -78,19 +76,15 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfAttribute.cpp
* //Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its center set * Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its center set
* shared_ptr<const XdmfAttributeCenter> exampleCenter = exampleAttribute->getCenter(); * @skipline getCenter
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleAttribute.py
* '''
* Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its center set * Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its center set
* ''' * @skipline getCenter
* exampleCenter = exampleAttribute.getCenter()
* @endcode
* *
* @return XdmfAttributeCenter of the attribute. * @return XdmfAttributeCenter of the attribute.
*/ */
...@@ -107,19 +101,15 @@ public: ...@@ -107,19 +101,15 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfAttribute.cpp
* //Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object * Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object
* std::string exampleName = exampleAttribute->getName(); * @skipline getName
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleAttribute.py
* '''
* Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object * Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object
* ''' * @skipline getName
* exampleName = exampleAttribute.getName()
* @endcode
* *
* @return a string containing the name of the attribute. * @return a string containing the name of the attribute.
*/ */
...@@ -132,19 +122,15 @@ public: ...@@ -132,19 +122,15 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfAttribute.cpp
* //Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its type set * Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its type set
* shared_ptr<const XdmfAttributeType> exampleType = exampleAttribute->getType(); * @skipline getType
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleAttribute.py
* '''
* Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its type set * Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its type set
* ''' * @skipline getType
* exampleType = exampleAttribute.getType()
* @endcode
* *
* @return XdmfAttributeType of the attribute. * @return XdmfAttributeType of the attribute.
*/ */
...@@ -157,17 +143,15 @@ public: ...@@ -157,17 +143,15 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfAttribute.cpp
* shared_ptr<XdmfAttribute> exampleAttribute = XdmfAttribute::New(); * @skipline New
* exampleAttribute->setCenter(XdmfAttributeCenter::Node()); * @skipline setCenter
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleAttribute.py
* exampleAttribute = XdmfAttribute.New() * @skipline New
* exampleAttribute.setCenter(XdmfAttributeCenter.Node()) * @skipline setCenter
* @endcode
* *
* @param center the XdmfAttributeCenter to set. * @param center the XdmfAttributeCenter to set.
*/ */
...@@ -180,19 +164,17 @@ public: ...@@ -180,19 +164,17 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfAttribute.cpp
* shared_ptr<XdmfAttribute> exampleAttribute = XdmfAttribute::New(); * @skipline New
* std::string newName = "New Name"; * @skipline newName
* exampleAttribute->setName(newName); * @skipline setName
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleAttribute.py
* exampleAttribute = XdmfAttribute.New() * @skipline New
* newName = "New Name" * @skipline newName
* exampleAttribute.setName(newName) * @skipline setName
* @endcode
* *
* @param name a string containing the name to set. * @param name a string containing the name to set.
*/ */
...@@ -205,17 +187,15 @@ public: ...@@ -205,17 +187,15 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfAttribute.cpp
* shared_ptr<XdmfAttribute> exampleAttribute = XdmfAttribute::New(); * @skipline New
* exampleAttribute->setType(XdmfAttributeType::Node()); * @skipline setType
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleAttribute.py
* exampleAttribute = XdmfAttribute.New() * @skipline New
* exampleAttribute.setType(XdmfAttributeType.Node()) * @skipline setType
* @endcode
* *
* @param type XdmfAttributeType to set. * @param type XdmfAttributeType to set.
*/ */
......
...@@ -53,19 +53,16 @@ public: ...@@ -53,19 +53,16 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* unsigned int newPointsX = 5; * @skipline newPointsX
* unsigned int newPointsY = 5; * @until New
* shared_ptr<XdmfCurvilinearGrid> exampleGrid = XdmfCurvilinearGrid::New(newPointsX, newPointsY);
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleCurvilinearGrid.py
* newPointsX = 5 * @skipline newPointsX
* newPointsY = 5 * @until newPointsY
* exampleGrid = XdmfCurvilinearGrid.New(newPointsX, newPointsY) * @skipline newPointsX
* @endcode
* *
* @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.
...@@ -83,21 +80,17 @@ public: ...@@ -83,21 +80,17 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* unsigned int newPointsX = 5; * @skip 3
* unsigned int newPointsY = 5; * @skipline newPointsX
* unsigned int newPointsZ = 5; * @until New
* shared_ptr<XdmfCurvilinearGrid> exampleGrid = XdmfCurvilinearGrid::New(newPointsX, newPointsY, newPointsZ);
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleCurvilinearGrid.py
* newPointsX = 5 * @skipline newPointsX
* newPointsY = 5 * @until newPointsZ
* newPointsZ = 5 * @skipline newPointsZ
* exampleGrid = XdmfCurvilinearGrid.New(newPointsX, newPointsY, newPointsZ)
* @endcode
* *
* @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.
...@@ -117,23 +110,16 @@ public: ...@@ -117,23 +110,16 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* shared_ptr<XdmfArray> newPoints = XdmfArray::New(); * @skip via
* newPoints->pushBack(5); * @skipline newPoints
* newPoints->pushBack(5); * @until XdmfCurvilinearGrid
* newPoints->pushBack(5);
* shared_ptr<XdmfCurvilinearGrid> exampleGrid = XdmfCurvilinearGrid::New(newPoints);
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleCurvilinearGrid.py
* newPoints = XdmfArray.New() * @skipline newPoints
* newPoints.pushBackAsInt32(5) * @until exampleGrid
* newPoints.pushBackAsInt32(5)
* newPoints.pushBackAsInt32(5)
* exampleGrid = XdmfCurvilinearGrid.New(newPoints)
* @endcode
* *
* @param numPoints the number of points in each direction. * @param numPoints the number of points in each direction.
* *
...@@ -155,19 +141,15 @@ public: ...@@ -155,19 +141,15 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* //Assuming that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object * Assuming that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object
* shared_ptr<XdmfArray> exampleDimensions = exampleGrid->getDimensions(); * @skipline getDimensions
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleCurvilinearGrid.py
* '''
* Assuming that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object * Assuming that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object
* ''' * @skipline getDimensions
* exampleDimensions = exampleGrid.getDimensions()
* @endcode
* *
* @return XdmfArray containing dimensions of this grid. * @return XdmfArray containing dimensions of this grid.
*/ */
...@@ -181,10 +163,9 @@ public: ...@@ -181,10 +163,9 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* //Assuming that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object * Assuming that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object
* shared_ptr<const XdmfArray> exampleDimensions = exampleGrid->getDimensions(); * @skipline const
* @endcode
* *
* Python: Python doesn't have a constant version * Python: Python doesn't have a constant version
* *
...@@ -199,19 +180,15 @@ public: ...@@ -199,19 +180,15 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* //Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object * Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* shared_ptr<XdmfGeometry> exampleGeometry = exampleGrid->getGeometry(); * @skipline getGeometry
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleCurvilinearGrid.py
* '''
* Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object * Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* ''' * @skipline getGeometry
* exampleGeometry = exampleGrid.getGeometry()
* @endcode
* *
* @return the geometry associated with this grid. * @return the geometry associated with this grid.
*/ */
...@@ -225,27 +202,18 @@ public: ...@@ -225,27 +202,18 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* shared_ptr<XdmfArray> newPoints = XdmfArray::New(); * @skipline XdmfArray::New
* newPoints->pushBack(5); * @until setDimensions
* newPoints->pushBack(5); * Assumng that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object
* newPoints->pushBack(5);
* //Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* exampleGrid->setDimensions(newPoints);
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleCurvilinearGrid.py
* newPoints = XdmfArray.New() * @skip setDimensions
* newPoints.pushBackAsInt32(5) * @skipline newPoints
* newPoints.pushBackAsInt32(5) * @until setDimensions
* newPoints.pushBackAsInt32(5)
* '''
* Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object * Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* '''
* exampleGrid.setDimensions(newPoints)
* @endcode
* *
* @param dimensions the dimension of the grid. * @param dimensions the dimension of the grid.
*/ */
...@@ -258,33 +226,18 @@ public: ...@@ -258,33 +226,18 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* shared_ptr<XdmfArray> newPoints = XdmfArray::New(); * @skipline newData
* newPoints->pushBack(5); * @until setGeometry
* newPoints->pushBack(5);
* newPoints->pushBack(5);
* shared_ptr<XdmfGeometry> newGeometry = XdmfGeometry::New();
* newGeometry->setType(XdmfGeometryType::XYZ());
* newGeometry->insert(0, newPoints, 0, 3, 1, 1);//Start index is 0, 3 values are passed, stride for both arrays is 1
* //Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* exampleGrid->setGeometry(newGeometry);
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleCurvilinearGrid.py
* newPoints = XdmfArray.New() * @skip setGeometry
* newPoints.pushBackAsInt32(5) * @skipline newPoints
* newPoints.pushBackAsInt32(5) * @until insert
* newPoints.pushBackAsInt32(5)
* newGeometry = XdmfGeometry.New()
* newGeometry.setType(XdmfGeometryType.XYZ())
* newGeometry.insert(0, newPoints, 0, 3, 1, 1)//Start index is 0, 3 values are passed, stride for both arrays is 1
* '''
* Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object * Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* ''' * @skipline setGeometry
* exampleGrid.setGeometry(newGeometry)
* @endcode
* *
* @param geometry an XdmfGeometry to associate with this grid. * @param geometry an XdmfGeometry to associate with this grid.
*/ */
......
...@@ -53,15 +53,13 @@ public: ...@@ -53,15 +53,13 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfDomain.cpp
* shared_ptr<XdmfDomain> exampleDomain = XdmfDomain::New(); * @skipline New
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleDomain.py
* exampleDomain = XdmfDomain.New(); * @skipline New
* @endcode
* *
* @return constructed XdmfDomain. * @return constructed XdmfDomain.
*/ */
......
...@@ -50,15 +50,13 @@ public: ...@@ -50,15 +50,13 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfGeometry.cpp
* shared_ptr<XdmfGeometry> exampleGeometry = XdmfGeometry::New(); * @skipline New
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleGeometry.py
* exampleGeometry = XdmfGeometry.New() * @skipline New
* @endcode
* *
* @return constructed XdmfGeometry. * @return constructed XdmfGeometry.
*/ */
...@@ -80,19 +78,15 @@ public: ...@@ -80,19 +78,15 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfGeometry.cpp
* //assuming that exampleGeometry is a shared pointer to a XdmfGeometry object that has been filled with data * assuming that exampleGeometry is a shared pointer to a XdmfGeometry object that has been filled with data
* unsigned int numPoints = exampleGeometry->getNumberPoints(); * @skipline getNumberPoints
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleGeometry.py
* '''
* assuming that exampleGeometry is a shared pointer to a XdmfGeometry object that has been filled with data * assuming that exampleGeometry is a shared pointer to a XdmfGeometry object that has been filled with data
* ''' * @skipline getNumberPoints
* numPoints = exampleGeometry.getNumberPoints()
* @endcode
*/ */
virtual unsigned int getNumberPoints() const; virtual unsigned int getNumberPoints() const;
...@@ -103,19 +97,15 @@ public: ...@@ -103,19 +97,15 @@ public:
* *
* C++ * C++
* *
* @code {.cpp} * @dontinclude ExampleXdmfGeometry.cpp
* //assuming that exampleGeometry is a shared pointer to a XdmfGeometry object * assuming that exampleGeometry is a shared pointer to a XdmfGeometry object
* shared_ptr<const XdmfGeometryType> exampleType = exampleGeometry->getType(); * @skipline getType
* @endcode
* *
* Python * Python
* *
* @code {.py} * @dontinclude XdmfExampleGeometry.py
* '''
* assuming that exampleGeometry is a shared pointer to a XdmfGeometry object * assuming that exampleGeometry is a shared pointer to a XdmfGeometry object
* ''' * @skipline getType
* exampleType = exampleGeometry.getType()
* @endcode
* *
* @return XdmfGeometryType of this geometry. * @return XdmfGeometryType of this geometry.
*/ */
...@@ -128,17 +118,15 @@ public: ...@@ -128,17 +118,15 @@ public:
* *
* C++ * C++
*