improved documentation
This commit is contained in:
parent
0604e510ec
commit
d832d4cf17
|
@ -106,11 +106,8 @@ class ConfigMaterial(Config):
|
||||||
Load DREAM.3D (HDF5) file.
|
Load DREAM.3D (HDF5) file.
|
||||||
|
|
||||||
Data in DREAM.3D files can be stored per cell ('CellData')
|
Data in DREAM.3D files can be stored per cell ('CellData')
|
||||||
and/or per grain ('Grain Data'). Per default, cell-wise data
|
and/or per grain ('Grain Data'). Per default, i.e. if
|
||||||
is assumed.
|
'grain_data' is None, cell-wise data is assumed.
|
||||||
|
|
||||||
damask.Grid.load_DREAM3D allows to get the corresponding geometry
|
|
||||||
for the grid solver.
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
|
@ -140,15 +137,22 @@ class ConfigMaterial(Config):
|
||||||
and grain- or cell-wise data. Defaults to None, in which case
|
and grain- or cell-wise data. Defaults to None, in which case
|
||||||
it is set as the path that contains _SIMPL_GEOMETRY/SPACING.
|
it is set as the path that contains _SIMPL_GEOMETRY/SPACING.
|
||||||
|
|
||||||
Notes
|
|
||||||
-----
|
|
||||||
Homogenization and phase entries are emtpy and need to be defined separately.
|
|
||||||
|
|
||||||
Returns
|
Returns
|
||||||
-------
|
-------
|
||||||
loaded : damask.ConfigMaterial
|
loaded : damask.ConfigMaterial
|
||||||
Material configuration from file.
|
Material configuration from file.
|
||||||
|
|
||||||
|
Notes
|
||||||
|
-----
|
||||||
|
damask.Grid.load_DREAM3D gives the corresponding geometry for
|
||||||
|
the grid solver.
|
||||||
|
|
||||||
|
For cell-wise data, only unique combinations of
|
||||||
|
orientation and phase are considered.
|
||||||
|
|
||||||
|
Homogenization and phase entries are emtpy and need to be
|
||||||
|
defined separately.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
b = util.DREAM3D_base_group(fname) if base_group is None else base_group
|
b = util.DREAM3D_base_group(fname) if base_group is None else base_group
|
||||||
c = util.DREAM3D_cell_data_group(fname) if cell_data is None else cell_data
|
c = util.DREAM3D_cell_data_group(fname) if cell_data is None else cell_data
|
||||||
|
|
|
@ -358,10 +358,10 @@ class Grid:
|
||||||
"""
|
"""
|
||||||
Load DREAM.3D (HDF5) file.
|
Load DREAM.3D (HDF5) file.
|
||||||
|
|
||||||
Data in DREAM.3D files can be stored per cell ('CellData') and/or
|
Data in DREAM.3D files can be stored per cell ('CellData')
|
||||||
per grain ('Grain Data'). Per default, cell-wise data is assumed.
|
and/or per grain ('Grain Data'). Per default, i.e. if
|
||||||
|
'feature_IDs' is None, cell-wise data is assumed.
|
||||||
|
|
||||||
damask.ConfigMaterial.load_DREAM3D gives the corresponding material definition.
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
|
@ -392,6 +392,14 @@ class Grid:
|
||||||
loaded : damask.Grid
|
loaded : damask.Grid
|
||||||
Grid-based geometry from file.
|
Grid-based geometry from file.
|
||||||
|
|
||||||
|
Notes
|
||||||
|
-----
|
||||||
|
damask.ConfigMaterial.load_DREAM3D gives the corresponding
|
||||||
|
material definition.
|
||||||
|
|
||||||
|
For cell-wise data, only unique combinations of
|
||||||
|
orientation and phase are considered.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
b = util.DREAM3D_base_group(fname) if base_group is None else base_group
|
b = util.DREAM3D_base_group(fname) if base_group is None else base_group
|
||||||
c = util.DREAM3D_cell_data_group(fname) if cell_data is None else cell_data
|
c = util.DREAM3D_cell_data_group(fname) if cell_data is None else cell_data
|
||||||
|
|
Loading…
Reference in New Issue