Skip to content

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

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

parent bef0a664
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 3015 additions and 2416 deletions
CMakeLists.txt
View file @ eee28dc6
project(Xdmf)
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)
SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR})
SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR})
......
XdmfAttribute.hpp
View file @ eee28dc6
......@@ -52,15 +52,13 @@ public:
*
* C++
*
* @code {.cpp}
* shared_ptr<XdmfAttribute> exampleAttribute = XdmfAttribute::New();
* @endcode
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline New
*
* Python
*
* @code {.py}
* exampleAttribute = XdmfAttribute.New()
* @endcode
* @dontinclude XdmfExampleAttribute.py
* @skipline New
*
* @return constructed XdmfAttribute.
*/
......@@ -78,19 +76,15 @@ public:
*
* C++
*
* @code {.cpp}
* //Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its center set
* shared_ptr<const XdmfAttributeCenter> exampleCenter = exampleAttribute->getCenter();
* @endcode
* @dontinclude ExampleXdmfAttribute.cpp
* Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its center set
* @skipline getCenter
*
* Python
*
* @code {.py}
* '''
* @dontinclude XdmfExampleAttribute.py
* Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its center set
* '''
* exampleCenter = exampleAttribute.getCenter()
* @endcode
* @skipline getCenter
*
* @return XdmfAttributeCenter of the attribute.
*/
......@@ -107,19 +101,15 @@ public:
*
* C++
*
* @code {.cpp}
* //Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object
* std::string exampleName = exampleAttribute->getName();
* @endcode
* @dontinclude ExampleXdmfAttribute.cpp
* Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object
* @skipline getName
*
* Python
*
* @code {.py}
* '''
* @dontinclude XdmfExampleAttribute.py
* Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object
* '''
* exampleName = exampleAttribute.getName()
* @endcode
* @skipline getName
*
* @return a string containing the name of the attribute.
*/
......@@ -132,19 +122,15 @@ public:
*
* C++
*
* @code {.cpp}
* //Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its type set
* shared_ptr<const XdmfAttributeType> exampleType = exampleAttribute->getType();
* @endcode
* @dontinclude ExampleXdmfAttribute.cpp
* Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its type set
* @skipline getType
*
* Python
*
* @code {.py}
* '''
* @dontinclude XdmfExampleAttribute.py
* Assuming that exampleAttribute is a shared pointer to an XdmfAttribute object with its type set
* '''
* exampleType = exampleAttribute.getType()
* @endcode
* @skipline getType
*
* @return XdmfAttributeType of the attribute.
*/
......@@ -157,17 +143,15 @@ public:
*
* C++
*
* @code {.cpp}
* shared_ptr<XdmfAttribute> exampleAttribute = XdmfAttribute::New();
* exampleAttribute->setCenter(XdmfAttributeCenter::Node());
* @endcode
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline New
* @skipline setCenter
*
* Python
*
* @code {.py}
* exampleAttribute = XdmfAttribute.New()
* exampleAttribute.setCenter(XdmfAttributeCenter.Node())
* @endcode
* @dontinclude XdmfExampleAttribute.py
* @skipline New
* @skipline setCenter
*
* @param center the XdmfAttributeCenter to set.
*/
......@@ -180,19 +164,17 @@ public:
*
* C++
*
* @code {.cpp}
* shared_ptr<XdmfAttribute> exampleAttribute = XdmfAttribute::New();
* std::string newName = "New Name";
* exampleAttribute->setName(newName);
* @endcode
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline New
* @skipline newName
* @skipline setName
*
* Python
*
* @code {.py}
* exampleAttribute = XdmfAttribute.New()
* newName = "New Name"
* exampleAttribute.setName(newName)
* @endcode
* @dontinclude XdmfExampleAttribute.py
* @skipline New
* @skipline newName
* @skipline setName
*
* @param name a string containing the name to set.
*/
......@@ -205,17 +187,15 @@ public:
*
* C++
*
* @code {.cpp}
* shared_ptr<XdmfAttribute> exampleAttribute = XdmfAttribute::New();
* exampleAttribute->setType(XdmfAttributeType::Node());
* @endcode
* @dontinclude ExampleXdmfAttribute.cpp
* @skipline New
* @skipline setType
*
* Python
*
* @code {.py}
* exampleAttribute = XdmfAttribute.New()
* exampleAttribute.setType(XdmfAttributeType.Node())
* @endcode
* @dontinclude XdmfExampleAttribute.py
* @skipline New
* @skipline setType
*
* @param type XdmfAttributeType to set.
*/
......
XdmfCurvilinearGrid.hpp
View file @ eee28dc6
......@@ -53,19 +53,16 @@ public:
*
* C++
*
* @code {.cpp}
* unsigned int newPointsX = 5;
* unsigned int newPointsY = 5;
* shared_ptr<XdmfCurvilinearGrid> exampleGrid = XdmfCurvilinearGrid::New(newPointsX, newPointsY);
* @endcode
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline newPointsX
* @until New
*
* Python
*
* @code {.py}
* newPointsX = 5
* newPointsY = 5
* exampleGrid = XdmfCurvilinearGrid.New(newPointsX, newPointsY)
* @endcode
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline newPointsX
* @until newPointsY
* @skipline newPointsX
*
* @param xNumPoints the number of points in the x direction.
* @param yNumPoints the number of points in the y direction.
......@@ -83,21 +80,17 @@ public:
*
* C++
*
* @code {.cpp}
* unsigned int newPointsX = 5;
* unsigned int newPointsY = 5;
* unsigned int newPointsZ = 5;
* shared_ptr<XdmfCurvilinearGrid> exampleGrid = XdmfCurvilinearGrid::New(newPointsX, newPointsY, newPointsZ);
* @endcode
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skip 3
* @skipline newPointsX
* @until New
*
* Python
*
* @code {.py}
* newPointsX = 5
* newPointsY = 5
* newPointsZ = 5
* exampleGrid = XdmfCurvilinearGrid.New(newPointsX, newPointsY, newPointsZ)
* @endcode
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline newPointsX
* @until newPointsZ
* @skipline newPointsZ
*
* @param xNumPoints the number of points in the x direction.
* @param yNumPoints the number of points in the y direction.
......@@ -117,23 +110,16 @@ public:
*
* C++
*
* @code {.cpp}
* shared_ptr<XdmfArray> newPoints = XdmfArray::New();
* newPoints->pushBack(5);
* newPoints->pushBack(5);
* newPoints->pushBack(5);
* shared_ptr<XdmfCurvilinearGrid> exampleGrid = XdmfCurvilinearGrid::New(newPoints);
* @endcode
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skip via
* @skipline newPoints
* @until XdmfCurvilinearGrid
*
* Python
*
* @code {.py}
* newPoints = XdmfArray.New()
* newPoints.pushBackAsInt32(5)
* newPoints.pushBackAsInt32(5)
* newPoints.pushBackAsInt32(5)
* exampleGrid = XdmfCurvilinearGrid.New(newPoints)
* @endcode
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline newPoints
* @until exampleGrid
*
* @param numPoints the number of points in each direction.
*
......@@ -155,19 +141,15 @@ public:
*
* C++
*
* @code {.cpp}
* //Assuming that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object
* shared_ptr<XdmfArray> exampleDimensions = exampleGrid->getDimensions();
* @endcode
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* Assuming that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object
* @skipline getDimensions
*
* Python
*
* @code {.py}
* '''
* @dontinclude XdmfExampleCurvilinearGrid.py
* Assuming that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object
* '''
* exampleDimensions = exampleGrid.getDimensions()
* @endcode
* @skipline getDimensions
*
* @return XdmfArray containing dimensions of this grid.
*/
......@@ -181,10 +163,9 @@ public:
*
* C++
*
* @code {.cpp}
* //Assuming that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object
* shared_ptr<const XdmfArray> exampleDimensions = exampleGrid->getDimensions();
* @endcode
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* Assuming that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object
* @skipline const
*
* Python: Python doesn't have a constant version
*
......@@ -199,19 +180,15 @@ public:
*
* C++
*
* @code {.cpp}
* //Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* shared_ptr<XdmfGeometry> exampleGeometry = exampleGrid->getGeometry();
* @endcode
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* @skipline getGeometry
*
* Python
*
* @code {.py}
* '''
* @dontinclude XdmfExampleCurvilinearGrid.py
* Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* '''
* exampleGeometry = exampleGrid.getGeometry()
* @endcode
* @skipline getGeometry
*
* @return the geometry associated with this grid.
*/
......@@ -225,27 +202,18 @@ public:
*
* C++
*
* @code {.cpp}
* shared_ptr<XdmfArray> newPoints = XdmfArray::New();
* newPoints->pushBack(5);
* newPoints->pushBack(5);
* newPoints->pushBack(5);
* //Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* exampleGrid->setDimensions(newPoints);
* @endcode
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline XdmfArray::New
* @until setDimensions
* Assumng that exampleGrid is a shared pointer to an XdmfCurvilinearGrid object
*
* Python
*
* @code {.py}
* newPoints = XdmfArray.New()
* newPoints.pushBackAsInt32(5)
* newPoints.pushBackAsInt32(5)
* newPoints.pushBackAsInt32(5)
* '''
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skip setDimensions
* @skipline newPoints
* @until setDimensions
* Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* '''
* exampleGrid.setDimensions(newPoints)
* @endcode
*
* @param dimensions the dimension of the grid.
*/
......@@ -258,33 +226,18 @@ public:
*
* C++
*
* @code {.cpp}
* shared_ptr<XdmfArray> newPoints = XdmfArray::New();
* newPoints->pushBack(5);
* 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
* @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline newData
* @until setGeometry
*
* Python
*
* @code {.py}
* newPoints = XdmfArray.New()
* newPoints.pushBackAsInt32(5)
* newPoints.pushBackAsInt32(5)
* 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
* '''
* @dontinclude XdmfExampleCurvilinearGrid.py
* @skip setGeometry
* @skipline newPoints
* @until insert
* Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object
* '''
* exampleGrid.setGeometry(newGeometry)
* @endcode
* @skipline setGeometry
*
* @param geometry an XdmfGeometry to associate with this grid.
*/
......
XdmfDomain.hpp
View file @ eee28dc6
......@@ -53,15 +53,13 @@ public:
*
* C++
*
* @code {.cpp}
* shared_ptr<XdmfDomain> exampleDomain = XdmfDomain::New();
* @endcode
* @dontinclude ExampleXdmfDomain.cpp
* @skipline New
*
* Python
*
* @code {.py}
* exampleDomain = XdmfDomain.New();
* @endcode
* @dontinclude XdmfExampleDomain.py
* @skipline New
*
* @return constructed XdmfDomain.
*/
......
XdmfGeometry.hpp
View file @ eee28dc6
......@@ -50,15 +50,13 @@ public:
*
* C++
*
* @code {.cpp}
* shared_ptr<XdmfGeometry> exampleGeometry = XdmfGeometry::New();
* @endcode
* @dontinclude ExampleXdmfGeometry.cpp
* @skipline New
*
* Python
*
* @code {.py}
* exampleGeometry = XdmfGeometry.New()
* @endcode
* @dontinclude XdmfExampleGeometry.py
* @skipline New
*
* @return constructed XdmfGeometry.
*/
......@@ -80,19 +78,15 @@ public:
*
* C++
*
* @code {.cpp}
* //assuming that exampleGeometry is a shared pointer to a XdmfGeometry object that has been filled with data
* unsigned int numPoints = exampleGeometry->getNumberPoints();
* @endcode
* @dontinclude ExampleXdmfGeometry.cpp
* assuming that exampleGeometry is a shared pointer to a XdmfGeometry object that has been filled with data
* @skipline getNumberPoints
*
* Python
*
* @code {.py}
* '''
* @dontinclude XdmfExampleGeometry.py
* assuming that exampleGeometry is a shared pointer to a XdmfGeometry object that has been filled with data
* '''
* numPoints = exampleGeometry.getNumberPoints()
* @endcode
* @skipline getNumberPoints
*/
virtual unsigned int getNumberPoints() const;
......@@ -103,19 +97,15 @@ public:
*
* C++
*
* @code {.cpp}
* //assuming that exampleGeometry is a shared pointer to a XdmfGeometry object
* shared_ptr<const XdmfGeometryType> exampleType = exampleGeometry->getType();
* @endcode
* @dontinclude ExampleXdmfGeometry.cpp
* assuming that exampleGeometry is a shared pointer to a XdmfGeometry object
* @skipline getType
*
* Python
*
* @code {.py}
* '''
* @dontinclude XdmfExampleGeometry.py
* assuming that exampleGeometry is a shared pointer to a XdmfGeometry object
* '''
* exampleType = exampleGeometry.getType()
* @endcode
* @skipline getType
*
* @return XdmfGeometryType of this geometry.
*/
......@@ -128,17 +118,15 @@ public:
*
* C++
*
* @code {.cpp}
* shared_ptr<XdmfGeometry> exampleGeometry = XdmfGeometry::New();
* exampleGeometry->setType(XdmfGeometryType::XYZ());
* @endcode
* @dontinclude ExampleXdmfGeometry.cpp
* @skipline New
* @skipline setType
*
* Python
*
* @code {.py}
* exampleGeometry = XdmfGeometry.New()
* exampleGeometry.setType(XdmfGeometryType.XYZ())
* @endcode
* @dontinclude XdmfExampleGeometry.py
* @skipline New
* @skipline setType
*
* @param type the XdmfGeometryType to set.
*/
......
XdmfGeometryType.hpp
View file @ eee28dc6
......@@ -70,19 +70,15 @@ public:
*
* C++
*
* @code {.cpp}
* unsigned int exampleDimensions = XdmfGeometryType::XYZ()->getDimensions();
* //The variable exampleDimensions now holds the number of dimensions that XYZ has
* @endcode
* @dontinclude ExampleXdmfGeometryType.cpp
* @skipline getDimensions
* The variable exampleDimensions now holds the number of dimensions that XYZ has
*
* Python
*
* @code {.py}
* exampleDimensions = XdmfGeometryType.XYZ().getDimensions()
* '''
* @dontinclude XdmfExampleGeometryType.py
* @skipline getDimensions
* The variable exampleDimensions now holds the number of dimensions that XYZ has
* '''
* @endcode
*
* @return an int containing number of dimensions.
*/
......@@ -95,19 +91,15 @@ public:
*
* C++
*
* @code {.cpp}
* std::string exampleName = XdmfGeometryType::XYZ()->getName();
* //The variable exampleName now holds the name of XYZ
* @endcode
* @dontinclude ExampleXdmfGeometryType.cpp
* @skipline getName
* The variable exampleName now holds the name of XYZ
*
* Python
*
* @code {.py}
* exampleName = XdmfGeometryType.XYZ().getName()
* '''
* @dontinclude XdmfExampleGeometryType.py
* @skipline getName
* The variable exampleName now holds the name of XYZ
* '''
* @endcode
*
* @return the name of this geometry type.
*/
......
XdmfGrid.hpp
View file @ eee28dc6
......@@ -70,21 +70,17 @@ public:
*
* C++
*
8 @code {.cpp}
* //using an unstructured grid since XdmfGrid is an abstract class
* //Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* shared_ptr<const XdmfGeometry> exampleGeometry = exampleGrid->getGeometry();
* @endcode
* @dontinclude ExampleXdmfGrid.cpp
* using an unstructured grid since XdmfGrid is an abstract class
* Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* @skipline getGeometry
*
* Python
*
* @code {.py}
* '''
* @dontinclude XdmfExampleGrid.py
* using an unstructured grid since XdmfGrid is an abstract class
* Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* '''
* exampleGeometry = exampleGrid.getGeometry()
* @endcode
* @skipline getGeometry
*
* @return the geometry associated with this grid.
*/
......@@ -101,21 +97,17 @@ public:
*
* C++
*
* @code {.cpp}
* //using an unstructured grid since XdmfGrid is an abstract class
* //Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* std::string exampleName = exampleGrid->getName();
* @endcode
* @dontinclude ExampleXdmfGrid.cpp
* Using an unstructured grid since XdmfGrid is an abstract class
* Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* @skipline getName
*
* Python
*
* @code {.py}
* '''
* using an unstructured grid since XdmfGrid is an abstract class
* @dontinclude XdmfExampleGrid.py
* Using an unstructured grid since XdmfGrid is an abstract class
* Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* '''
* exampleName = exampleGrid.getName()
* @endcode
* @skipline getName
*
* @return the name of the grid.
*/
......@@ -128,21 +120,17 @@ public:
*
* C++
*
* @code {.cpp}
* //using an unstructured grid since XdmfGrid is an abstract class
* //Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* shared_ptr<XdmfTime> exampleTime = exampleGrid->getTime();
* @endcode
* @dontinclude ExampleXdmfGrid.cpp
* Using an unstructured grid since XdmfGrid is an abstract class
* Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* @skipline getTime
*
* Python
*
* @code {.py}
* '''
* using an unstructured grid since XdmfGrid is an abstract class
* @dontinclude XdmfExampleGrid.py
* Using an unstructured grid since XdmfGrid is an abstract class
* Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* '''
* exampleTime = exampleGrid.getTime()
* @endcode
* @skipline getTime
*
* @return pointer to the XdmfTime attached to this grid. If no
* XdmfTime is attached, return a NULL pointer.
......@@ -156,11 +144,10 @@ public:
*
* C++
*
* @code {.cpp}
* //using an unstructured grid since XdmfGrid is an abstract class
* //Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* shared_ptr<const XdmfTime> exampleTime = exampleGrid->getTime();
* @endcode
* @dontinclude ExampleXdmfGrid.cpp
* Using an unstructured grid since XdmfGrid is an abstract class
* Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* @skipline exampleTimeConst
*
* Python: Python doesn't have a constant version
*
......@@ -176,21 +163,17 @@ public:
*
* C++
*
* @code {.cpp}
* //using an unstructured grid since XdmfGrid is an abstract class
* //Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* shared_ptr<const XdmfTopology> exampleTopology = exampleGrid->getTopology();
* @endcode
* @dontinclude ExampleXdmfGrid.cpp
* Using an unstructured grid since XdmfGrid is an abstract class
* Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* @skipline getTopology
*
* Python
*
* @code {.py}
* '''
* using an unstructured grid since XdmfGrid is an abstract class
* @dontinclude XdmfExampleGrid.py
* Using an unstructured grid since XdmfGrid is an abstract class
* Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* '''
* exampleTopology = exampleGrid.getTopology()
* @endcode
* @skipline getTopology
*
* @return the topology associated with this grid.
*/
......@@ -205,23 +188,19 @@ public:
*
* C++
*
* @code {.cpp}
* //using an unstructured grid since XdmfGrid is an abstract class
* //Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* std::string newName = "New Name";
* exampleGrid->setName(newName);
* @endcode
* @dontinclude ExampleXdmfGrid.cpp
* Using an unstructured grid since XdmfGrid is an abstract class
* Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* @skipline newName
* @skipline setName
*
* Python
*
* @code {.py}
* '''
* using an unstructured grid since XdmfGrid is an abstract class
* @dontinclude XdmfExampleGrid.py
* Using an unstructured grid since XdmfGrid is an abstract class
* Assumming that exampleGrid is a shared pointer to an XdmfUnstructuredGrid object
* '''
* newName = "New Name"
* exampleGrid.setName(newName)
* @endcode
* @skipline newName
* @skipline setName
*
* @param name of the grid to set.
*/
......@@ -234,23 +213,19 @@ public:
*
* C++
*
* @code {.cpp}