From 2d6761de494da85c0e6a8e14a3ec8cbbc814f179 Mon Sep 17 00:00:00 2001 From: rnv Date: Tue, 27 Mar 2012 13:45:22 +0000 Subject: [PATCH] 0021308: EDF 1923 SMESH: Remove hard-coded dependency of the external mesh plugins from the SMESH module: Update documentation. --- Makefile.am | 4 +-- configure.ac | 8 ++++++ doc/Makefile.am | 24 ++++++++++++++++ doc/salome/Makefile.am | 28 +++++++++++++++++++ ...e.doc => ghs3dplugin_python_interface.doc} | 2 +- doc/salome/gui/GHS3DPLUGIN/input/index.doc | 2 +- doc/salome/gui/Makefile.am | 26 +++++++++++++++++ resources/SalomeApp.xml | 3 ++ src/GHS3DPlugin/GHS3DPluginDC.py | 22 ++------------- 9 files changed, 96 insertions(+), 23 deletions(-) create mode 100644 doc/Makefile.am create mode 100644 doc/salome/Makefile.am rename doc/salome/gui/GHS3DPLUGIN/input/{ghs3dplugin_python_intarface.doc => ghs3dplugin_python_interface.doc} (99%) create mode 100644 doc/salome/gui/Makefile.am diff --git a/Makefile.am b/Makefile.am index ca82224..b60c7a1 100644 --- a/Makefile.am +++ b/Makefile.am @@ -40,9 +40,9 @@ else !GHS3DPLUGIN_ENABLE_GUI -I ${SMESH_ROOT_DIR}/adm_local/unix/config_files endif -SUBDIRS = idl adm_local resources src bin +SUBDIRS = idl adm_local resources src bin doc -DIST_SUBDIRS = idl adm_local resources src bin +DIST_SUBDIRS = idl adm_local resources src bin doc DISTCLEANFILES = a.out aclocal.m4 configure local-install.sh hack_libtool diff --git a/configure.ac b/configure.ac index 05c561d..19f9b47 100644 --- a/configure.ac +++ b/configure.ac @@ -430,6 +430,14 @@ AC_OUTPUT([ \ bin/VERSION \ bin/Makefile \ GHS3DPLUGIN_version.h \ + doc/Makefile \ + doc/salome/Makefile \ + doc/salome/gui/Makefile \ + doc/salome/gui/GHS3DPLUGIN/Makefile \ + doc/salome/gui/GHS3DPLUGIN/doxyfile \ + doc/salome/gui/GHS3DPLUGIN/doxyfile_py \ + doc/salome/gui/GHS3DPLUGIN/static/header.html \ + doc/salome/gui/GHS3DPLUGIN/static/header_py.html \ src/Makefile \ src/GUI/Makefile \ src/GHS3DPlugin/Makefile \ diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..40951f3 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,24 @@ +# Copyright (C) 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# +SUBDIRS = salome + +usr_docs: + (cd salome && $(MAKE) $(AM_MAKEFLAGS) usr_docs) + +docs: usr_docs diff --git a/doc/salome/Makefile.am b/doc/salome/Makefile.am new file mode 100644 index 0000000..1f9f5cb --- /dev/null +++ b/doc/salome/Makefile.am @@ -0,0 +1,28 @@ +# Copyright (C) 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +SUBDIRS = gui +SUBDIRSGUI = gui + +usr_docs: + @@SETX@; for d in $(SUBDIRSGUI); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done; + +docs: usr_docs \ No newline at end of file diff --git a/doc/salome/gui/GHS3DPLUGIN/input/ghs3dplugin_python_intarface.doc b/doc/salome/gui/GHS3DPLUGIN/input/ghs3dplugin_python_interface.doc similarity index 99% rename from doc/salome/gui/GHS3DPLUGIN/input/ghs3dplugin_python_intarface.doc rename to doc/salome/gui/GHS3DPLUGIN/input/ghs3dplugin_python_interface.doc index 9042bd4..f9ea4fa 100644 --- a/doc/salome/gui/GHS3DPLUGIN/input/ghs3dplugin_python_intarface.doc +++ b/doc/salome/gui/GHS3DPLUGIN/input/ghs3dplugin_python_interface.doc @@ -1,6 +1,6 @@ /*! -\page ghs3dplugin_python_intarface_page Python Interface +\page ghs3dplugin_python_interface_page Python Interface Python package \ref GHS3DPluginDC "GHS3DPlugin" defines several classes, destined for creation of the 3D meshes. diff --git a/doc/salome/gui/GHS3DPLUGIN/input/index.doc b/doc/salome/gui/GHS3DPLUGIN/input/index.doc index dab5c16..e39ba6d 100644 --- a/doc/salome/gui/GHS3DPLUGIN/input/index.doc +++ b/doc/salome/gui/GHS3DPLUGIN/input/index.doc @@ -16,7 +16,7 @@ license to be used within the Mesh module. To manage parameters of the GHS3DPLUGIN use \subpage ghs3d_hypo_page and \subpage additional_hypo_page Also all GHS3DPLUGIN functionalities are accessible via -\subpage ghs3dplugin_python_intarface_page "GHS3DPLUGIN Python interface". +\subpage ghs3dplugin_python_interface_page "GHS3DPLUGIN Python interface". \image html image2.gif "Example of a tetrahedral 3D mesh" diff --git a/doc/salome/gui/Makefile.am b/doc/salome/gui/Makefile.am new file mode 100644 index 0000000..e1c9554 --- /dev/null +++ b/doc/salome/gui/Makefile.am @@ -0,0 +1,26 @@ +# Copyright (C) 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# +include $(top_srcdir)/adm_local/unix/make_common_starter.am + +SUBDIRS = GHS3DPLUGIN + +usr_docs: + (cd GHS3DPLUGIN && $(MAKE) $(AM_MAKEFLAGS) usr_docs) + +docs: usr_docs diff --git a/resources/SalomeApp.xml b/resources/SalomeApp.xml index bca519a..8b9379f 100644 --- a/resources/SalomeApp.xml +++ b/resources/SalomeApp.xml @@ -26,4 +26,7 @@ +
+ +
diff --git a/src/GHS3DPlugin/GHS3DPluginDC.py b/src/GHS3DPlugin/GHS3DPluginDC.py index b2e7014..5cf2a1f 100644 --- a/src/GHS3DPlugin/GHS3DPluginDC.py +++ b/src/GHS3DPlugin/GHS3DPluginDC.py @@ -39,7 +39,6 @@ GHS3D = "GHS3D_3D" ## Tetrahedron GHS3D 3D algorithm # It is created by calling Mesh.Tetrahedron( GHS3D, geom=0 ) # -# @ingroup l3_algos_basic class GHS3D_Algorithm(Mesh_Algorithm): meshMethod = "Tetrahedron" @@ -54,7 +53,6 @@ class GHS3D_Algorithm(Mesh_Algorithm): ## Defines hypothesis having several parameters # - # @ingroup l3_hypos_ghs3dh def Parameters(self): if not self.params: self.params = self.Hypothesis("GHS3D_Parameters", [], @@ -62,7 +60,7 @@ class GHS3D_Algorithm(Mesh_Algorithm): return self.params ## To mesh "holes" in a solid or not. Default is to mesh. - # @ingroup l3_hypos_ghs3dh + # def SetToMeshHoles(self, toMesh): self.Parameters().SetToMeshHoles(toMesh) @@ -70,28 +68,25 @@ class GHS3D_Algorithm(Mesh_Algorithm): # None_Optimization, Light_Optimization, Standard_Optimization, StandardPlus_Optimization, # Strong_Optimization. # Default is Standard_Optimization - # @ingroup l3_hypos_ghs3dh def SetOptimizationLevel(self, level): self.Parameters().SetOptimizationLevel(level) ## Maximal size of memory to be used by the algorithm (in Megabytes). - # @ingroup l3_hypos_ghs3dh + # def SetMaximumMemory(self, MB): self.Parameters().SetMaximumMemory(MB) ## Initial size of memory to be used by the algorithm (in Megabytes) in # automatic memory adjustment mode. - # @ingroup l3_hypos_ghs3dh def SetInitialMemory(self, MB): self.Parameters().SetInitialMemory(MB) ## Path to working directory. - # @ingroup l3_hypos_ghs3dh + # def SetWorkingDirectory(self, path): self.Parameters().SetWorkingDirectory(path) ## To keep working files or remove them. Log file remains in case of errors anyway. - # @ingroup l3_hypos_ghs3dh def SetKeepFiles(self, toKeep): self.Parameters().SetKeepFiles(toKeep) @@ -103,18 +98,15 @@ class GHS3D_Algorithm(Mesh_Algorithm): #
  • 10 - same as 2 plus the main steps in the computation, quality statistics # histogram of the skin mesh, quality statistics histogram together with # the characteristics of the final mesh. - # @ingroup l3_hypos_ghs3dh def SetVerboseLevel(self, level): self.Parameters().SetVerboseLevel(level) ## To create new nodes. - # @ingroup l3_hypos_ghs3dh def SetToCreateNewNodes(self, toCreate): self.Parameters().SetToCreateNewNodes(toCreate) ## To use boundary recovery version which tries to create mesh on a very poor # quality surface mesh. - # @ingroup l3_hypos_ghs3dh def SetToUseBoundaryRecoveryVersion(self, toUse): self.Parameters().SetToUseBoundaryRecoveryVersion(toUse) @@ -122,12 +114,10 @@ class GHS3D_Algorithm(Mesh_Algorithm): # it is possible. The process is cutting first the overconstrained edges and # second the overconstrained facets. This insure that no edges have two boundary # vertices and that no facets have three boundary vertices. - # @ingroup l3_hypos_ghs3dh def SetFEMCorrection(self, toUseFem): self.Parameters().SetFEMCorrection(toUseFem) ## To removes initial central point. - # @ingroup l3_hypos_ghs3dh def SetToRemoveCentralPoint(self, toRemove): self.Parameters().SetToRemoveCentralPoint(toRemove) @@ -138,7 +128,6 @@ class GHS3D_Algorithm(Mesh_Algorithm): # @param size : size of 1D element around enforced vertex # @param vertexName : name of the enforced vertex # @param groupName : name of the group - # @ingroup l3_hypos_ghs3dh def SetEnforcedVertex(self, x, y, z, size, vertexName = "", groupName = ""): if vertexName == "": if groupName == "": @@ -155,7 +144,6 @@ class GHS3D_Algorithm(Mesh_Algorithm): # @param theVertex : GEOM vertex (or group, compound) to be projected on theFace. # @param size : size of 1D element around enforced vertex # @param groupName : name of the group - # @ingroup l3_hypos_ghs3dh def SetEnforcedVertexGeom(self, theVertex, size, groupName = ""): AssureGeomPublished( self.mesh, theVertex ) if groupName == "": @@ -167,13 +155,11 @@ class GHS3D_Algorithm(Mesh_Algorithm): # @param x : x coordinate # @param y : y coordinate # @param z : z coordinate - # @ingroup l3_hypos_ghs3dh def RemoveEnforcedVertex(self, x, y, z): return self.Parameters().RemoveEnforcedVertex(x, y, z) ## To remove an enforced vertex given a GEOM vertex, group or compound. # @param theVertex : GEOM vertex (or group, compound) to be projected on theFace. - # @ingroup l3_hypos_ghs3dh def RemoveEnforcedVertexGeom(self, theVertex): AssureGeomPublished( self.mesh, theVertex ) return self.Parameters().RemoveEnforcedVertexGeom(theVertex) @@ -183,7 +169,6 @@ class GHS3D_Algorithm(Mesh_Algorithm): # @param elementType : SMESH.ElementType (NODE, EDGE or FACE) # @param size : size of elements around enforced elements. Unused if -1. # @param groupName : group in which enforced elements will be added. Unused if "". - # @ingroup l3_hypos_ghs3dh def SetEnforcedMesh(self, theSource, elementType, size = -1, groupName = ""): if size >= 0: if groupName != "": @@ -197,7 +182,6 @@ class GHS3D_Algorithm(Mesh_Algorithm): return self.Parameters().SetEnforcedMeshSizeWithGroup(theSource, elementType, size, groupName) ## Sets command line option as text. - # @ingroup l3_hypos_ghs3dh def SetTextOption(self, option): self.Parameters().SetTextOption(option) -- 2.39.2