Skip to content

Material Controller

create_material(name)

Parameters:

Name Type Description Default
name str

material name

required

Returns:

Type Description
int

material ID

Source code in material_controller/__init__.py
def create_material(name: str) -> int: 
    """

    Args:
        name (str): material name

    Returns:
        int: material ID
    """

get_all_materials()

ℹ Available for script filled attributes

Returns:

Type Description
List[int]

all materials

Source code in material_controller/__init__.py
def get_all_materials() -> List[int]: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Returns:
        List[int]: all materials
    """

get_burn_off_rate(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
float

value

Source code in material_controller/__init__.py
def get_burn_off_rate(number: int) -> float: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        float: value
    """

get_code(number)

get material code

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
str

material code

Source code in material_controller/__init__.py
def get_code(number: int) -> str: 
    """get material code

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        str: material code
    """

get_drop_forming_class(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
str

description

Source code in material_controller/__init__.py
def get_drop_forming_class(number: int) -> str: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        str: _description_
    """

get_fire_resistance_class(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
str

description

Source code in material_controller/__init__.py
def get_fire_resistance_class(number: int) -> str: 
    """
    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        str: _description_
    """

get_group(number)

get material group

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
str

material group

Source code in material_controller/__init__.py
def get_group(number: int) -> str: 
    """get material group

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        str: material group
    """

get_heat_capacity(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
float

value

Source code in material_controller/__init__.py
def get_heat_capacity(number: int) -> float: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        float: value
    """

get_material_id(name)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
name str

material name

required
Source code in material_controller/__init__.py
def get_material_id(name: str) -> None: 
    """
    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        name (str): material name
    """

get_modulus_elasticity_1(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
float

value

Source code in material_controller/__init__.py
def get_modulus_elasticity_1(number: int) -> float: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        float: value
    """

get_modulus_elasticity_2(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
float

value

Source code in material_controller/__init__.py
def get_modulus_elasticity_2(number: int) -> float: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        float: value
    """

get_modulus_elasticity_3(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
float

value

Source code in material_controller/__init__.py
def get_modulus_elasticity_3(number: int) -> float: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        float: value
    """

get_name(number)

Get material name

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
str

material name

Source code in material_controller/__init__.py
def get_name(number: int) -> str: 
    """Get material name

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        str: material name
    """

get_price(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
float

value

Source code in material_controller/__init__.py
def get_price(number: int) -> float: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        float: value
    """

get_price_type(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
str

description

Source code in material_controller/__init__.py
def get_price_type(number: int) -> str: 
    """
    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        str: _description_
    """

get_shear_modulus_1(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
float

value

Source code in material_controller/__init__.py
def get_shear_modulus_1(number: int) -> float: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        float: value
    """

get_shear_modulus_2(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
float

value

Source code in material_controller/__init__.py
def get_shear_modulus_2(number: int) -> float: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        float: value
    """

get_smoke_class(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
str

description

Source code in material_controller/__init__.py
def get_smoke_class(number: int) -> str: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        str: _description_
    """

get_thermal_conductivity(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
float

value

Source code in material_controller/__init__.py
def get_thermal_conductivity(number: int) -> float: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        float: value
    """

get_u_max(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
float

value

Source code in material_controller/__init__.py
def get_u_max(number: int) -> float: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        float: value
    """

get_u_min(number)

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
float

value

Source code in material_controller/__init__.py
def get_u_min(number: int) -> float: 
    """

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        float: value
    """

get_weight(number)

get material weight

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
float

value

Source code in material_controller/__init__.py
def get_weight(number: int) -> float: 
    """get material weight

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        float: value
    """

get_weight_type(number)

gets the material weight type

ℹ Available for script filled attributes

Parameters:

Name Type Description Default
number int

element ID

required

Returns:

Type Description
str

weight type

Source code in material_controller/__init__.py
def get_weight_type(number: int) -> str: 
    """gets the material weight type

    [:information_source: Available for script filled attributes](#){.mark-text}

    Args:
        number (int): element ID

    Returns:
        str: weight type
    """

set_burn_off_rate(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value float

value

required
Source code in material_controller/__init__.py
def set_burn_off_rate(number: int, value: float) -> None: 
    """

    Args:
        number (int): element ID
        value (float): value
    """

set_code(number, value)

set material code

Parameters:

Name Type Description Default
number int

element ID

required
value str

material code

required
Source code in material_controller/__init__.py
def set_code(number: int, value: str) -> None: 
    """set material code

    Args:
        number (int): element ID
        value (str): material code
    """

set_drop_forming_class(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value str

description

required
Source code in material_controller/__init__.py
def set_drop_forming_class(number: int, value: str) -> None: 
    """

    Args:
        number (int): element ID
        value (str): _description_
    """

set_fire_resistance_class(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value str

description

required
Source code in material_controller/__init__.py
def set_fire_resistance_class(number: int, value: str) -> None: 
    """

    Args:
        number (int): element ID
        value (str): _description_
    """

set_group(number, value)

set material group

Parameters:

Name Type Description Default
number int

element ID

required
value str

material group (name)

required
Source code in material_controller/__init__.py
def set_group(number: int, value: str) -> None: 
    """set material group

    Args:
        number (int): element ID
        value (str): material group (name)
    """

set_heat_capacity(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value float

value

required
Source code in material_controller/__init__.py
def set_heat_capacity(number: int, value: float) -> None: 
    """

    Args:
        number (int): element ID
        value (float): value
    """

set_modulus_elasticity_1(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value float

value

required
Source code in material_controller/__init__.py
def set_modulus_elasticity_1(number: int, value: float) -> None: 
    """

    Args:
        number (int): element ID
        value (float): value
    """

set_modulus_elasticity_2(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value float

value

required
Source code in material_controller/__init__.py
def set_modulus_elasticity_2(number: int, value: float) -> None: 
    """

    Args:
        number (int): element ID
        value (float): value
    """

set_modulus_elasticity_3(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value float

value

required
Source code in material_controller/__init__.py
def set_modulus_elasticity_3(number: int, value: float) -> None: 
    """

    Args:
        number (int): element ID
        value (float): value
    """

set_name(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value str

a material name

required
Source code in material_controller/__init__.py
def set_name(number: int, value: str) -> None: 
    """

    Args:
        number (int): element ID
        value (str): a material name
    """

set_price(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value float

value

required
Source code in material_controller/__init__.py
def set_price(number: int, value: float) -> None: 
    """

    Args:
        number (int): element ID
        value (float): value
    """

set_price_type(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value str

description

required
Source code in material_controller/__init__.py
def set_price_type(number: int, value: str) -> None: 
    """

    Args:
        number (int): element ID
        value (str): _description_
    """

set_shear_modulus_1(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value float

value

required
Source code in material_controller/__init__.py
def set_shear_modulus_1(number: int, value: float) -> None: 
    """

    Args:
        number (int): element ID
        value (float): value
    """

set_shear_modulus_2(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value float

value

required
Source code in material_controller/__init__.py
def set_shear_modulus_2(number: int, value: float) -> None: 
    """

    Args:
        number (int): element ID
        value (float): value
    """

set_smoke_class(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value str

description

required
Source code in material_controller/__init__.py
def set_smoke_class(number: int, value: str) -> None: 
    """

    Args:
        number (int): element ID
        value (str): _description_
    """

set_thermal_conductivity(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value float

value

required
Source code in material_controller/__init__.py
def set_thermal_conductivity(number: int, value: float) -> None: 
    """

    Args:
        number (int): element ID
        value (float): value
    """

set_u_max(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value float

value

required
Source code in material_controller/__init__.py
def set_u_max(number: int, value: float) -> None: 
    """

    Args:
        number (int): element ID
        value (float): value
    """

set_u_min(number, value)

Parameters:

Name Type Description Default
number int

element ID

required
value float

value

required
Source code in material_controller/__init__.py
def set_u_min(number: int, value: float) -> None: 
    """

    Args:
        number (int): element ID
        value (float): value
    """

set_weight(number, value)

set material weight

Parameters:

Name Type Description Default
number int

element ID

required
value float

value

required
Source code in material_controller/__init__.py
def set_weight(number: int, value: float) -> None: 
    """set material weight

    Args:
        number (int): element ID
        value (float): value
    """

set_weight_type(number, value)

sets the material weight type

Parameters:

Name Type Description Default
number int

element ID

required
value str

weight type

required
Source code in material_controller/__init__.py
def set_weight_type(number: int, value: str) -> None: 
    """sets the material weight type

    Args:
        number (int): element ID
        value (str): weight type
    """