ifcopenshell.api.material.add_profile

Module Contents

ifcopenshell.api.material.add_profile.add_profile(file: ifcopenshell.file, profile_set: ifcopenshell.entity_instance, material: ifcopenshell.entity_instance | None = None, profile: ifcopenshell.entity_instance | None = None) → ifcopenshell.entity_instance

Add a new profile item to a profile set

A profile item in a profile set represents an extruded 2D profile curve that is extruded along the axis of the element. Most commonly there will only be a single profile item in a profile set. For example, a beam will have a material profile set containing a single profile item, which may have a steel material and a I-beam shaped profile curve.

Note that the “profile item” represents a single extrusion in the profile set, whereas the “profile curve” represents a 2D curve used by a “profile item”.

In some cases, a profiled element (i.e. beam, column) may be a composite beam or column and include multiple extrusions. This is rare. The order of the profiles does not matter.

Parameters:

• profile_set (ifcopenshell.entity_instance) – The IfcMaterialProfileSet that the profile is part of. The profile set represents a group of profile items. See ifcopenshell.api.material.add_material_set for more information on how to add a profile set.

• material (ifcopenshell.entity_instance, optional) – The IfcMaterial that the profile item is made out of.

• profile (ifcopenshell.entity_instance, optional) – The IfcProfileDef that represents the 2D cross section of the the profile item.

Returns:

The newly created IfcMaterialProfile

Return type:

ifcopenshell.entity_instance

Example:

# Let's imagine we have a steel I-beam. Notice we are assigning to
# the type only, as all occurrences of that type will automatically
# inherit the material.
beam_type = ifcopenshell.api.root.create_entity(model, ifc_class="IfcBeamType", name="B1")

# First, let's create a material set. This will later be assigned
# to our beam type element.
material_set = ifcopenshell.api.material.add_profile_set(model,
    name="B1", set_type="IfcMaterialProfileSet")

# Create a steel material.
steel = ifcopenshell.api.material.add_material(model, name="ST01", category="steel")

# Create an I-beam profile curve. Notice how we name our profiles
# based on standardised steel profile names.
hea100 = file.create_entity(
    "IfcIShapeProfileDef", ProfileName="HEA100", ProfileType="AREA",
    OverallWidth=100, OverallDepth=96, WebThickness=5, FlangeThickness=8, FilletRadius=12,
)

# Define that steel material and cross section as a single profile
# item. If this were a composite beam, we might add multiple profile
# items instead, but this is rarely the case in most construction.
ifcopenshell.api.material.add_profile(model,
    profile_set=material_set, material=steel, profile=hea100)

# Great! Let's assign our material set to our beam type.
ifcopenshell.api.material.assign_material(model, products=[beam_type], material=material_set)