diff --git a/docs/source/affine.rst b/docs/source/affine.rst new file mode 100644 index 0000000..853a5d7 --- /dev/null +++ b/docs/source/affine.rst @@ -0,0 +1,5 @@ +Affine +===================== + +.. automodule:: pygem.affine + :members: diff --git a/docs/source/affine_trans.rst b/docs/source/affine_trans.rst deleted file mode 100644 index af8f154..0000000 --- a/docs/source/affine_trans.rst +++ /dev/null @@ -1,5 +0,0 @@ -Affine Transformation -===================== - -.. automodule:: pygem.affine_trans - :members: diff --git a/docs/source/code.rst b/docs/source/code.rst index c445242..be9b44a 100644 --- a/docs/source/code.rst +++ b/docs/source/code.rst @@ -6,8 +6,8 @@ Code Documentation :maxdepth: 2 - affine_trans - free_form - ffd_parameters - file_handler + affine + freeform + params + filehandler diff --git a/docs/source/file_handler.rst b/docs/source/filehandler.rst similarity index 78% rename from docs/source/file_handler.rst rename to docs/source/filehandler.rst index c22b353..a3178a4 100644 --- a/docs/source/file_handler.rst +++ b/docs/source/filehandler.rst @@ -1,7 +1,7 @@ -File Handler +Filehandler ================= -.. automodule:: pygem.file_handler +.. automodule:: pygem.filehandler .. autoclass:: FileHandler :members: @@ -12,6 +12,11 @@ File Handler :private-members: :special-members: +.. autoclass:: VtkHandler + :members: + :private-members: + :special-members: + .. autoclass:: StlHandler :members: :private-members: diff --git a/docs/source/free_form.rst b/docs/source/freeform.rst similarity index 59% rename from docs/source/free_form.rst rename to docs/source/freeform.rst index 2686e52..47b1172 100644 --- a/docs/source/free_form.rst +++ b/docs/source/freeform.rst @@ -1,7 +1,7 @@ -Free Form Deformation +Freeform ===================== -.. automodule:: pygem.free_form +.. automodule:: pygem.freeform .. autoclass:: FFD :members: diff --git a/docs/source/index.rst b/docs/source/index.rst index 1f11442..5b29294 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,6 +8,19 @@ Welcome to PyGeM's documentation! Python utilities for geometrical morphing. + +Description +^^^^^^^^^^^^ + +PyGeM is a python library using Free Form Deformation to parametrize and morph complex geometries. It is ideally suited for actual industrial problems, since it allows to handle: + +- Computer Aided Design files (in .iges and .stl formats) +- Mesh files (in .unv and OpenFOAM formats) +- Output files (in .vtk format) + +By now, it has been used with meshes with up to 14 milions of cells. Try with more and more complicated input files! + + Guide ^^^^^ @@ -20,7 +33,7 @@ Guide Indices and tables -================== +^^^^^^^^^^^^^^^^^^^^^^^^ * :ref:`genindex` * :ref:`modindex` diff --git a/docs/source/ffd_parameters.rst b/docs/source/params.rst similarity index 61% rename from docs/source/ffd_parameters.rst rename to docs/source/params.rst index 334fdca..932aabe 100644 --- a/docs/source/ffd_parameters.rst +++ b/docs/source/params.rst @@ -1,7 +1,7 @@ -FFD Parameters +Params ================= -.. automodule:: pygem.ffd_parameters +.. automodule:: pygem.params .. autoclass:: FFDParameters :members: diff --git a/pygem/affine.py b/pygem/affine.py index a7ee8b5..f29c8ba 100644 --- a/pygem/affine.py +++ b/pygem/affine.py @@ -69,7 +69,7 @@ def to_reduced_row_echelon_form(matrix): :Example: - >>> import pygem.affine_trans as at + >>> import pygem.affine as at >>> matrix = [[1., 1., 1.], [1., 1., 1.], [1., 1., 1.]] >>> rref_matrix = at.to_reduced_row_echelon_form(matrix) @@ -168,7 +168,7 @@ def transform_vector(source): :param numpy.ndarray source: vector to be transformed. :return destination: numpy.ndarray representing the transformed vector. - :rtype: float + :rtype: numpy.ndarray """ destination = np.zeros(dim) for i in range(dim):