From 99067a8b3db3c45449be2af249c7485e6586a9ca Mon Sep 17 00:00:00 2001 From: vbd Date: Fri, 14 Sep 2007 08:17:52 +0000 Subject: [PATCH] staffan : * updated doc --- src/INTERP_KERNEL/Interpolation3D.hxx | 2 +- src/INTERP_KERNEL/MeshElement.hxx | 2 +- src/INTERP_KERNEL/RegionNode.hxx | 2 +- src/INTERP_KERNEL/TargetIntersector.hxx | 10 ++++- src/INTERP_KERNEL/Test/MeshTestToolkit.hxx | 44 +++++++++++----------- 5 files changed, 34 insertions(+), 26 deletions(-) diff --git a/src/INTERP_KERNEL/Interpolation3D.hxx b/src/INTERP_KERNEL/Interpolation3D.hxx index c89b36523..1d8c326df 100644 --- a/src/INTERP_KERNEL/Interpolation3D.hxx +++ b/src/INTERP_KERNEL/Interpolation3D.hxx @@ -23,7 +23,7 @@ class Interpolation3DTest; namespace MEDMEM { /** - * Class used to calculate the volumes of intersection between the elements of two 3D meshes. + * \brief Class used to calculate the volumes of intersection between the elements of two 3D meshes. * */ class Interpolation3D : public Interpolation diff --git a/src/INTERP_KERNEL/MeshElement.hxx b/src/INTERP_KERNEL/MeshElement.hxx index e91359a39..933397aa1 100644 --- a/src/INTERP_KERNEL/MeshElement.hxx +++ b/src/INTERP_KERNEL/MeshElement.hxx @@ -84,7 +84,7 @@ namespace INTERP_UTILS /** - * Class defining an order for MeshElements based on their bounding boxes. + * \brief Class defining an order for MeshElements based on their bounding boxes. * The order defined between two elements is that between a given coordinate of * their bounding boxes. For instance, if the order is based on YMIN, an element whose boxes * has a smaller YMIN is sorted before one with a larger YMIN. diff --git a/src/INTERP_KERNEL/RegionNode.hxx b/src/INTERP_KERNEL/RegionNode.hxx index 8820abb11..99c866f5b 100644 --- a/src/INTERP_KERNEL/RegionNode.hxx +++ b/src/INTERP_KERNEL/RegionNode.hxx @@ -7,7 +7,7 @@ namespace INTERP_UTILS { /** - * Class containing a tuplet of a source region and a target region. + * \brief Class containing a tuplet of a source region and a target region. * This is used as the object to put on the stack in the depth-first search * in the bounding-box filtering process. */ diff --git a/src/INTERP_KERNEL/TargetIntersector.hxx b/src/INTERP_KERNEL/TargetIntersector.hxx index ffd4b0743..e3080af38 100644 --- a/src/INTERP_KERNEL/TargetIntersector.hxx +++ b/src/INTERP_KERNEL/TargetIntersector.hxx @@ -3,13 +3,21 @@ namespace INTERP_UTILS { + /** + * \brief Abstract base class of Intersector classes. + * These classes represent a target element and calculate its intersection + * with the source elements. + */ class TargetIntersector { public: + + /// Virtual destructor virtual ~TargetIntersector() {} /** - * Calculate the volume of the intersection of two cells + * Calculate the volume of the intersection between target cell + * and the given source cell. * * @param srcCell global number of the source cell */ diff --git a/src/INTERP_KERNEL/Test/MeshTestToolkit.hxx b/src/INTERP_KERNEL/Test/MeshTestToolkit.hxx index ee42b7060..59eed4cc2 100644 --- a/src/INTERP_KERNEL/Test/MeshTestToolkit.hxx +++ b/src/INTERP_KERNEL/Test/MeshTestToolkit.hxx @@ -14,46 +14,46 @@ using namespace INTERP_UTILS; namespace INTERP_TEST { -class MeshTestToolkit -{ + class MeshTestToolkit + { -public: + public: - MeshTestToolkit() : _interpolator(new Interpolation3D()) {} + MeshTestToolkit() : _interpolator(new Interpolation3D()) {} - ~MeshTestToolkit() { delete _interpolator; } + ~MeshTestToolkit() { delete _interpolator; } - void intersectMeshes(const char* mesh1, const char* mesh2, const double correctVol, const double prec = 1.0e-5, bool doubleTest = true) const; + void intersectMeshes(const char* mesh1, const char* mesh2, const double correctVol, const double prec = 1.0e-5, bool doubleTest = true) const; - // 1.0e-5 here is due to limited precision of "correct" volumes calculated in Salome - void intersectMeshes(const char* mesh1path, const char* mesh1, const char* mesh2path, const char* mesh2, const double correctVol, const double prec = 1.0e-5, bool doubleTest = true) const; + // 1.0e-5 here is due to limited precision of "correct" volumes calculated in Salome + void intersectMeshes(const char* mesh1path, const char* mesh1, const char* mesh2path, const char* mesh2, const double correctVol, const double prec = 1.0e-5, bool doubleTest = true) const; - void dumpIntersectionMatrix(const IntersectionMatrix& m) const; + void dumpIntersectionMatrix(const IntersectionMatrix& m) const; - double sumRow(const IntersectionMatrix& m, int i) const; + double sumRow(const IntersectionMatrix& m, int i) const; - double sumCol(const IntersectionMatrix& m, int i) const; + double sumCol(const IntersectionMatrix& m, int i) const; - void getVolumes( MEDMEM::MESH& mesh,const double*& tab) const; + void getVolumes( MEDMEM::MESH& mesh,const double*& tab) const; - bool testVolumes(const IntersectionMatrix& m, MEDMEM::MESH& sMesh, MEDMEM::MESH& tMesh) const; + bool testVolumes(const IntersectionMatrix& m, MEDMEM::MESH& sMesh, MEDMEM::MESH& tMesh) const; - double sumVolume(const IntersectionMatrix& m) const; + double sumVolume(const IntersectionMatrix& m) const; - bool areCompatitable( const IntersectionMatrix& m1, const IntersectionMatrix& m2) const; + bool areCompatitable( const IntersectionMatrix& m1, const IntersectionMatrix& m2) const; - bool testSymmetric(const IntersectionMatrix& m1, const IntersectionMatrix& m2) const; + bool testSymmetric(const IntersectionMatrix& m1, const IntersectionMatrix& m2) const; - bool testDiagonal(const IntersectionMatrix& m) const; + bool testDiagonal(const IntersectionMatrix& m) const; - void calcIntersectionMatrix(const char* mesh1path, const char* mesh1, const char* mesh2path, const char* mesh2, IntersectionMatrix& m) const; + void calcIntersectionMatrix(const char* mesh1path, const char* mesh1, const char* mesh2path, const char* mesh2, IntersectionMatrix& m) const; - std::pair countNumberOfMatrixEntries(const IntersectionMatrix& m); + std::pair countNumberOfMatrixEntries(const IntersectionMatrix& m); -protected: + protected: - Interpolation3D* _interpolator; + Interpolation3D* _interpolator; -}; + }; } #endif -- 2.39.2