ifctruss

Core function of IfcTruss

Create spreadsheet template

---

source

save_ods_template

 save_ods_template (ods_path:str='ifctruss-template.ods',
                    load_groups:bool=False)

	Type	Default	Details
ods_path	str	ifctruss-template.ods	Path to ods file
load_groups	bool	False	Create worksheet for information regarding IfcStructuralLoadGroup’s

Note

If load_groups is False, no worksheet Load_Groups will be created.

---

source

save_xlsx_template

 save_xlsx_template (xlsx_path:str='ifctruss-template.xlsx',
                     load_groups:bool=False)

	Type	Default	Details
xlsx_path	str	ifctruss-template.xlsx	Path to xlsx file
load_groups	bool	False	Create worksheet for information regarding IfcStructuralLoadGroup’s

Note

If load_groups is False, no worksheet Load_Groups will be created.

Build a IFC

---

source

build

 build (nodes:pandas.core.frame.DataFrame,
        bars:pandas.core.frame.DataFrame,
        point_loads:pandas.core.frame.DataFrame,
        load_groups:pandas.core.frame.DataFrame|None=None)

	Type	Default	Details
nodes	DataFrame		Pandas DataFrame with information regarding IfcStructuralPointConnection’s
bars	DataFrame		Pandas DataFrame with information regarding IfcStructuralCurveMember’s
point_loads	DataFrame		Pandas DataFrame with information regarding IfcStructuralLoadSingleForce’s
load_groups	pandas.core.frame.DataFrame | None	None
Returns	file		IFC model

Note

If load_groups is None, only one IfcStructuralLoadGroup is created and all IfcStructuralLoadSingleForce are related to it.

---

source

build_from_ods

 build_from_ods (ods_path:str)

	Type	Details
ods_path	str	Path to ods file
Returns	file	IFC model

Note

If there is no worksheet Load_Groups, only one IfcStructuralLoadGroup is created and all IfcStructuralLoadSingleForce are related to it.

---

source

build_from_xlsx

 build_from_xlsx (xlsx_path:str)

	Type	Details
xlsx_path	str	Path to xlsx file
Returns	file	IFC model

Note

If there is no worksheet Load_Groups, only one IfcStructuralLoadGroup is created and all IfcStructuralLoadSingleForce are related to it.

View as DataFrame

---

source

view

 view (model:ifcopenshell.file.file,
       structural_analysis_model:str|None=None, load_group:str|None=None,
       result_group:str|bool=False)

	Type	Default	Details
model	file		IFC model
structural_analysis_model	str | None	None
load_group	str | None	None	str: IfcStructuralLoadGroup GlobalId
result_group	str | bool	False
Returns	NamedTuple		NamedTuple with Pandas DataFrame’s (and str’s)

Note

If structural_analysis_model=None or load_group=None or result_group=True: IfcStructuralAnalysisModel or IfcStructuralLoadGroup or IfcStructuralResultGroup will be searched and if there is only one possibility, also used, if not, the user will be requested to provide the respective GlobalId. If result_group is False, there will be no attempt to fetch the information regarding the IfcStructuralResultGroup.

Calculate and save result in IFC

---

source

save_result

 save_result (model:ifcopenshell.file.file,
              displacments:pandas.core.frame.DataFrame,
              forces:pandas.core.frame.DataFrame,
              normal_forces:pandas.core.frame.DataFrame, theory_type:str,
              is_linear:str, structural_analysis_model:str|None=None,
              load_group:str|None=None)

	Type	Default	Details
model	file		IFC model
displacments	DataFrame		Pandas DataFrame with information regarding IfcStructuralPointReaction IfcStructuralLoadSingleDisplacement
forces	DataFrame		Pandas DataFrame with information regarding IfcStructuralPointReaction IfcStructuralLoadSingleForce
normal_forces	DataFrame		Pandas DataFrame with information regarding IfcStructuralCurveReaction
theory_type	str		IfcStructuralResultGroup TheoryType
is_linear	str		IfcStructuralResultGroup IsLinear
structural_analysis_model	str | None	None
load_group	str | None	None	str: IfcStructuralLoadGroup GlobalId

Note

If structural_analysis_model=None or load_group=None: IfcStructuralAnalysisModel or IfcStructuralLoadGroup will be searched and if there is only one possibility, also used, if not, the user will be requested to provide the respective GlobalId.

---

source

solve

 solve (model:ifcopenshell.file.file, structural_analysis_model=None,
        load_group=None, solver='direct_stiffness_method')

	Type	Default	Details
model	file		IFC model
structural_analysis_model	NoneType	None	str: IfcStructuralAnalysisModel GlobalId
load_group	NoneType	None	str: IfcStructuralLoadGroup GlobalId
solver	str	direct_stiffness_method	str: [“direct_stiffness_method”, “calfem”]

Note

If structural_analysis_model=None or load_group=None: IfcStructuralAnalysisModel or IfcStructuralLoadGroup will be searched and if there is only one possibility, also used, if not, the user will be requested to provide the respective GlobalId.