comments for geometry building commands

这个提交包含在:
John Hartley
2019-08-24 12:22:20 +01:00
父节点 237af789f7
当前提交 0b4f26d1fe
共有 11 个文件被更改,包括 166 次插入11 次删除

查看文件

@@ -9,7 +9,27 @@ import numpy as np
class FractalBox(UserObjectGeometry):
"""User class for edge command."""
"""Allows you to introduce an orthogonal parallelepiped with fractal distributed properties which are related to a mixing model or normal material into the model.
:param p1: The lower left (x,y,z) coordinates of the parallelepiped
:type p1: list, non-optional
:param p2: The upper right (x,y,z) coordinates of the parallelepiped
:type p2: list, non-optional
:param frac_dim: The fractal dimension which, for an orthogonal parallelepiped, should take values between zero and three.
:type frac_dim: float, non-optional
:param weighting: Weightings in the x, y, z direction of the surface.
:type weighting: list, non-optional
:param n_materials: Number of materials to use for the fractal distribution (defined according to the associated mixing model). This should be set to one if using a normal material instead of a mixing model.
:type n_materials: list, non-optional
:param mixing_model_id: Is an identifier for the associated mixing model or material.
:type mixing_model_id: list, non-optional
:param id: Identifier for the fractal box itself.
:type id: list, non-optional
:param seed: Controls the seeding of the random number generator used to create the fractals..
:type seed: float, non-optional
:param averaging: y or n, used to switch on and off dielectric smoothing.
:type averaging: str, non-optional
"""
def __init__(self, **kwargs):
"""Constructor."""