Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/source/affine.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Affine
=====================

.. automodule:: pygem.affine
:members:
5 changes: 0 additions & 5 deletions docs/source/affine_trans.rst

This file was deleted.

8 changes: 4 additions & 4 deletions docs/source/code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Code Documentation
:maxdepth: 2


affine_trans
free_form
ffd_parameters
file_handler
affine
freeform
params
filehandler

9 changes: 7 additions & 2 deletions docs/source/file_handler.rst → docs/source/filehandler.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
File Handler
Filehandler
=================

.. automodule:: pygem.file_handler
.. automodule:: pygem.filehandler

.. autoclass:: FileHandler
:members:
Expand All @@ -12,6 +12,11 @@ File Handler
:private-members:
:special-members:

.. autoclass:: VtkHandler
:members:
:private-members:
:special-members:

.. autoclass:: StlHandler
:members:
:private-members:
Expand Down
4 changes: 2 additions & 2 deletions docs/source/free_form.rst → docs/source/freeform.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Free Form Deformation
Freeform
=====================

.. automodule:: pygem.free_form
.. automodule:: pygem.freeform

.. autoclass:: FFD
:members:
Expand Down
15 changes: 14 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^

Expand All @@ -20,7 +33,7 @@ Guide


Indices and tables
==================
^^^^^^^^^^^^^^^^^^^^^^^^

* :ref:`genindex`
* :ref:`modindex`
Expand Down
4 changes: 2 additions & 2 deletions docs/source/ffd_parameters.rst → docs/source/params.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
FFD Parameters
Params
=================

.. automodule:: pygem.ffd_parameters
.. automodule:: pygem.params

.. autoclass:: FFDParameters
:members:
Expand Down
4 changes: 2 additions & 2 deletions pygem/affine.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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):
Expand Down