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) ...@@ -225,6 +225,7 @@ if(NOT XDMF_BUILD_CORE_ONLY)
XdmfAttributeType XdmfAttributeType
XdmfCurvilinearGrid XdmfCurvilinearGrid
XdmfDomain XdmfDomain
XdmfFunction
XdmfGeometry XdmfGeometry
XdmfGeometryType XdmfGeometryType
XdmfGraph XdmfGraph
......
This diff is collapsed.
...@@ -53,12 +53,14 @@ public: ...@@ -53,12 +53,14 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfAttribute.cpp * @dontinclude ExampleXdmfAttribute.cpp
* @skipline New * @skipline //#initialization
* @until //#initialization
* *
* Python * Python
* *
* @dontinclude XdmfExampleAttribute.py * @dontinclude XdmfExampleAttribute.py
* @skipline New * @skipline #//initialization
* @until #//initialization
* *
* @return constructed XdmfAttribute. * @return constructed XdmfAttribute.
*/ */
...@@ -77,14 +79,22 @@ public: ...@@ -77,14 +79,22 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfAttribute.cpp * @dontinclude ExampleXdmfAttribute.cpp
* @skipline Assuming * @skipline //#initialization
* @skipline getCenter * @until //#initialization
* @skipline //#setCenter
* @until //#setCenter
* @skipline //#getCenter
* @until //#getCenter
* *
* Python * Python
* *
* @dontinclude XdmfExampleAttribute.py * @dontinclude XdmfExampleAttribute.py
* @skipline Assuming * @skipline #//initialization
* @skipline getCenter * @until #//initialization
* @skipline #//setCenter
* @until #//setCenter
* @skipline #//getCenter
* @until #//getCenter
* *
* @return XdmfAttributeCenter of the attribute. * @return XdmfAttributeCenter of the attribute.
*/ */
...@@ -102,14 +112,22 @@ public: ...@@ -102,14 +112,22 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfAttribute.cpp * @dontinclude ExampleXdmfAttribute.cpp
* @skipline Assuming * @skipline //#initialization
* @skipline getName * @until //#initialization
* @skipline //#setName
* @until //#setName
* @skipline //#getName
* @until //#getName
* *
* Python * Python
* *
* @dontinclude XdmfExampleAttribute.py * @dontinclude XdmfExampleAttribute.py
* @skipline Assuming * @skipline #//initialization
* @skipline getName * @until #//initialization
* @skipline #//setName
* @until #//setName
* @skipline #//getName
* @until #//getName
* *
* @return a string containing the name of the attribute. * @return a string containing the name of the attribute.
*/ */
...@@ -123,14 +141,22 @@ public: ...@@ -123,14 +141,22 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfAttribute.cpp * @dontinclude ExampleXdmfAttribute.cpp
* @skipline Assuming * @skipline //#initialization
* @skipline getType * @until //#initialization
* @skipline //#setType
* @until //#setType
* @skipline //#getType
* @until //#getType
* *
* Python * Python
* *
* @dontinclude XdmfExampleAttribute.py * @dontinclude XdmfExampleAttribute.py
* @skipline Assuming * @skipline #//initialization
* @skipline getType * @until #//initialization
* @skipline #//setType
* @until #//setType
* @skipline #//getType
* @until #//getType
* *
* @return XdmfAttributeType of the attribute. * @return XdmfAttributeType of the attribute.
*/ */
...@@ -144,14 +170,18 @@ public: ...@@ -144,14 +170,18 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfAttribute.cpp * @dontinclude ExampleXdmfAttribute.cpp
* @skipline New * @skipline //#initialization
* @skipline setCenter * @until //#initialization
* @skipline //#setCenter
* @until //#setCenter
* *
* Python * Python
* *
* @dontinclude XdmfExampleAttribute.py * @dontinclude XdmfExampleAttribute.py
* @skipline New * @skipline #//initialization
* @skipline setCenter * @until #//initialization
* @skipline #//setCenter
* @until #//setCenter
* *
* @param center the XdmfAttributeCenter to set. * @param center the XdmfAttributeCenter to set.
*/ */
...@@ -165,16 +195,18 @@ public: ...@@ -165,16 +195,18 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfAttribute.cpp * @dontinclude ExampleXdmfAttribute.cpp
* @skipline New * @skipline //#initialization
* @skipline newName * @until //#initialization
* @skipline setName * @skipline //#setName
* @until //#setName
* *
* Python * Python
* *
* @dontinclude XdmfExampleAttribute.py * @dontinclude XdmfExampleAttribute.py
* @skipline New * @skipline #//initialization
* @skipline newName * @until #//initialization
* @skipline setName * @skipline #//setName
* @until #//setName
* *
* @param name a string containing the name to set. * @param name a string containing the name to set.
*/ */
...@@ -188,14 +220,18 @@ public: ...@@ -188,14 +220,18 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfAttribute.cpp * @dontinclude ExampleXdmfAttribute.cpp
* @skipline New * @skipline //#initialization
* @skipline setType * @until //#initialization
* @skipline //#setType
* @until //#setType
* *
* Python * Python
* *
* @dontinclude XdmfExampleAttribute.py * @dontinclude XdmfExampleAttribute.py
* @skipline New * @skipline #//initialization
* @skipline setType * @until #//initialization
* @skipline #//setType
* @until #//setType
* *
* @param type XdmfAttributeType to set. * @param type XdmfAttributeType to set.
*/ */
......
...@@ -42,14 +42,22 @@ ...@@ -42,14 +42,22 @@
* C++ * C++
* *
* @dontinclude ExampleXdmfAttribute.cpp * @dontinclude ExampleXdmfAttribute.cpp
* @skipline exampleCenter * @skipline //#initialization
* @until } * @until //#initialization
* @skipline //#setCenter
* @until //#setCenter
* @skipline //#getCenter
* @until //#getCenter
* *
* Python * Python
* *
* @dontinclude XdmfExampleAttribute.py * @dontinclude XdmfExampleAttribute.py
* @skipline exampleCenter * @skipline #//initialization
* @until do * @until #//initialization
* @skipline #//setCenter
* @until #//setCenter
* @skipline #//getCenter
* @until #//getCenter
* *
* Grid * Grid
* Cell * Cell
......
...@@ -42,14 +42,22 @@ ...@@ -42,14 +42,22 @@
* C++ * C++
* *
* @dontinclude ExampleXdmfAttribute.cpp * @dontinclude ExampleXdmfAttribute.cpp
* @skipline exampleType * @skipline //#initialization
* @until } * @until //#initialization
* @skipline //#setType
* @until //#setType
* @skipline //#getType
* @until //#getType
* *
* Python * Python
* *
* @dontinclude XdmfExampleAttribute.py * @dontinclude XdmfExampleAttribute.py
* @skipline exampleType * @skipline #//initialization
* @until do * @until #//initialization
* @skipline #//setType
* @until #//setType
* @skipline #//getType
* @until #//getType
* *
* Xdmf supports the following attribute types: * Xdmf supports the following attribute types:
* NoAttributeType * NoAttributeType
......
...@@ -182,7 +182,7 @@ public: ...@@ -182,7 +182,7 @@ public:
private: private:
XdmfTopologyTypeCurvilinear(const XdmfCurvilinearGrid * const curvilinearGrid) : 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) mCurvilinearGrid(curvilinearGrid)
{ {
} }
......
...@@ -54,15 +54,16 @@ public: ...@@ -54,15 +54,16 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfCurvilinearGrid.cpp * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline newPointsX * @skipline //#initializationdim2
* @until New * @until //#initializationdim2
* *
* Python * Python
* *
* @dontinclude XdmfExampleCurvilinearGrid.py * @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline newPointsX * @skipline #//initialization
* @until newPointsY * @until #//initialization
* @skipline newPointsX * @skipline #//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.
...@@ -81,16 +82,16 @@ public: ...@@ -81,16 +82,16 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfCurvilinearGrid.cpp * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skip 3 * @skipline //#initializationdim3
* @skipline newPointsX * @until //#initializationdim3
* @until New
* *
* Python * Python
* *
* @dontinclude XdmfExampleCurvilinearGrid.py * @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline newPointsX * @skipline #//initialization
* @until newPointsZ * @until #//initialization
* @skipline newPointsZ * @skipline #//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.
...@@ -111,15 +112,16 @@ public: ...@@ -111,15 +112,16 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfCurvilinearGrid.cpp * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skip via * @skipline //#initializationvector
* @skipline newPoints * @until //#initializationvector
* @until XdmfCurvilinearGrid
* *
* Python * Python
* *
* @dontinclude XdmfExampleCurvilinearGrid.py * @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline newPoints * @skipline #//initialization
* @until exampleGrid * @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
* *
* @param numPoints the number of points in each direction. * @param numPoints the number of points in each direction.
* *
...@@ -142,14 +144,24 @@ public: ...@@ -142,14 +144,24 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfCurvilinearGrid.cpp * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline Assuming * @skipline //#initializationdim3
* @skipline getDimensions * @until //#initializationdim3
* @skipline //#setDimensions
* @until //#setDimensions
* @skipline //#getDimensions
* @until //#getDimensions
* *
* Python * Python
* *
* @dontinclude XdmfExampleCurvilinearGrid.py * @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline Assuming * @skipline #//initialization
* @skipline getDimensions * @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
* @skipline #//setDimensions
* @until #//setDimensions
* @skipline #//getDimensions
* @until #//getDimensions
* *
* @return XdmfArray containing dimensions of this grid. * @return XdmfArray containing dimensions of this grid.
*/ */
...@@ -164,8 +176,12 @@ public: ...@@ -164,8 +176,12 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfCurvilinearGrid.cpp * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline Assuming * @skipline //#initializationdim3
* @skipline const * @until //#initializationdim3
* @skipline //#setDimensions
* @until //#setDimensions
* @skipline //#getDimensionsconst
* @until //#getDimensionsconst
* *
* Python: Python doesn't have a constant version * Python: Python doesn't have a constant version
* *
...@@ -181,14 +197,24 @@ public: ...@@ -181,14 +197,24 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfCurvilinearGrid.cpp * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline Assuming * @skipline //#initializationdim3
* @skipline getGeometry * @until //#initializationdim3
* @skipline //#setGeometry
* @until //#setGeometry
* @skipline //#getGeometry
* @until //#getGeometry
* *
* Python * Python
* *
* @dontinclude XdmfExampleCurvilinearGrid.py * @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline Assuming * @skipline #//initialization
* @skipline getGeometry * @until #//initialization
* @skipline #//constructorvector
* @until #//constructorvector
* @skipline #//setGeometry
* @until #//setGeometry
* @skipline #//getGeometry
* @until #//getGeometry
* *
* @return the geometry associated with this grid. * @return the geometry associated with this grid.
*/ */
...@@ -203,18 +229,20 @@ public: ...@@ -203,18 +229,20 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfCurvilinearGrid.cpp * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline Assuming * @skipline //#initializationdim3
* @skipline XdmfArray::New * @until //#initializationdim3
* @until setDimensions * @skipline //#setDimensions
* @until //#setDimensions
* *
* Python * Python
* *
* @dontinclude XdmfExampleCurvilinearGrid.py * @dontinclude XdmfExampleCurvilinearGrid.py
* @skipline Assuming * @skipline #//initialization
* @skip setDimensions * @until #//initialization
* @skipline newPoints * @skipline #//constructorvector
* @until setDimensions * @until #//constructorvector
* Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object * @skipline #//setDimensions
* @until #//setDimensions
* *
* @param dimensions the dimension of the grid. * @param dimensions the dimension of the grid.
*/ */
...@@ -228,17 +256,20 @@ public: ...@@ -228,17 +256,20 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfCurvilinearGrid.cpp * @dontinclude ExampleXdmfCurvilinearGrid.cpp
* @skipline newData * @skipline //#initializationdim3
* @until setGeometry * @until //#initializationdim3
* @skipline //#setGeometry
* @until //#setGeometry
* *
* Python * Python
* *
* @dontinclude XdmfExampleCurvilinearGrid.py * @dontinclude XdmfExampleCurvilinearGrid.py
* @skip setGeometry * @skipline #//initialization
* @skipline newPoints * @until #//initialization
* @until insert * @skipline #//constructorvector
* Assuming that exampleGrid is a sharedPointer to an XdmfCurvilinearGrid object * @until #//constructorvector
* @skipline setGeometry * @skipline #//setGeometry
* @until #//setGeometry
* *
* @param geometry an XdmfGeometry to associate with this grid. * @param geometry an XdmfGeometry to associate with this grid.
*/ */
......
...@@ -55,12 +55,14 @@ public: ...@@ -55,12 +55,14 @@ public:
* C++ * C++
* *
* @dontinclude ExampleXdmfDomain.cpp * @dontinclude ExampleXdmfDomain.cpp
* @skipline New * @skipline //#initialization
* @until //#initialization
* *
* Python * Python
* *
* @dontinclude XdmfExampleDomain.py * @dontinclude XdmfExampleDomain.py
* @skipline New * @skipline #//initialization
* @until #//initialization
* *
* @return constructed XdmfDomain. * @return constructed XdmfDomain.
*/ */
......
This diff is collapsed.
/*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfFunction.hpp */
/* */
/* Author: */
/* Kenneth Leiter */
/* kenneth.leiter@arl.army.mil */
/* US Army Research Laboratory */
/* Aberdeen Proving Ground, MD */
/* */
/* Copyright @ 2011 US Army Research Laboratory */
/* All Rights Reserved */
/* See Copyright.txt for details */
/* */
/* This software is distributed WITHOUT ANY WARRANTY; without */
/* even the implied warranty of MERCHANTABILITY or FITNESS */
/* FOR A PARTICULAR PURPOSE. See the above copyright notice */
/* for more information. */
/* */
/*****************************************************************************/
#ifndef XDMFFUNCTION_HPP_
#define XDMFFUNCTION_HPP_
// Includes
#include "Xdmf.hpp"
#include "XdmfArray.hpp"
/**
* @brief
*
*
*/