From b29f22f51398b7c36608ab5b693239e00c19cb41 Mon Sep 17 00:00:00 2001 From: Martin Diehl Date: Thu, 1 Oct 2020 09:25:32 +0200 Subject: [PATCH] documenting the actually available TMPS --- python/damask/_geom.py | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/python/damask/_geom.py b/python/damask/_geom.py index e760e40c3..2ccbb1988 100644 --- a/python/damask/_geom.py +++ b/python/damask/_geom.py @@ -345,14 +345,30 @@ class Geom: Number of grid points in x,y,z direction. size : list or numpy.ndarray of shape (3) Physical size of the geometry in meter. - surface : {'primitive', 'gyroid', 'lidinoid', 'neovius', 'diamond', 'doublediamond'} - Type of the minimal surface. + surface : str + Type of the minimal surface. See notes for details. threshold : float, optional. Threshold of the minimal surface. Defaults to 0.0. periods : integer, optional. Number of periods per unit cell. Defaults to 1. materials : (int, int), optional Material IDs. Defaults to (1,2). + + Notes + ----- + The following triply-periodic minimal surfaces are implemented: + - Schwarz P + - Double Primitive + - Schwarz D + - Complementary D + - Double Diamond + - Dprime + - Gyroid + - Gprime + - Karcher K + - Lidinoid + - Neovius + - Fisher-Koch S References ----------