Skip to content

Commit

Permalink
MSH: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
MuellerSeb committed Apr 29, 2019
1 parent bffa41a commit 9131e0c
Showing 1 changed file with 14 additions and 21 deletions.
35 changes: 14 additions & 21 deletions ogs5py/fileclasses/msh/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -819,13 +819,6 @@ def rotate(
Parameters
----------
mesh : single dict
dictionary containing
at least the following keyword:
nodes : ndarray
Array with all node postions.
angle : float
rotation angle given in radial length
rotation_axis : array_like, optional
Expand All @@ -841,13 +834,6 @@ def shift(self, vector):
Parameters
----------
mesh : single dict
dictionary containing
at least the following keyword:
nodes : ndarray
Array with all node postions.
vector : ndarray
array containing the shifting vector
"""
Expand All @@ -860,13 +846,6 @@ def transform(self, xyz_func, **kwargs):
Parameters
----------
mesh : single dict
dictionary containing
at least the following keyword
nodes : ndarray
Array with all node postions.
xyz_func : function
the function transforming the points:
``x_new, y_new, z_new = f(x_old, y_old, z_old, **kwargs)``
Expand Down Expand Up @@ -896,6 +875,20 @@ def generate(self, generator="rectangular", **kwargs):
set the generator from the generator module
**kwargs
kwargs will be forwarded to the generator in use
Notes
-----
.. currentmodule:: ogs5py.fileclasses.msh.generator
The following generators are available:
.. autosummary::
rectangular
radial
grid_adapter2D
grid_adapter3D
block_adapter3D
generate_gmsh
"""
self._dict = getattr(gen, generator)(**kwargs)

Expand Down

0 comments on commit 9131e0c

Please sign in to comment.