# AddOns

# ConcreteDesignStrengthConfigurationACI

Kind: global class

# new ConcreteDesignStrengthConfigurationACI(no, surfaces_no, members_no, nodes_no, comment, params)

Creates Concrete design strength configuration (ACI standard)

Param Type Description
no Number Strength configuration number, can be undefined
surfaces_no Array Assigned surfaces numbers, can be undefined
members_no Array Assigned members numbers, can be undefined
nodes_no Array Assigned nodes numbers, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# concreteDesignStrengthConfigurationACI.GetNo() ⇒

Kind: instance method of ConcreteDesignStrengthConfigurationACI
Returns: Strength configuration index

# concreteDesignStrengthConfigurationACI.GetUltimateConfiguration() ⇒

Kind: instance method of ConcreteDesignStrengthConfigurationACI
Returns: Strength configuration object

# concreteDesignStrengthConfigurationACI.SetName(name)

Sets Name

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
name String Strength configuration name, can be undefined

# concreteDesignStrengthConfigurationACI.SetMembers_ConsiderInternalForces(property_member_axial_forces, property_member_bending_moments_my, property_member_bending_moments_mz, property_member_torsional_moments, property_member_shear_forces_vy, property_member_shear_forces_vz)

Sets Consider internal forces for concrete design

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_member_axial_forces Boolean Axial forces, can be undefined (is not set, true as default)
property_member_bending_moments_my Boolean Bending moment in Y, can be undefined (is not set, true as default)
property_member_bending_moments_mz Boolean Bending moment in Z, can be undefined (is not set, true as default)
property_member_torsional_moments Boolean Torsional moments, can be undefined (is not set, true as default)
property_member_shear_forces_vy Boolean Shear forces in Y, can be undefined (is not set, true as default)
property_member_shear_forces_vz Boolean Shear forces in Z, can be undefined (is not set, true as default)

# concreteDesignStrengthConfigurationACI.SetMembers_InternalForceReductionZ(property_member_redistribution_of_moments_in_continuous_flexural_members, property_member_reduction_of_shear_at_support)

Sets Internal Force Reduction in z-Direction

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_member_redistribution_of_moments_in_continuous_flexural_members Boolean Redistribution of moments in continuous flexural members acc. to 6.6.5, can be undefined (is not set, false as default)
property_member_reduction_of_shear_at_support Boolean Reduction of shear at the support acc. to 9.4.3.2, can be undefined (is not set, true as default)

# concreteDesignStrengthConfigurationACI.SetMembers_RequiredLongitudinalReinforcement(property_member_reinforcement_layout, property_member_reinforcement_diameter_for_preliminary_design, property_member_include_tensile_force_due_to_shear_in_required_longitudinal_reinforcement)

Sets Required longitudinal reinforcement

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_member_reinforcement_layout String Reinforcement layout (TOP_BOTTOM_OPTIMIZED_DISTRIBUTION, TOP_BOTTOM_SYMMETRICAL_DISTRIBUTION, IN_CORNERS_SYMMETRICAL_DISTRIBUTION, UNIFORMLY_SURROUNDING, FACTORIZED_PROVIDED_REINFORCEMENT, OPTIMIZED_PROVIDED_REINFORCEMENT), can be undefined (is not set, OPTIMIZED_PROVIDED_REINFORCEMENT as default)
property_member_reinforcement_diameter_for_preliminary_design String/Number Reinforcement diameter for preliminary design (MAX_OF_ALL or user-defined value), can be undefined (is not set as default, otherwise MAX_OF_ALL as default)
property_member_include_tensile_force_due_to_shear_in_required_longitudinal_reinforcement Boolean Include tensile force due to shear in required longitudinal reinforcement, can be undefined (is not set, true as default)

# concreteDesignStrengthConfigurationACI.SetMembers_ProvidedLongitudinalReinforcement(property_member_design_check_for_tensile_force_in_longitudinal_reinforcement, property_member_embedment_length_of_continuing_flexural_tension_reinforcement, property_member_termination_of_reinforcement)

Sets Provided Longitudinal Reinforcement

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_member_design_check_for_tensile_force_in_longitudinal_reinforcement Boolean Design check for tensile force in longitudinal reinforcement, including tension due to shear acc. to 9.7.3, can be undefined (is not set, true as default)
property_member_embedment_length_of_continuing_flexural_tension_reinforcement Boolean Embedment length of continuous flexural tension reinforcement acc. to 9.7.3.4, can be undefined (is not set, false as default)
property_member_termination_of_reinforcement Boolean Termination of flexural tension reinforcement acc. to 9.7.3.5, can be undefined (is not set, false as default)

# concreteDesignStrengthConfigurationACI.SetMembers_MinimumReinforcement(property_member_minimum_longitudinal_reinforcement, property_member_minimum_shear_reinforcement, property_member_minimum_construction_reinforcement)

Sets Minimum Reinforcement Acc. to Standard

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_member_minimum_longitudinal_reinforcement Boolean Minimum longitudinal reinforcement acc. to standard, can be undefined (is not set, true as default)
property_member_minimum_shear_reinforcement Boolean Minimum shear reinforcement acc. to standard, can be undefined (is not set, true as default)
property_member_minimum_construction_reinforcement Boolean Minimum construction reinforcement, can be undefined (is not set, true as default)

# concreteDesignStrengthConfigurationACI.SetMembers_RequiredShearReinforcement(shear_reinforcement)

Sets Required Shear Reinforcement - Shear Capacity

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
shear_reinforcement String Use required longitudinal reinforcement (REQUIRED) Use provided longitudinal reinforcement (PROVIDED)

# concreteDesignStrengthConfigurationACI.SetMembers_TorsionCapacity(property_member_type_of_torsion)

Sets Torsion Capacity

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_member_type_of_torsion String Type of torsion acc. to 22.7.1.1 and 22.7.3.1 (TORSION_EQUILIBRIUM, TORSION_COMPATIBILITY), can be undefined (TORSION_EQUILIBRIUM as default)

# concreteDesignStrengthConfigurationACI.SetMembers_ShearAndTorsionReinforcement(property_member_nominal_shear_strength_vc, property_member_inclination_of_concrete_strut)

Sets Shear and Torsion Reinforcement

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_member_nominal_shear_strength_vc String Nominal shear strength Vc acc. to Table 22.5.5.1, can be undefined (is not set, TORSION_EQUILIBRIUM as default)
property_member_inclination_of_concrete_strut Number Inclination of concrete strut acc. to 22.7.6.1, can be undefined (is not set, 45.0 as default)

# concreteDesignStrengthConfigurationACI.SetMembers_NeutralAxisDepthLimitation(property_member_consider_neutral_axis_depth_limitation, property_member_value_of_neutral_axis_depth_limitation_user_value)

Sets Sets Depth Limitation of Neutral Axis

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_member_consider_neutral_axis_depth_limitation Boolean Consider depth limitation of neutral axis acc. to 9.3.3.1, can be undefined (is not set, false as default)
property_member_value_of_neutral_axis_depth_limitation_user_value String/Number Value of neutral axis depth limitation (AUTOMATICALLY or user number value), can be undefined (is not set, AUTOMATICALLY as default)

# concreteDesignStrengthConfigurationACI.SetMembers_CalculationSetting(property_member_nett_concrete_area)

Sets Calculation setting

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_member_nett_concrete_area Boolean Net concrete area, can be undefined (true as default)

# concreteDesignStrengthConfigurationACI.SetMembers_EpoxyFactor(epoxy_factor_type)

Sets Epoxy factor

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
epoxy_factor_type String Epoxy factor type, can be undefined (is not set, UNCOATED_OR_ZINC_COATED as default) - Epoxy-coated or zinc and epoxy dual-coated reinforcement (EPOXY_COATED_OR_ZINC) - Uncoated or zinc-coated (galvanized) reinforcement (UNCOATED_OR_ZINC_COATED)

# concreteDesignStrengthConfigurationACI.SetStability_UnbracedColumn(property_stability_index_qy, property_stability_index_qz)

Sets Unbraced Column

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_stability_index_qy Number Stability index for story in y-direction, can be undefined (is not set, 0.05 as default)
property_stability_index_qz Number Stability index for story in z-direction, can be undefined (is not set, 0.05 as default)

# concreteDesignStrengthConfigurationACI.SetStability_StiffnessReductionCoefficientToConsiderCreep(property_beta_dns, property_beta_ds_y, property_beta_ds_z)

Sets Stiffness Reduction Coefficient to Consider Creep due to Sustained Load

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_beta_dns String/Number Ratio of sustained axial load to factored axial load (SIMPLIFIED, CALCULATED or user value), can be undefined (is not set, SIMPLIFIED as default)
property_beta_ds_y String/Number Ratio of sustained shear load to factored shear load in y-direction (CALCULATED or user value), can be undefined (is not set, CALCULATED as default)
property_beta_ds_z String/Number Ratio of sustained shear load to factored shear load in z-direction (CALCULATED or user value), can be undefined (is not set, CALCULATED as default)

# concreteDesignStrengthConfigurationACI.SetStability_MomentMagnification(property_sway_moment_magnifier_method)

Sets Moment Magnification

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_sway_moment_magnifier_method String Sway moment magnifier δs method (Q_METHOD, P_METHOD), can be undefined (is not set, Q_METHOD as default)

# concreteDesignStrengthConfigurationACI.SetStability_RequiredReinforcement(property_stability_reinforcement_layout, reinforcement_diameter_for_preliminary_design_user_value)

Sets Required Reinforcement

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_stability_reinforcement_layout String Reinforcement layout (TOP_BOTTOM_SYMMETRICAL_DISTRIBUTION, IN_CORNERS_SYMMETRICAL_DISTRIBUTION, UNIFORMLY_SURROUNDING, FACTORIZED_PROVIDED_REINFORCEMENT), can be undefined (is not set, UNIFORMLY_SURROUNDING as default)
reinforcement_diameter_for_preliminary_design_user_value String/Number Reinforcement diameter for preliminary design (MAX_OF_ALL or user number value), can be undefined (is not set, MAX_OF_ALL as default)

# concreteDesignStrengthConfigurationACI.SetSurfaces_DesignMethod(optimization_type)

Sets Design method

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
optimization_type String Design method optimization type, can be undefined (is not set, YES as default) - No optimization of design internal forces (NO) - Optimization of design internal forces (YES)

# concreteDesignStrengthConfigurationACI.SetSurfaces_InternalForcesDiagramUsedForDesign(property_subtraction_of_rib_components)

Sets Internal Forces Diagram Used for Design

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_subtraction_of_rib_components Boolean Subtraction of rib components for the ULS calculation and for the analytic method of SLS calculation, can be undefined (true as default)

# concreteDesignStrengthConfigurationACI.SetSurfaces_MinimumLongitudinalReinforcement(property_minimum_longitudinal_reinforcement_acc_to_standard, reinforcement_type, min_reinforcement_direction, min_reinforcement_direction_user_values, main_compression_reinforcement_direction, property_surface_reinforcement_defined_direction_phi, property_surface_ratio_b_div_h)

Sets Minimum longitudinal reinforcement acc. to standard

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_minimum_longitudinal_reinforcement_acc_to_standard Boolean Minimum longitudinal reinforcement acc. to standard, can be undefined (is not set, true as default)
reinforcement_type String Minimum longitudinal reinforcement acc. to standard type, can be undefined (is not set, PLATES as default) - Minimum longitudinal reinforcement for plates acc. to Table 7.6.1.1, 8.6.1.1 (PLATES) - Minimum longitudinal reinforcement for walls acc. to Chapter 11 (WALLS)
min_reinforcement_direction String Direction of minimum reinforcement, can be undefined (is not set, MAIN_TENSION_ELEMENT as default) - On main tension side (MAIN_TENSION_ELEMENT) - In tension direction (MAIN_TENSION_SURFACE) - Defined (DEFINED)
min_reinforcement_direction_user_values Array User-defined direction of minimum reinforcement ([φ1(-z), φ2(-z), φ1(+z), φ2(+z)]), can be undefined (if not set, all values are true by default)
main_compression_reinforcement_direction String Direction of main compression reinforcement, can be undefined (is not set, WITH_MAIN_COMPRESSION_FORCE as default) - Reinforcement direction with the main compression force (WITH_MAIN_COMPRESSION_FORCE) - Defined in reinforcement direction (DEFINED_IN_REINFORCEMENT_DIRECTION)
property_surface_reinforcement_defined_direction_phi String Reinforcement direction (PHI_1, PHI_2)
property_surface_ratio_b_div_h Number Ratio b/h acc. to 11.6.2, can be undefined (is not set, 2.5 as default)

# concreteDesignStrengthConfigurationACI.SetSurfaces_UserDefinedMinimumLongitudinalReinforcementPercentage(property_user_defined_minimum_longitudinal_reinforcement_percentage, property_minimum_reinforcement, property_minimum_secondary_reinforcement, property_minimum_tension_reinforcement, property_minimum_compression_reinforcement)

Sets User-defined minimum longitudinal reinforcement percentage

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_user_defined_minimum_longitudinal_reinforcement_percentage Boolean User-defined minimum longitudinal reinforcement percentage, can be undefined (is not set, false as default)
property_minimum_reinforcement Number Minimum reinforcement, can be undefined (is not set, 0% as default)
property_minimum_secondary_reinforcement Number Minimum secondary reinforcement from main reinforcement direction, can be undefined (is not set, 20% as default)
property_minimum_tension_reinforcement Number Minimum tension reinforcement, can be undefined (is not set, 0% as default)
property_minimum_compression_reinforcement Number Minimum compression reinforcement, can be undefined (is not set, 0% as default)

# concreteDesignStrengthConfigurationACI.SetSurfaces_UserDefinedMaximumLongitudinalReinforcementPercentage(property_user_defined_maximum_longitudinal_reinforcement_percentage, property_user_defined_maximum_longitudinal_reinforcement_percentage_value)

Sets User-defined maximum longitudinal reinforcement percentage

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_user_defined_maximum_longitudinal_reinforcement_percentage Boolean User-defined maximum longitudinal reinforcement percentage, can be undefined (is not set, true as default)
property_user_defined_maximum_longitudinal_reinforcement_percentage_value Number Maximum reinforcement, can be undefined (is not set, 4% as default)

# concreteDesignStrengthConfigurationACI.SetSurfaces_MinimumShearReinforcement(property_minimum_shear_reinforcement)

Sets Minimum shear reinforcement acc. to 9.3.2

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_minimum_shear_reinforcement Boolean Minimum shear reinforcement, can be undefined (is not set, true as default)

# concreteDesignStrengthConfigurationACI.SetSurfaces_UserDefinedMinimumShearReinforcementPercentage(property_user_defined_minimum_shear_reinforcement_percentage, property_user_defined_minimum_shear_reinforcement_percentage_value)

Sets User-defined minimum shear reinforcement percentage

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_user_defined_minimum_shear_reinforcement_percentage Boolean Minimum shear reinforcement percentage, can be undefined (is not set, false as default)
property_user_defined_minimum_shear_reinforcement_percentage_value Number Minimum reinforcement, can be undefined, (is not set, 0% as default)

# concreteDesignStrengthConfigurationACI.SetSurfaces_RequiredShearReinforcement(required_shear_reinforcement)

Sets Required Shear Reinforcement - Shear Capacity

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
required_shear_reinforcement String Required Shear Reinforcement value, can be undefined (is not set, REQUIRED as default) - Use required longitudinal reinforcement (REQUIRED) - Use provided longitudinal reinforcement (PROVIDED) - Automatically increase required longitudinal reinf. to avoid shear reinf. (AUTOMATICALLY)

# concreteDesignStrengthConfigurationACI.SetSurfaces_ShearAndTorsionReinforcement(property_surface_nominal_shear_strength_vc, property_surface_inclination_of_concrete_strut)

Sets Shear and torsion reinforcement

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_surface_nominal_shear_strength_vc String Nominal shear strength Vc acc. to Table 22.5.5.1 (EQUATION_A, EQUATION_B, MAX_OF_A_B), can be undefined (EQUATION_A as default)
property_surface_inclination_of_concrete_strut Number Inclination of concrete strut acc. to 22.7.6.1, can be undefined (is not set, 36.0 deg as default)

# concreteDesignStrengthConfigurationACI.SetSurfaces_NeutralAxisDepthLimitation(property_surface_consider_neutral_axis_depth_limitation, property_surface_value_of_neutral_axis_depth_limitation)

Sets Neutral Axis Depth Limitation

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_surface_consider_neutral_axis_depth_limitation Boolean Consider depth limitation of neutral axis acc. to 9.3.3.1, can be undefined (true as default)
property_surface_value_of_neutral_axis_depth_limitation Number Value of neutral axis depth limitation, can be undefined (is not set, 0.45 as default)

# concreteDesignStrengthConfigurationACI.SetPunching_PunchingLoad(property_node_used_punching_load_for_columns, property_node_used_punching_load_for_walls, property_node_distance_to_perimeter_used_for_integration_for_columns, property_node_distance_to_perimeter_used_for_integration_for_walls)

Sets Punching Load

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_node_used_punching_load_for_columns String/Number Used punching load for columns (SINGLE_FORCE, SMOOTHED_SHEAR_FORCE or user-defined value), can be undefined (is not set, SINGLE_FORCE as default) - Single force from column / load / nodal support (SINGLE_FORCE) - Smoothed shear force over the defined perimeter (SMOOTHED_SHEAR_FORCE)
property_node_used_punching_load_for_walls String/Number Used punching load for walls (SMOOTHED_SHEAR_FORCE or user-defined value), can be undefined (is not set, SMOOTHED_SHEAR_FORCE as default) - Smoothed shear force over the defined perimeter (SMOOTHED_SHEAR_FORCE)
property_node_distance_to_perimeter_used_for_integration_for_columns Number Distance to perimeter used for integration (k * d), can be undefined (is not set, 2.0 as default)
property_node_distance_to_perimeter_used_for_integration_for_walls Number Distance to perimeter used for integration (k * d), can be undefined (is not set, 2.0 as default)

# concreteDesignStrengthConfigurationACI.SetPunching_AdditionalParameters(property_node_minimum_spacing_of_reinforcement_perimeters)

Sets Additional Parameters

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_node_minimum_spacing_of_reinforcement_perimeters Number Minimum spacing of reinforcement perimeters, can be undefined (is not set, 0.1 as default)

# concreteDesignStrengthConfigurationACI.SetPunching_Factors(property_node_strength_reduction_factor_tensile, property_node_strength_reduction_factor_shear_and_torsion)

Sets Factors

Kind: instance method of ConcreteDesignStrengthConfigurationACI

Param Type Description
property_node_strength_reduction_factor_tensile Number Strength reduction factors according to 21.2.1 - Tensile strength, can be undefined (is not set, 0.9 as default)
property_node_strength_reduction_factor_shear_and_torsion Number Strength reduction factors according to 21.2.1 - Shear and torsion, can be undefined (is not set, 0.75 as default)

# ConcreteDesignUltimateConfigurationCSA

Kind: global class

# new ConcreteDesignUltimateConfigurationCSA(no, surfaces_no, members_no, nodes_no, comment, params)

Creates Concrete design ultimate configuration (CSA standard)

Param Type Description
no Number Ultimate configuration number, can be undefined
surfaces_no Array Assigned surfaces numbers, can be undefined
members_no Array Assigned members numbers, can be undefined
nodes_no Array Assigned nodes numbers, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# concreteDesignUltimateConfigurationCSA.GetNo() ⇒

Kind: instance method of ConcreteDesignUltimateConfigurationCSA
Returns: Ultimate configuration index

# concreteDesignUltimateConfigurationCSA.GetUltimateConfiguration() ⇒

Kind: instance method of ConcreteDesignUltimateConfigurationCSA
Returns: Ultimate configuration object

# concreteDesignUltimateConfigurationCSA.SetName(name)

Sets Name

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
name String Ultimate configuration name, can be undefined

# concreteDesignUltimateConfigurationCSA.SetMembers_ConsiderInternalForces(property_member_axial_forces, property_member_bending_moments_my, property_member_bending_moments_mz, property_member_torsional_moments, property_member_shear_forces_vy, property_member_shear_forces_vz)

Sets Consider internal forces for concrete design

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_member_axial_forces Boolean Axial forces, can be undefined (is not set, true as default)
property_member_bending_moments_my Boolean Bending moment in Y, can be undefined (is not set, true as default)
property_member_bending_moments_mz Boolean Bending moment in Z, can be undefined (is not set, true as default)
property_member_torsional_moments Boolean Torsional moments, can be undefined (is not set, true as default)
property_member_shear_forces_vy Boolean Shear forces in Y, can be undefined (is not set, true as default)
property_member_shear_forces_vz Boolean Shear forces in Z, can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationCSA.SetMembers_InternalForceReductionZ(property_member_redistribution_of_moments_in_continuous_flexural_members, property_member_reduction_of_moments_or_dimensioning_for_moments_at_face_of_monolithic_support, property_member_reduction_of_shear_at_support)

Sets Internal Force Reduction in z-Direction

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_member_redistribution_of_moments_in_continuous_flexural_members Boolean Redistribution of moments in continuous flexural members acc. to 9.2.4, can be undefined (is not set, false as default)
property_member_reduction_of_moments_or_dimensioning_for_moments_at_face_of_monolithic_support Boolean Reduction of moments or dimensioning for moments at face of a monolithic support, can be undefined (is not set, false as default)
property_member_reduction_of_shear_at_support Boolean Reduction of shear at the support acc. to 11.3.2, can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationCSA.SetMembers_RequiredLongitudinalReinforcement(property_member_reinforcement_layout, property_member_reinforcement_diameter_for_preliminary_design, property_member_increase_of_tension_required_reinforcement_due_to_shear)

Sets Required longitudinal reinforcement

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_member_reinforcement_layout String Reinforcement layout (TOP_BOTTOM_OPTIMIZED_DISTRIBUTION, TOP_BOTTOM_SYMMETRICAL_DISTRIBUTION, IN_CORNERS_SYMMETRICAL_DISTRIBUTION, UNIFORMLY_SURROUNDING, FACTORIZED_PROVIDED_REINFORCEMENT, OPTIMIZED_PROVIDED_REINFORCEMENT), can be undefined (is not set, OPTIMIZED_PROVIDED_REINFORCEMENT as default)
property_member_reinforcement_diameter_for_preliminary_design String/Number Reinforcement diameter for preliminary design (MAX_OF_ALL or user-defined value), can be undefined (is not set as default, otherwise MAX_OF_ALL as default)
property_member_increase_of_tension_required_reinforcement_due_to_shear Boolean Increase of required tension reinforcement due to shear acc. to 11.3.9.2, can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationCSA.SetMembers_Factors(property_member_strength_reduction_factor_concrete, property_member_strength_reduction_factor_reinforcing, property_member_strength_reduction_factor_concrete_stress_strain_relationship)

Sets Factors

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_member_strength_reduction_factor_concrete Number Strength reduction factors acc. to 8.4 - Concrete factor, van be undefined (is not set, 0.65 as default)
property_member_strength_reduction_factor_reinforcing Number Strength reduction factors acc. to 8.4 - Reinforcing factor, can be undefined (is not set, 0.85 as default)
property_member_strength_reduction_factor_concrete_stress_strain_relationship Number Strength reduction factors acc. to 8.4 - Concrete stress-strain relationship factor acc. to 10.1.6, can be undefined (is not set, 0.9 as default)

# concreteDesignUltimateConfigurationCSA.SetMembers_MinimumReinforcement(property_member_minimum_longitudinal_reinforcement, property_member_minimum_shear_reinforcement, property_member_minimum_construction_reinforcement)

Sets Minimum Reinforcement Acc. to Standard

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_member_minimum_longitudinal_reinforcement Boolean Minimum longitudinal reinforcement acc. to standard, can be undefined (is not set, true as default)
property_member_minimum_shear_reinforcement Boolean Minimum shear reinforcement acc. to standard, can be undefined (is not set, true as default)
property_member_minimum_construction_reinforcement Boolean Minimum construction reinforcement, can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationCSA.SetMembers_RequiredShearReinforcement(shear_reinforcement)

Sets Required Shear Reinforcement - Shear Capacity

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
shear_reinforcement String Use required longitudinal reinforcement (REQUIRED) Use provided longitudinal reinforcement (PROVIDED)

# concreteDesignUltimateConfigurationCSA.SetMembers_ShearAndTorsionReinforcement(determination_type, property_member_beta, property_member_theta)

Sets Shear and Torsion Reinforcement

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
determination_type String Determination of β and θ acc. to 11.3.6, can be undefined (is not set, GENERAL_METHOD as default) - General method acc. to 11.3.6.4 (GENERAL_METHOD) - Values for special members acc. to 11.3.6.2 (SPECIAL_MEMBERS)
property_member_beta Number Factor accounting for shear resistance of cracked concrete, can be undefined (is not set, 0.21 as default)
property_member_theta Number Angle of inclination of diagonal compressive stresses to longitudinal axis of member, can be undefined (is not set, 0.42 as default)

# concreteDesignUltimateConfigurationCSA.SetMembers_NeutralAxisDepthLimitation(property_member_consider_neutral_axis_depth_limitation, property_member_value_of_neutral_axis_depth_limitation_user_value)

Sets Sets Depth Limitation of Neutral Axis

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_member_consider_neutral_axis_depth_limitation Boolean Consider depth limitation of neutral axis acc. to 10.5.2, can be undefined (is not set, false as default)
property_member_value_of_neutral_axis_depth_limitation_user_value String/Number Value of neutral axis depth limitation (AUTOMATICALLY or user number value), can be undefined (is not set, AUTOMATICALLY as default)

# concreteDesignUltimateConfigurationCSA.SetMembers_CalculationSetting(property_member_nett_concrete_area)

Sets Calculation setting

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_member_nett_concrete_area Boolean Net concrete area, can be undefined (true as default)

# concreteDesignUltimateConfigurationCSA.SetMembers_EpoxyFactor(epoxy_factor_type)

Sets Epoxy factor

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
epoxy_factor_type String Epoxy factor type, can be undefined (is not set, UNCOATED_OR_ZINC_COATED as default) - Epoxy-coated reinforcement (EPOXY_COATED_OR_ZINC) - Uncoated reinforcement (UNCOATED_OR_ZINC_COATED)

# concreteDesignUltimateConfigurationCSA.SetStability_UnbracedColumn(property_stability_index_qy, property_stability_index_qz)

Sets Unbraced Column

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_stability_index_qy Number Stability index for story in y-direction, can be undefined (is not set, 0.05 as default)
property_stability_index_qz Number Stability index for story in z-direction, can be undefined (is not set, 0.05 as default)

# concreteDesignUltimateConfigurationCSA.SetStability_RequiredReinforcement(property_stability_reinforcement_layout, reinforcement_diameter_for_preliminary_design_user_value)

Sets Required Reinforcement

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_stability_reinforcement_layout String Reinforcement layout (TOP_BOTTOM_SYMMETRICAL_DISTRIBUTION, IN_CORNERS_SYMMETRICAL_DISTRIBUTION, UNIFORMLY_SURROUNDING, FACTORIZED_PROVIDED_REINFORCEMENT), can be undefined (is not set, UNIFORMLY_SURROUNDING as default)
reinforcement_diameter_for_preliminary_design_user_value String/Number Reinforcement diameter for preliminary design (MAX_OF_ALL or user number value), can be undefined (is not set, MAX_OF_ALL as default)

# concreteDesignUltimateConfigurationCSA.SetSurfaces_DesignMethod(optimization_type)

Sets Design method

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
optimization_type String Design method optimization type, can be undefined (is not set, YES as default) - No optimization of design internal forces (NO) - Optimization of design internal forces (YES)

# concreteDesignUltimateConfigurationCSA.SetSurfaces_InternalForcesDiagramUsedForDesign(property_subtraction_of_rib_components)

Sets Internal Forces Diagram Used for Design

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_subtraction_of_rib_components Boolean Subtraction of rib components for the ULS calculation and for the analytic method of SLS calculation, can be undefined (true as default)

# concreteDesignUltimateConfigurationCSA.SetSurfaces_Factors(property_surface_strength_reduction_factor_concrete, property_surface_strength_reduction_factor_reinforcing, property_surface_strength_reduction_factor_concrete_stress_strain_relationship)

Sets Factors

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_surface_strength_reduction_factor_concrete Number Strength reduction factors acc. to 8.4 - Concrete factor, can be undefined (is not set, 0.65 as default)
property_surface_strength_reduction_factor_reinforcing Number Strength reduction factors acc. to 8.4 - Reinforcing factor, can be undefined (is not set, 0.85 as default)
property_surface_strength_reduction_factor_concrete_stress_strain_relationship Number Strength reduction factors acc. to 8.4 - Concrete stress-strain relationship factor acc. to 10.1.6, can be undefined (is not set, 0.90 as default)

# concreteDesignUltimateConfigurationCSA.SetSurfaces_MinimumLongitudinalReinforcement(property_minimum_longitudinal_reinforcement_acc_to_standard, reinforcement_type, min_reinforcement_direction, min_reinforcement_direction_user_values, main_compression_reinforcement_direction, property_surface_reinforcement_defined_direction_phi)

Sets Minimum longitudinal reinforcement acc. to standard

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_minimum_longitudinal_reinforcement_acc_to_standard Boolean Minimum longitudinal reinforcement acc. to standard, can be undefined (is not set, true as default)
reinforcement_type String Minimum longitudinal reinforcement acc. to standard type, can be undefined (is not set, PLATES as default) - Minimum longitudinal reinforcement for plates acc. to 7.8.1 (PLATES) - Minimum longitudinal reinforcement for walls acc. to 14.1.8.5 and 14.1.8.6 (WALLS)
min_reinforcement_direction String Direction of minimum reinforcement, can be undefined (is not set, MAIN_TENSION_ELEMENT as default) - On main tension side (MAIN_TENSION_ELEMENT) - In tension direction (MAIN_TENSION_SURFACE) - Defined (DEFINED)
min_reinforcement_direction_user_values Array User-defined direction of minimum reinforcement ([φ1(-z), φ2(-z), φ1(+z), φ2(+z)]), can be undefined (if not set, all values are true by default)
main_compression_reinforcement_direction String Direction of main compression reinforcement, can be undefined (is not set, WITH_MAIN_COMPRESSION_FORCE as default) - Reinforcement direction with the main compression force (WITH_MAIN_COMPRESSION_FORCE) - Defined in reinforcement direction (DEFINED_IN_REINFORCEMENT_DIRECTION)
property_surface_reinforcement_defined_direction_phi String Reinforcement direction (PHI_1, PHI_2)

# concreteDesignUltimateConfigurationCSA.SetSurfaces_UserDefinedMinimumLongitudinalReinforcementPercentage(property_user_defined_minimum_longitudinal_reinforcement_percentage, property_minimum_reinforcement, property_minimum_secondary_reinforcement, property_minimum_tension_reinforcement, property_minimum_compression_reinforcement)

Sets User-defined minimum longitudinal reinforcement percentage

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_user_defined_minimum_longitudinal_reinforcement_percentage Boolean User-defined minimum longitudinal reinforcement percentage, can be undefined (is not set, false as default)
property_minimum_reinforcement Number Minimum reinforcement, can be undefined (is not set, 0% as default)
property_minimum_secondary_reinforcement Number Minimum secondary reinforcement from main reinforcement direction, can be undefined (is not set, 20% as default)
property_minimum_tension_reinforcement Number Minimum tension reinforcement, can be undefined (is not set, 0% as default)
property_minimum_compression_reinforcement Number Minimum compression reinforcement, can be undefined (is not set, 0% as default)

# concreteDesignUltimateConfigurationCSA.SetSurfaces_UserDefinedMaximumLongitudinalReinforcementPercentage(property_user_defined_maximum_longitudinal_reinforcement_percentage, property_user_defined_maximum_longitudinal_reinforcement_percentage_value)

Sets User-defined maximum longitudinal reinforcement percentage

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_user_defined_maximum_longitudinal_reinforcement_percentage Boolean User-defined maximum longitudinal reinforcement percentage, can be undefined (is not set, true as default)
property_user_defined_maximum_longitudinal_reinforcement_percentage_value Number Maximum reinforcement, can be undefined (is not set, 4% as default)

# concreteDesignUltimateConfigurationCSA.SetSurfaces_MinimumShearReinforcement(property_minimum_shear_reinforcement)

Sets Minimum shear reinforcement acc. to 11.2.8.1

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_minimum_shear_reinforcement Boolean Minimum shear reinforcement, can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationCSA.SetSurfaces_UserDefinedMinimumShearReinforcementPercentage(property_user_defined_minimum_shear_reinforcement_percentage, property_user_defined_minimum_shear_reinforcement_percentage_value)

Sets User-defined minimum shear reinforcement percentage

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_user_defined_minimum_shear_reinforcement_percentage Boolean Minimum shear reinforcement percentage, can be undefined (is not set, false as default)
property_user_defined_minimum_shear_reinforcement_percentage_value Number Minimum reinforcement, can be undefined, (is not set, 0% as default)

# concreteDesignUltimateConfigurationCSA.SetSurfaces_RequiredShearReinforcement(required_shear_reinforcement)

Sets Required Shear Reinforcement - Shear Capacity

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
required_shear_reinforcement String Required Shear Reinforcement value, can be undefined (is not set, REQUIRED as default) - Use required longitudinal reinforcement (REQUIRED) - Use provided longitudinal reinforcement (PROVIDED) - Automatically increase required longitudinal reinf. to avoid shear reinf. (AUTOMATICALLY)

# concreteDesignUltimateConfigurationCSA.SetSurfaces_ShearReinforcement(determination_method, property_surface_beta, property_surface_theta)

Set Shear reinforcement

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
determination_method String Determination of β and θ acc. to 11.3.6, can be undefined (is not set, GENERAL_METHOD as default) - General method acc. to 11.3.6.4 (GENERAL_METHOD) - Values for special surfaces acc. to 11.3.6.2 (SPECIAL_SURFACES)
property_surface_beta Number β, can be undefined (is not set, 0.21 as default)
property_surface_theta Number θ, can be undefined (is not set, 42 as default)

# concreteDesignUltimateConfigurationCSA.SetSurfaces_NeutralAxisDepthLimitation(property_member_consider_neutral_axis_depth_limitation, property_member_value_of_neutral_axis_depth_limitation_user_value)

Sets Depth Limitation of Neutral Axis

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_member_consider_neutral_axis_depth_limitation Boolean Consider depth limitation of neutral axis acc. to 10.5.2, can be undefined (is not set, false as default)
property_member_value_of_neutral_axis_depth_limitation_user_value String/Number Value of neutral axis depth limitation (AUTOMATICALLY or user number value), can be undefined (is not set, AUTOMATICALLY as default)

# concreteDesignUltimateConfigurationCSA.SetPunching_PunchingLoad(property_node_used_punching_load_for_columns, property_node_used_punching_load_for_walls, property_node_distance_to_perimeter_used_for_integration_for_columns, property_node_distance_to_perimeter_used_for_integration_for_walls)

Sets Punching Load

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_node_used_punching_load_for_columns String/Number Used punching load for columns (SINGLE_FORCE, SMOOTHED_SHEAR_FORCE or user-defined value), can be undefined (is not set, SINGLE_FORCE as default) - Single force from column / load / nodal support (SINGLE_FORCE) - Smoothed shear force over the defined perimeter (SMOOTHED_SHEAR_FORCE)
property_node_used_punching_load_for_walls String/Number Used punching load for walls (SMOOTHED_SHEAR_FORCE or user-defined value), can be undefined (is not set, SMOOTHED_SHEAR_FORCE as default) - Smoothed shear force over the defined perimeter (SMOOTHED_SHEAR_FORCE)
property_node_distance_to_perimeter_used_for_integration_for_columns Number Distance to perimeter used for integration (k * d), can be undefined (is not set, 2.0 as default)
property_node_distance_to_perimeter_used_for_integration_for_walls Number Distance to perimeter used for integration (k * d), can be undefined (is not set, 2.0 as default)

# concreteDesignUltimateConfigurationCSA.SetPunching_AdditionalParameters(property_node_minimum_spacing_of_reinforcement_perometers)

Sets Additional Parameters

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_node_minimum_spacing_of_reinforcement_perometers Number Minimum spacing of reinforcement perimeters, can be undefined (is not set, 0.1 as default)

# concreteDesignUltimateConfigurationCSA.SetPunching_Factors(property_node_strength_reduction_factor_concrete, property_node_strength_reduction_factor_reinforcing)

Sets Factors

Kind: instance method of ConcreteDesignUltimateConfigurationCSA

Param Type Description
property_node_strength_reduction_factor_concrete Number Strength reduction factors acc. to 8.4 - Concrete factor, can be undefined (is not set, 0.65 as default)
property_node_strength_reduction_factor_reinforcing Number Strength reduction factors acc. to 8.4 - Shear and torsion, can be undefined (is not set, 0.85 as default)

# ConcreteDesignUltimateConfigurationEN

Kind: global class

# new ConcreteDesignUltimateConfigurationEN(no, surfaces_no, members_no, nodes_no, comment, params)

Creates Concrete design ultimate configuration (EN standard)

Param Type Description
no Number Ultimate configuration number, can be undefined
surfaces_no Array Assigned surfaces numbers, can be undefined
members_no Array Assigned members numbers, can be undefined
nodes_no Array Assigned nodes numbers, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# concreteDesignUltimateConfigurationEN.GetNo() ⇒

Kind: instance method of ConcreteDesignUltimateConfigurationEN
Returns: Ultimate Configuration index

# concreteDesignUltimateConfigurationEN.GetUltimateConfiguration() ⇒

Kind: instance method of ConcreteDesignUltimateConfigurationEN
Returns: Ultimate Configuration object

# concreteDesignUltimateConfigurationEN.SetName(name)

Sets Name

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
name String Ultimate configuration name, can be undefined

# concreteDesignUltimateConfigurationEN.SetMembers_ConsiderInternalForces(property_member_axial_forces, property_member_bending_moments_my, property_member_bending_moments_mz, property_member_torsional_moments, property_member_shear_forces_vy, property_member_shear_forces_vz)

Sets Consider internal forces for concrete design

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_member_axial_forces Boolean Axial forces, can be undefined (is not set, true as default)
property_member_bending_moments_my Boolean Bending moment in Y, can be undefined (is not set, true as default)
property_member_bending_moments_mz Boolean Bending moment in Z, can be undefined (is not set, true as default)
property_member_torsional_moments Boolean Torsional moments, can be undefined (is not set, true as default)
property_member_shear_forces_vy Boolean Shear forces in Y, can be undefined (is not set, true as default)
property_member_shear_forces_vz Boolean Shear forces in Z, can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationEN.SetMembers_ReductionsOfInternalForcesInZ(property_member_consideration_of_limited_moment_redistribution_of_the_supporting_moments, property_member_reduction_of_the_moments_or_dimensioning_for_the_moments_at_the_face_of_a_monolithic_support, property_member_reduction_of_the_shear_forces_in_the_support_face_and_distance, property_member_reduction_of_the_shear_forces_with_concentrated_load, property_member_consideration_of_minimum_eccentricity)

Sets Reduction of internal forces in z-direction

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_member_consideration_of_limited_moment_redistribution_of_the_supporting_moments Boolean Consideration of limited moment redistribution of the supporting moments according to 5.5, can be undefined (is not set, false as default)
property_member_reduction_of_the_moments_or_dimensioning_for_the_moments_at_the_face_of_a_monolithic_support Boolean Reduction of the moments or dimensioning for the moments at the face of a monolithic support according to 5.3.2.2, can be undefined (is not set, false as default)
property_member_reduction_of_the_shear_forces_in_the_support_face_and_distance Boolean Reduction of the shear forces in the support face and distance d acc. to 6.2.1(8), can be undefined (is not set, true as default)
property_member_reduction_of_the_shear_forces_with_concentrated_load Boolean Reduction of the shear forces with concentrated load acc. to 6.2.2(6) and 6.2.3(8), can be undefined (is not set, false as default)
property_member_consideration_of_minimum_eccentricity Boolean Consideration of minimum eccentricity acc. to 6.1(4), can be undefined (is not set, false as default)

# concreteDesignUltimateConfigurationEN.SetMembers_RequiredLongitudinalReinforcement(property_member_reinforcement_layout, property_member_reinforcement_diameter_for_preliminary_design, property_member_reinforcement_distribute_over_slab, property_member_reinforcement_distribute_over_slab_reduced_width, property_member_include_tensile_force_due_to_shear_in_required_longitudinal_reinforcement)

Sets Required longitudinal reinforcement

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_member_reinforcement_layout String Reinforcement layout (TOP_BOTTOM_OPTIMIZED_DISTRIBUTION, TOP_BOTTOM_SYMMETRICAL_DISTRIBUTION, IN_CORNERS_SYMMETRICAL_DISTRIBUTION, UNIFORMLY_SURROUNDING, FACTORIZED_PROVIDED_REINFORCEMENT, OPTIMIZED_PROVIDED_REINFORCEMENT), can be undefined (is not set, OPTIMIZED_PROVIDED_REINFORCEMENT as default)
property_member_reinforcement_diameter_for_preliminary_design String/Number Reinforcement diameter for preliminary design (MAX_OF_ALL or user-defined value), can be undefined (is not set as default, otherwise MAX_OF_ALL as default)
property_member_reinforcement_distribute_over_slab Boolean Distribute reinforcement evenly over complete slab width, can be undefined (is not set, false as default)
property_member_reinforcement_distribute_over_slab_reduced_width Number Distribute reinforcement evenly over complete slab width - Distribute the tensile reinforcement in the slab over a width of, can be undefined (is not set, 100% as default)
property_member_include_tensile_force_due_to_shear_in_required_longitudinal_reinforcement Boolean Include tensile force due to shear in required longitudinal reinforcement, can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationEN.SetMembers_DetailingAndParticularRules(property_member_minimum_longitudinal_reinforcement, property_member_user_defined_minimum_longitudinal_reinforcement_area, property_member_minimum_reinforcement_area, property_member_top_minimum_reinforcement_area, property_member_bottom_minimum_reinforcement_area, property_member_total_minimum_reinforcement_area, property_member_minimum_reinforcement_percentage, property_member_total_minimum_percentage_reinforcement_area, property_member_minimum_shear_reinforcement, property_member_use_compression_longitudinal_reinforcement_for_maximum_stirrup_spacing, property_member_compression_longitudinal_reinforcement_for_maximum_stirrup_spacing, property_member_minimum_construction_reinforcement, property_member_design_check_for_tensile_force_in_longitudinal_reinforcement)

Sets Detailing and particular rules

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_member_minimum_longitudinal_reinforcement Boolean Minimum longitudinal reinforcement acc. to standard, can be undefined (is not set, true as default)
property_member_user_defined_minimum_longitudinal_reinforcement_area Boolean User-defined minimum longitudinal reinforcement area, can be undefined (is not set, true as default)
property_member_minimum_reinforcement_area Boolean Minimum reinforcement area, can be undefined (is not set, true as default)
property_member_top_minimum_reinforcement_area Number Top reinforcement area, can be undefined (is not set, 0.0 as default)
property_member_bottom_minimum_reinforcement_area Number Bottom reinforcement area, can be undefined (is not set, 0.0 as default)
property_member_total_minimum_reinforcement_area Number Total reinforcement area, can be undefined (is not set, 0.0 as default)
property_member_minimum_reinforcement_percentage Boolean Minimum reinforcement percentage
property_member_total_minimum_percentage_reinforcement_area Number Total reinforcement area, can be undefined (is not set, 0.0 as default)
property_member_minimum_shear_reinforcement Boolean Minimum shear reinforcement acc. to standard, can be undefined (is not set, true as default)
property_member_use_compression_longitudinal_reinforcement_for_maximum_stirrup_spacing Boolean Compression longitudinal reinforcement for maximum stirrup spacing acc. to 9.2.1.2(3), can be undefined (is not set, false as default)
property_member_compression_longitudinal_reinforcement_for_maximum_stirrup_spacing String Considered longitudinal reinforcement (MAXIMUM_STIRRUP_SPACING_REQUIRED, MAXIMUM_STIRRUP_SPACING_PROVIDED), can be undefined (is not set, MAXIMUM_STIRRUP_SPACING_REQUIRED as default)
property_member_minimum_construction_reinforcement Boolean Minimum construction reinforcement acc. to 9.2.1.2(1), 9.2.1.4(1). Requires design support of the type ‘Concrete’ with a monolithic connection to calculate the design check. Can be undefined (is not set, true as default)
property_member_design_check_for_tensile_force_in_longitudinal_reinforcement Boolean Design check for tensile force in longitudinal reinforcement, including tension due to shear acc. to 9.2.1.3(2), can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationEN.SetMembers_RequiredShearReinforcement(shear_reinforcement)

Sets Required Shear Reinforcement - Shear Capacity

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
shear_reinforcement String Use required longitudinal reinforcement (REQUIRED) Use provided longitudinal reinforcement (PROVIDED) Automatically increase required longitudinal reinf. to avoid shear reinf. (AUTOMATICALLY)

# concreteDesignUltimateConfigurationEN.SetMembers_ShearJoint(property_member_shear_joint_design, analysis_method, property_member_shear_joint_fatigue_or_dynamic_loads, property_member_shear_joint_normal_stress_across_joint_surfaces, property_member_shear_joint_design_of_flange_connections_on_segmented_cross_sections)

Sets Shear Joint

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_member_shear_joint_design Boolean Design of shear joint, can be undefined (is not set, true as default)
analysis_method String Analytical with shear force Vz,Ed and β-factor acc. to Eq. 6.24 (Mz,Ed not considered) (ANALYTICAL_WITH_SHEAR_FORCE) or General integration of axial stresses into section parts (GENERAL_INTEGRATION_OF_AXIAL_STRESSES)
property_member_shear_joint_fatigue_or_dynamic_loads Boolean Fatigue or dynamic loads acc. to 6.2.5 (5), can be undefined (is not set, false as default)
property_member_shear_joint_normal_stress_across_joint_surfaces Number Normal stress across joint surfaces (tension negative), can be undefined (0.0 as default)
property_member_shear_joint_design_of_flange_connections_on_segmented_cross_sections Boolean Design of flange connections on segmented cross-sections, can be undefined (false as default)

# concreteDesignUltimateConfigurationEN.SetMembers_NeutralAxisDepthLimitation(property_member_consider_neutral_axis_depth_limitation, property_member_value_of_neutral_axis_depth_limitation)

Sets Neutral Axis Depth Limitation

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_member_consider_neutral_axis_depth_limitation Boolean Consider neutral axis depth limitation acc. to 5.6.2(2), 5.6.3(2), can be undefined (is not set, false as default)
property_member_value_of_neutral_axis_depth_limitation Number Value of neutral axis depth limitation, can be undefined (is not set, 0.45 as default)

# concreteDesignUltimateConfigurationEN.SetMembers_CalculationSetting(property_member_net_concrete_area)

Sets Calculation setting

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_member_net_concrete_area Boolean Net concrete area, can be undefined (true as default)

# concreteDesignUltimateConfigurationEN.SetMembers_FiberConcrete(fiber_concrete_effect, property_member_fiber_concrete_material_model_for_tension_strains, property_member_fiber_concrete_size_factor_kfg_calculate_from_tension_area)

Sets Fiber Concrete

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
fiber_concrete_effect String Fiber concrete effect, can be undefined (is not set, BENDING_AND_SHEAR_DESIGN as default) - In bending and shear design (BENDING_AND_SHEAR_DESIGN) - In torsion design (TORSION_DESIGN)
property_member_fiber_concrete_material_model_for_tension_strains * Material model for tension strains (SDL1, SDL2, SDL3), can be undefined (is not set, SDL1 as default)
property_member_fiber_concrete_size_factor_kfg_calculate_from_tension_area * Size factor κfG calculated from tension area Afct, can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationEN.SetStability_SlendernessAboutY(property_stability_determine_factor_ay, property_stability_determined_factor_ay, property_stability_determine_factor_by, property_stability_determined_factor_by, property_stability_determine_factor_cy, property_stability_determined_factor_cy)

Sets Limiting slenderness about y-axis

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_stability_determine_factor_ay Boolean Determine factor Ay, can be undefined (is not set, false as default)
property_stability_determined_factor_ay Number Determined factor Ay, can be undefined (is not set, 0.7 as default)
property_stability_determine_factor_by Boolean Determine factor By, can be undefined (is not set, false as default)
property_stability_determined_factor_by Number Determined factor By, can be undefined (is not set, 1.1 as default)
property_stability_determine_factor_cy Boolean Determine factor Cy, can be undefined (is not set, false as default)
property_stability_determined_factor_cy Number Determined factor Cy, can be undefined (is not set, 0.7 as default)

# concreteDesignUltimateConfigurationEN.SetStability_SlendernessAboutZ(property_stability_determine_factor_az, property_stability_determined_factor_az, property_stability_determine_factor_bz, property_stability_determined_factor_bz, property_stability_determine_factor_cz, property_stability_determined_factor_cz)

Sets Limiting slenderness about z-axis

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_stability_determine_factor_az Boolean Determine factor Az, can be undefined (is not set, false as default)
property_stability_determined_factor_az Number Determined factor Az, can be undefined (is not set, 0.7 as default)
property_stability_determine_factor_bz Boolean Determine factor Bz, can be undefined (is not set, false as default)
property_stability_determined_factor_bz Number Determined factor Bz, can be undefined (is not set, 1.1 as default)
property_stability_determine_factor_cz Boolean Determine factor Cz, can be undefined (is not set, false as default)
property_stability_determined_factor_cz Number Determined factor Cz, can be undefined (is not set, 0.7 as default)

# concreteDesignUltimateConfigurationEN.SetStability_LoadDistribution(property_stability_structural_system_of_isolated_columns, property_stability_number_of_effective_columns)

Sets Load Distribution

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_stability_structural_system_of_isolated_columns Boolean Structural system of isolated columns, can be undefined (is not set, true as default)
property_stability_number_of_effective_columns Boolean Number of effective columns, can be undefined (is not set, 2 as default)

# concreteDesignUltimateConfigurationEN.SetStability_BiaxialBending(property_stability_separate_design_in_each_principal_direction_acc_5_8_9, property_stability_use_simplified_criterion_acc_5_39)

Sets Biaxial Bending

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_stability_separate_design_in_each_principal_direction_acc_5_8_9 Boolean Separate design in each principal direction acc. to 5.8.9, can be undefined (is not set, false as default)
property_stability_use_simplified_criterion_acc_5_39 Boolean Use simplified criterion acc. to Equation 5.39, can be undefined (is not set, false as default)

# concreteDesignUltimateConfigurationEN.SetStability_RequiredReinforcement(property_stability_reinforcement_layout, reinforcement_diameter_for_preliminary_design_user_value)

Sets Required Reinforcement

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_stability_reinforcement_layout String Reinforcement layout (TOP_BOTTOM_SYMMETRICAL_DISTRIBUTION, IN_CORNERS_SYMMETRICAL_DISTRIBUTION, UNIFORMLY_SURROUNDING, FACTORIZED_PROVIDED_REINFORCEMENT), can be undefined (is not set, UNIFORMLY_SURROUNDING as default)
reinforcement_diameter_for_preliminary_design_user_value String/Number Reinforcement diameter for preliminary design (MAX_OF_ALL or user number value), can be undefined (is not set, MAX_OF_ALL as default)

# concreteDesignUltimateConfigurationEN.SetSurfaces_DesignMethod(optimization_type)

Sets Design method

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
optimization_type String Design method optimization type, can be undefined (is not set, YES as default) - No optimization of design internal forces (NO) - Optimization of design internal forces (YES)

# concreteDesignUltimateConfigurationEN.SetSurfaces_InternalForcesDiagramUsedForDesign(property_subtraction_of_rib_components)

Sets Internal Forces Diagram Used for Design

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_subtraction_of_rib_components Boolean Subtraction of rib components for the ULS calculation and for the analytic method of SLS calculation, can be undefined (true as default)

# concreteDesignUltimateConfigurationEN.SetSurfaces_MinimumLongitudinalReinforcement(property_minimum_longitudinal_reinforcement_acc_to_standard, reinforcement_type, min_reinforcement_direction, min_reinforcement_direction_user_values, main_compression_reinforcement_direction, property_surface_reinforcement_defined_direction_phi)

Sets Minimum longitudinal reinforcement acc. to standard

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_minimum_longitudinal_reinforcement_acc_to_standard Boolean Minimum longitudinal reinforcement acc. to standard, can be undefined (is not set, true as default)
reinforcement_type String Minimum longitudinal reinforcement acc. to standard type, can be undefined (is not set, PLATES as default) - Minimum longitudinal reinforcement for plates acc. to 9.3.1 (PLATES) - Minimum longitudinal reinforcement for walls acc. to 9.6 (WALLS)
min_reinforcement_direction String Direction of minimum reinforcement, can be undefined (is not set, MAIN_TENSION_ELEMENT as default) - Direction with main tension in the element (MAIN_TENSION_ELEMENT) - Direction with main tension in the surface (MAIN_TENSION_SURFACE) - Defined (DEFINED)
min_reinforcement_direction_user_values Array User-defined direction of minimum reinforcement ([φ1(-z), φ2(-z), φ1(+z), φ2(+z)]), can be undefined (if not set, all values are true by default)
main_compression_reinforcement_direction String Direction of main compression reinforcement, can be undefined (is not set, WITH_MAIN_COMPRESSION_FORCE as default) - Reinforcement direction with the main compression force (WITH_MAIN_COMPRESSION_FORCE) - Defined in reinforcement direction (DEFINED_IN_REINFORCEMENT_DIRECTION)
property_surface_reinforcement_defined_direction_phi String Reinforcement direction (PHI_1, PHI_2)

# concreteDesignUltimateConfigurationEN.SetSurfaces_UserDefinedMinimumLongitudinalReinforcementPercentage(property_user_defined_minimum_longitudinal_reinforcement_percentage, property_minimum_reinforcement, property_minimum_secondary_reinforcement, property_minimum_tension_reinforcement, property_minimum_compression_reinforcement)

Sets User-defined minimum longitudinal reinforcement percentage

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_user_defined_minimum_longitudinal_reinforcement_percentage Boolean User-defined minimum longitudinal reinforcement percentage, can be undefined (is not set, false as default)
property_minimum_reinforcement Number Minimum reinforcement, can be undefined (is not set, 0% as default)
property_minimum_secondary_reinforcement Number Minimum secondary reinforcement from main reinforcement direction, can be undefined (is not set, 20% as default)
property_minimum_tension_reinforcement Number Minimum tension reinforcement, can be undefined (is not set, 0% as default)
property_minimum_compression_reinforcement Number Minimum compression reinforcement, can be undefined (is not set, 0% as default)

# concreteDesignUltimateConfigurationEN.SetSurfaces_MaximumLongitudinalReinforcement(property_maximum_longitudinal_reinforcement_acc_to_standard, reinforcement_type)

Sets Maximum longitudinal reinforcement acc. to standard

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_maximum_longitudinal_reinforcement_acc_to_standard Boolean Maximum longitudinal reinforcement acc. to standard, can be undefined (is not set, true as default)
reinforcement_type String Maximum longitudinal reinforcement type, can be undefined (is not set, PLATES as default) - Maximum longitudinal reinforcement for plates acc. to 9.3.1 (PLATES) - Maximum longitudinal reinforcement for walls acc. to 9.6 (WALLS)

# concreteDesignUltimateConfigurationEN.SetSurfaces_UserDefinedMaximumLongitudinalReinforcementPercentage(property_user_defined_maximum_longitudinal_reinforcement_percentage, property_user_defined_maximum_longitudinal_reinforcement_percentage_value)

Sets User-defined maximum longitudinal reinforcement percentage

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_user_defined_maximum_longitudinal_reinforcement_percentage Boolean User-defined maximum longitudinal reinforcement percentage, can be undefined (is not set, true as default)
property_user_defined_maximum_longitudinal_reinforcement_percentage_value Number Maximum reinforcement, can be undefined (is not set, 4% as default)

# concreteDesignUltimateConfigurationEN.SetSurfaces_MinimumShearReinforcement(property_minimum_shear_reinforcement)

Sets Minimum shear reinforcement acc. to 9.3.2

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_minimum_shear_reinforcement Boolean Minimum shear reinforcement, can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationEN.SetSurfaces_UserDefinedMinimumShearReinforcementPercentage(property_user_defined_minimum_shear_reinforcement_percentage, property_user_defined_minimum_shear_reinforcement_percentage_value)

Sets User-defined minimum shear reinforcement percentage

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_user_defined_minimum_shear_reinforcement_percentage Boolean Minimum shear reinforcement percentage, can be undefined (is not set, false as default)
property_user_defined_minimum_shear_reinforcement_percentage_value Number Minimum reinforcement, can be undefined, can be undefined (is not set, 0% as default)

# concreteDesignUltimateConfigurationEN.SetSurfaces_RequiredLongitudinalReinforcement(property_surface_include_tensile_force_due_to_shear_in_required_longitudinal_reinforcement)

Sets Required Longitudinal Reinforcement

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_surface_include_tensile_force_due_to_shear_in_required_longitudinal_reinforcement Boolean Include tensile force due to shear in required longitudinal reinforcement, can be undefined (true as default)

# concreteDesignUltimateConfigurationEN.SetSurfaces_RequiredShearReinforcement(required_shear_reinforcement)

Sets Required Shear Reinforcement - Shear Capacity

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
required_shear_reinforcement String Required Shear Reinforcement value, can be undefined (is not set, REQUIRED as default) - Use required longitudinal reinforcement (REQUIRED) - Use provided longitudinal reinforcement (PROVIDED) - Automatically increase required longitudinal reinf. to avoid shear reinf. (AUTOMATICALLY)

# concreteDesignUltimateConfigurationEN.SetSurfaces_NeutralAxisDepthLimitation(property_surface_consider_neutral_axis_depth_limitation, property_surface_value_of_neutral_axis_depth_limitation)

Sets Neutral Axis Depth Limitation

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_surface_consider_neutral_axis_depth_limitation Boolean Consider neutral axis depth limitation acc. to 5.6.2(2), 5.6.3(2), can be undefined (true as default)
property_surface_value_of_neutral_axis_depth_limitation Number Value of neutral axis depth limitation, can be undefined (is not set, 0.45 as default)

# concreteDesignUltimateConfigurationEN.SetSurfaces_FiberConcrete(property_surface_fiber_concrete_material_model_for_tension_strains, property_surface_fiber_concrete_model_for_compression, property_surface_fiber_concrete_material_model)

Sets Fiber Concrete

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_surface_fiber_concrete_material_model_for_tension_strains String Concrete - Material model for tension strains (SDL1, SDL2, SDL3), can be undefined (is not set, SDL1 as default)
property_surface_fiber_concrete_model_for_compression String Concrete - Model for compression (PARABOLIC_RECTANGULAR, MODEL_PARABOLIC), can be undefined (is not set, PARABOLIC_RECTANGULAR as default)
property_surface_fiber_concrete_material_model String Reinforcement - Material model (BILINEAR_HARDENING, BILINEAR_YIELDING), can be undefined (is not set, BILINEAR_HARDENING as default)

# concreteDesignUltimateConfigurationEN.SetPunching_StructuralElement(property_node_structure_element_type)

Sets Structural Element

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_node_structure_element_type String Structural element type (AUTO, SLAB, FOUNDATION), can be undefined (is not set, AUTO as default)

# concreteDesignUltimateConfigurationEN.SetPunching_PunchingLoadForColumns(property_node_used_punching_load_for_columns, property_node_used_defined_value_of_punching_force, property_node_direction_of_punching_force, property_node_used_punching_load_inside_critical_perimeter_for_columns, property_user_defined_load_inside_critical_perimeter_factor_for_columns, property_node_load_inside_critical_perimeter_factor_for_columns)

Sets Punching Load - Columns

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_node_used_punching_load_for_columns String Used punching load for columns (SINGLE_FORCE, SMOOTHED_SHEAR_FORCE, UNSMOOTHED_SHEAR_FORCE, USER_DEFINED), can be undefined (is not set, SINGLE_FORCE as default)
property_node_used_defined_value_of_punching_force Number User defined value of punching force, can be undefined (is not set, 100 kN as default)
property_node_direction_of_punching_force String Direction of punching force (DETERMINE, PLUS_Z, MINUS_Z), can be undefined (is not set, DETERMINE as default)
property_node_used_punching_load_inside_critical_perimeter_for_columns Boolean Consider surface load inside critical perimeter, can be undefined (is not set, false as default)
property_user_defined_load_inside_critical_perimeter_factor_for_columns Boolean User-defined surface load inside critical perimeter, can be undefined (is not set, false as default)
property_node_load_inside_critical_perimeter_factor_for_columns Number User-defined Load inside critical perimeter factor for columns, can be undefined (is not set, 10 kn/m2 as default)

# concreteDesignUltimateConfigurationEN.SetPunching_PunchingLoadForWalls(property_node_used_punching_load_for_walls, property_node_used_punching_load_inside_critical_perimeter_for_walls, property_user_defined_load_inside_critical_perimeter_factor_for_walls, property_node_load_inside_critical_perimeter_factor_for_walls)

Sets Punching Load - Walls

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_node_used_punching_load_for_walls String Used punching load for walls, can be undefined (is not set, SMOOTHED_SHEAR_FORCE as default)
property_node_used_punching_load_inside_critical_perimeter_for_walls Boolean Consider surface load inside critical perimeter, can be undefined (is not set, false as default)
property_user_defined_load_inside_critical_perimeter_factor_for_walls Boolean User-defined surface load inside critical perimeter, can be undefined (is not set, false as default)
property_node_load_inside_critical_perimeter_factor_for_walls Number User-defined load inside critical perimeter factor for walls, can be undefined (is not set, 12 kN/m2 as default)

# concreteDesignUltimateConfigurationEN.SetPunching_DeductibleSurfaceLoadForSlab(property_node_deductible_surface_load_for_slab, surface_load_for_slab_type, property_node_deductible_portion_for_slab, property_node_deductible_portion_for_slab_user_defined_value, property_node_distance_deductible_surface, property_node_multiple_static_depth_for_slab)

Sets Punching load - Deductible surface load for slab

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_node_deductible_surface_load_for_slab Boolean Deductible surface load for slab, can be undefined (is not set, false as default)
surface_load_for_slab_type String Used punching load for walls (AUTOMATICALLY, USER_DEFINED), can be undefined (is not set, AUTOMATICALLY as default)
property_node_deductible_portion_for_slab Number Deductible portion, can be undefined (is not set, 100% as default)
property_node_deductible_portion_for_slab_user_defined_value Number User-defined deductible portion for slab value, can be undefined (is not set, 10 kN/m2 as default)
property_node_distance_deductible_surface String Distance of deductible surface (L_W_OUT, K_D), can be undefined (is not set, L_W_OUT as default)
property_node_multiple_static_depth_for_slab String Multiple static depth (k * d), can be undefined (is not set, 1 as default)

# concreteDesignUltimateConfigurationEN.SetPunching_LoadedAreaOfPunchingNode(property_node_define_loaded_area_for_punching_node_type_column, property_node_shape_of_loaded_area, shape_parameters, property_node_define_wall_thicknesses_for_punching_node_type_wall, property_node_wall_thickness_1, property_node_wall_thickness_2)

Sets Loaded Area of Punching Node

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_node_define_loaded_area_for_punching_node_type_column Boolean Define loaded area for punching node type "Column", can be undefined (is not set, false as default)
property_node_shape_of_loaded_area String Shape of loaded area (RECTANGULAR, CIRCULAR), can be undefined (is not set, RECTANGULAR as default)
shape_parameters Array [Width in direction x, Width in direction y, Rotation] array for RECTANGULAR shape of loaded area - [Diameter] array for CIRCULAR shape of loaded area
property_node_define_wall_thicknesses_for_punching_node_type_wall Boolean Define wall thicknesses for punching node type "Wall", can be undefined (is not set, false as default)
property_node_wall_thickness_1 Number Wall thickness 1 (Wall End, Wall Corner), can be undefined (is not set, 0.24 m as default)
property_node_wall_thickness_2 Number Wall thickness 2 (Wall Corner), can be undefined (is not set, 0.2 m as default)

# concreteDesignUltimateConfigurationEN.SetPunching_BasicControlPerimeter(property_node_define_critical_section_for_slab, property_node_distance)

Sets Basic control perimeter

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_node_define_critical_section_for_slab Boolean Define critical section for slab, can be undefined (is not set, false as default)
property_node_distance Number Distance, can be undefined (is not set, 0.29 m as default)

# concreteDesignUltimateConfigurationEN.SetPunching_MeanEffectiveDepth(property_node_define_region_of_detection_of_effective_depth, property_node_distance_from_loading_area, property_node_column_penetration, property_node_penetration_on_top_side, property_node_penetration_on_bottom_side)

Sets Mean effective depth

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_node_define_region_of_detection_of_effective_depth Boolean The minimum effective depth is used for the calculation in this area, can be undefined (is not set, false as default)
property_node_distance_from_loading_area Number Distance from loading area, can be undefined (is not set, 0.5 m as default)
property_node_column_penetration Boolean Column penetration reduces mean effective depth, can be undefined (is not set, false as default)
property_node_penetration_on_top_side Number Penetration on top side (-z), can be undefined (is not set, 0.02 m as default)
property_node_penetration_on_bottom_side Number Penetration on bottom side (+z), can be undefined (is not set, 0.02 m as default)

# concreteDesignUltimateConfigurationEN.SetPunching_PunchingShearReinforcement(property_node_punch_s_r_min, property_node_define_perimeter, property_node_define_sections_for_analysis_of_punching_shear_reinforcement, property_node_number_of_inner_control_perimeters, property_node_define_distance_to_loaded_area, property_node_first_distance, property_node_radial_spacing, property_node_define_outer_control_perimeter, property_node_distance_of_outer_control_perimeter_to_loaded_area)

Sets Punching shear reinforcement

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_node_punch_s_r_min Number Minimum Spacing of Reinforcement Perimeters, can be undefined (is not set, 0.1 m as default)
property_node_define_perimeter Boolean Define perimeter, can be undefined (is not set, false as default)
property_node_define_sections_for_analysis_of_punching_shear_reinforcement Boolean Define sections for analysis of punching shear reinforcement, can be undefined (is not set, false as default)
property_node_number_of_inner_control_perimeters Number Number of inner control perimeter, can be undefined (is not set, 2 as default)
property_node_define_distance_to_loaded_area Boolean Distance to load area, can be undefined (is not set, false as default)
property_node_first_distance Number 1st distance, can be undefined (is not set, 0.3 m as default)
property_node_radial_spacing Number Radial spacing, can be undefined (is not set, 0.2 m as default)
property_node_define_outer_control_perimeter Boolean Define outer control perimeter, can be undefined (is not set, false as default)
property_node_distance_of_outer_control_perimeter_to_loaded_area Number Distance to load area, can be undefined (is not set, 2 m as default)

# concreteDesignUltimateConfigurationEN.SetPunching_AdditionalParameters(property_node_variable_thickness_definition, property_node_reference_surfaces_thickness, property_node_reference_surface_no)

Sets Additional Parameters

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_node_variable_thickness_definition String/Number Definition of variable thickness (AUTO or user-defined number), can be undefined (is not set, AUTO as default)
property_node_reference_surfaces_thickness String/Number Thickness of reference surfaces (MINIMUM_THICKNESS, MAXIMUM_THICKNESS, SELECTED or user-defined value), can be undefined (is not set, MINIMUM_THICKNESS as default)
property_node_reference_surface_no Number Reference surface No., can be undefined (is not set, 1 as default)

# concreteDesignUltimateConfigurationEN.SetPunching_AxialForceDefinition(property_node_axial_force)

Sets Axial Force Definition

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_node_axial_force String/Number Axial force (DETERMINE or user-value magnitude), can be undefined (is not set, DETERMINE as default)

# concreteDesignUltimateConfigurationEN.SetPunching_RequiredPunchingReinforcement_PunchingShareCapacity(reinforcement_type)

Sets Required Punching Reinforcement - Punching Shear Capacity

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
reinforcement_type String Required Punching Reinforcement - Punching Shear Capacity (REQUIRED, PROVIDED, CALCULATED), can be undefined (is not set, CALCULATED as default) - Use required longitudinal reinforcement (REQUIRED) - Use provided longitudinal reinforcement (PROVIDED) - Calculate required longitudinal reinforcement to avoid punching reinforcement or fulfill Eq. 6.52 (CALCULATED)

# concreteDesignUltimateConfigurationEN.SetPunching_MinimumReinforcement(property_node_minimum_punching_reinforcement)

Sets Minimum Reinforcement Acc. to Standard

Kind: instance method of ConcreteDesignUltimateConfigurationEN

Param Type Description
property_node_minimum_punching_reinforcement Boolean Minimum punching reinforcement acc. to 9.4.3(2), can be undefined (true as default)

# ConcreteDesignUltimateConfigurationSP

Kind: global class

# new ConcreteDesignUltimateConfigurationSP(no, surfaces_no, members_no, nodes_no, comment, params)

Creates Concrete design ultimate configuration (SP standard)

Param Type Description
no Number Ultimate configuration number, can be undefined
surfaces_no Array Assigned surfaces numbers, can be undefined
members_no Array Assigned members numbers, can be undefined
nodes_no Array Assigned nodes numbers, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# concreteDesignUltimateConfigurationSP.GetNo() ⇒

Kind: instance method of ConcreteDesignUltimateConfigurationSP
Returns: Ultimate Configuration index

# concreteDesignUltimateConfigurationSP.GetUltimateConfiguration() ⇒

Kind: instance method of ConcreteDesignUltimateConfigurationSP
Returns: Ultimate Configuration object

# concreteDesignUltimateConfigurationSP.SetName(name)

Sets Name

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
name String Ultimate configuration name, can be undefined

# concreteDesignUltimateConfigurationSP.SetMembers_ConsiderInternalForces(property_member_axial_forces, property_member_bending_moments_my, property_member_bending_moments_mz, property_member_torsional_moments, property_member_shear_forces_vy, property_member_shear_forces_vz)

Sets Consider internal forces for concrete design

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_member_axial_forces Boolean Axial forces, can be undefined (is not set, true as default)
property_member_bending_moments_my Boolean Bending moment in Y, can be undefined (is not set, true as default)
property_member_bending_moments_mz Boolean Bending moment in Z, can be undefined (is not set, true as default)
property_member_torsional_moments Boolean Torsional moments, can be undefined (is not set, true as default)
property_member_shear_forces_vy Boolean Shear forces in Y, can be undefined (is not set, true as default)
property_member_shear_forces_vz Boolean Shear forces in Z, can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationSP.SetMembers_FactorsOfConcreteServiceConditions(property_member_effect_of_loading_duration, property_member_placing_concrete_in_vertical_position, property_member_cellular_concretes_in_dependence_on_moisture_content, property_member_alternate_of_freezing_and_thawing)

Sets Factors of Concrete Service Conditions Acc. to 6.1.12

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_member_effect_of_loading_duration Boolean a) effect of loading duration
property_member_placing_concrete_in_vertical_position Boolean c) placing concrete in vertical position (depth of layer 1.5m)
property_member_cellular_concretes_in_dependence_on_moisture_content Boolean d) cellular concretes in dependence on moisture content
property_member_alternate_of_freezing_and_thawing Boolean e) alternate of freezing and thawing

# concreteDesignUltimateConfigurationSP.SetMembers_InternalForceReductionZ(property_member_reduction_of_the_shear_forces_in_the_support_face_and_distance, property_member_consideration_of_minimum_eccentricity)

Sets Reductions of Internal Forces in z-Direction

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_member_reduction_of_the_shear_forces_in_the_support_face_and_distance Boolean Reduction of the shear forces in the support face and distance ccrit, can be undefined (is not set, true as default)
property_member_consideration_of_minimum_eccentricity Boolean Consideration of minimum eccentricity acc. to 7.1.7, can be undefined (is not set, false as default)

# concreteDesignUltimateConfigurationSP.SetMembers_RequiredLongitudinalReinforcement(property_member_reinforcement_layout, property_member_reinforcement_diameter_for_preliminary_design)

Sets Required longitudinal reinforcement

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_member_reinforcement_layout String Reinforcement layout (TOP_BOTTOM_OPTIMIZED_DISTRIBUTION, TOP_BOTTOM_SYMMETRICAL_DISTRIBUTION, IN_CORNERS_SYMMETRICAL_DISTRIBUTION, UNIFORMLY_SURROUNDING, FACTORIZED_PROVIDED_REINFORCEMENT, OPTIMIZED_PROVIDED_REINFORCEMENT), can be undefined (is not set, OPTIMIZED_PROVIDED_REINFORCEMENT as default)
property_member_reinforcement_diameter_for_preliminary_design String/Number Reinforcement diameter for preliminary design (MAX_OF_ALL or user-defined value), can be undefined (is not set as default, otherwise MAX_OF_ALL as default)

# concreteDesignUltimateConfigurationSP.SetMembers_DesignSectionsTypesForShearAndTorsionDesignChecks(section_type)

Sets Types of Design Sections for Shear and Torsion Design Checks

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
section_type String Type of Design Sections for Shear and Torsion Design Checks, can be undefined (is not set, INCLINED_SECTION as default) - Inclined section acc. to Eq. 8.56 / Spatial section acc. to Eq. 8.67 (INCLINED_SECTION) - Normal section acc. to Eq. 8.60 / Simplified criterium acc. to Eq. 8.75 (NORMAL_SECTION)

# concreteDesignUltimateConfigurationSP.SetMembers_RequiredReinforcementMomentInInclinedSection(property_member_designed_type_of_reinforcement, property_member_used_reinforcement_for_moment_resistance)

Sets Required Reinforcement - Moment in Inclined Section Acc. to 8.1.35

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_member_designed_type_of_reinforcement String Designed type of reinforcement (LONGITUDINAL, TRANSVERSE), can be undefined (is not set, LONGITUDINAL as default)
property_member_used_reinforcement_for_moment_resistance String Used reinforcement for moment resistance (REQUIRED, PROVIDED), can be undefined (is not set, REQUIRED as default)

# concreteDesignUltimateConfigurationSP.SetMembers_MinimumReinforcement(property_member_minimum_longitudinal_reinforcement, property_member_minimum_shear_reinforcement)

Sets Minimum Reinforcement Acc. to Standard

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_member_minimum_longitudinal_reinforcement Boolean Minimum longitudinal reinforcement acc. to standard, can be undefined (is not set, true as default)
property_member_minimum_shear_reinforcement Boolean Minimum shear reinforcement acc. to standard, can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationSP.SetMembers_NeutralAxisDepthLimitation(property_member_consider_neutral_axis_depth_limitation, property_member_value_of_neutral_axis_depth_limitation_user_value)

Sets Sets Depth Limitation of Neutral Axis

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_member_consider_neutral_axis_depth_limitation Boolean Consider depth limitation of neutral axis acc. to 8.1.5, 8.1.6, can be undefined (is not set, false as default)
property_member_value_of_neutral_axis_depth_limitation_user_value String/Number Value of neutral axis depth limitation (AUTOMATICALLY or user number value), can be undefined (is not set, AUTOMATICALLY / 0.800 as default)

# concreteDesignUltimateConfigurationSP.SetMembers_CalculationSetting(property_member_nett_concrete_area)

Sets Calculation setting

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_member_nett_concrete_area Boolean Net concrete area, can be undefined (true as default)

# concreteDesignUltimateConfigurationSP.SetStability_Slenderness(property_stability_limiting_slenderness_y, property_stability_limiting_slenderness_z)

Sets Slenderness

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_stability_limiting_slenderness_y String/Number Limiting slenderness about y-axis (DEFINED_AS_STANDARD or user-defined value), can be undefined (is not set, DEFINED_AS_STANDARD as default)
property_stability_limiting_slenderness_z String/Number Limiting slenderness about z-axis (DEFINED_AS_STANDARD or user-defined value), can be undefined (is not set, DEFINED_AS_STANDARD as default)

# concreteDesignUltimateConfigurationSP.SetStability_MembersWithRectangularSectionAndLowSlenderness(property_stability_limit_value_of_inner_normal_force)

Sets Members with Rectangular Section and Low Slenderness

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_stability_limit_value_of_inner_normal_force Boolean Limit value of inner normal force acc. to 8.1.16, can be undefined (true as default)

# concreteDesignUltimateConfigurationSP.SetStability_BiaxialBending(property_stability_separate_design_in_each_principal_direction, property_stability_use_simplified_criterion_for_biaxial_bending, property_stability_use_interaction_curves_method)

Sets Biaxial Bending

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_stability_separate_design_in_each_principal_direction Boolean Separate design in each principal direction, can be undefined (is not set, false as default)
property_stability_use_simplified_criterion_for_biaxial_bending Boolean Use simplified criterion for biaxial bending, can be undefined (is not set, false as default)
property_stability_use_interaction_curves_method Boolean Use interaction curve method, can be undefined (is not set, false as default)

# concreteDesignUltimateConfigurationSP.SetStability_LoadDirections(property_stability_vertical_load_horizontal_load_ratio_in_y_direction, property_stability_vertical_load_horizontal_load_ratio_in_z_direction)

Sets Load directions

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_stability_vertical_load_horizontal_load_ratio_in_y_direction Number Vertical load / horizontal load ratio in y-direction, can be undefined (is not set, 0.50 as default)
property_stability_vertical_load_horizontal_load_ratio_in_z_direction Number Vertical load / horizontal load ratio in z-direction, can be undefined (is not set, 0.50 as default)

# concreteDesignUltimateConfigurationSP.SetStability_LongTermLoadComponent(property_stability_ratio_long_term_total_load_in_y_direction, property_stability_ratio_long_term_total_load_in_z_direction)

Sets Long-term load component

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_stability_ratio_long_term_total_load_in_y_direction Number Ratio long-term / total load in y-direction, can be undefined (is not set, 0.50 as default)
property_stability_ratio_long_term_total_load_in_z_direction Number Ratio long-term / total load in z-direction, can be undefined (is not set, 0.50 as default)

# concreteDesignUltimateConfigurationSP.SetStability_RequiredReinforcement(property_stability_reinforcement_layout, reinforcement_diameter_for_preliminary_design_user_value)

Sets Required Reinforcement

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_stability_reinforcement_layout String Reinforcement layout (TOP_BOTTOM_SYMMETRICAL_DISTRIBUTION, IN_CORNERS_SYMMETRICAL_DISTRIBUTION, UNIFORMLY_SURROUNDING, FACTORIZED_PROVIDED_REINFORCEMENT), can be undefined (is not set, UNIFORMLY_SURROUNDING as default)
reinforcement_diameter_for_preliminary_design_user_value String/Number Reinforcement diameter for preliminary design (MAX_OF_ALL or user number value), can be undefined (is not set, MAX_OF_ALL as default)

# concreteDesignUltimateConfigurationSP.SetSurfaces_DesignMethod(optimization_type)

Sets Design method

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
optimization_type String Design method optimization type, can be undefined (is not set, YES as default) - No optimization of design internal forces (NO) - Optimization of design internal forces (YES)

# concreteDesignUltimateConfigurationSP.SetSurfaces_InternalForcesDiagramUsedForDesign(property_subtraction_of_rib_components)

Sets Internal Forces Diagram Used for Design

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_subtraction_of_rib_components Boolean Subtraction of rib components for the ULS calculation and for the analytic method of SLS calculation, can be undefined (true as default)

# concreteDesignUltimateConfigurationSP.SetSurfaces_MinimumLongitudinalReinforcement(property_minimum_longitudinal_reinforcement_acc_to_standard, reinforcement_type, min_reinforcement_direction, min_reinforcement_direction_user_values, main_compression_reinforcement_direction, property_surface_reinforcement_defined_direction_phi)

Sets Minimum longitudinal reinforcement acc. to standard

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_minimum_longitudinal_reinforcement_acc_to_standard Boolean Minimum longitudinal reinforcement acc. to standard, can be undefined (is not set, true as default)
reinforcement_type String Minimum longitudinal reinforcement acc. to standard type, can be undefined (is not set, PLATES as default) - Minimum longitudinal reinforcement for plates acc. to 10.3.5, 10.3.6 (PLATES) - Minimum longitudinal reinforcement for walls acc. to 10.3.5, 10.3.6 (WALLS)
min_reinforcement_direction String Direction of minimum reinforcement, can be undefined (is not set, MAIN_TENSION_ELEMENT as default) - Direction with main tension in the element (MAIN_TENSION_ELEMENT) - Direction with main tension in the surface (MAIN_TENSION_SURFACE) - Defined (DEFINED)
min_reinforcement_direction_user_values Array User-defined direction of minimum reinforcement ([φ1(-z), φ2(-z), φ1(+z), φ2(+z)]), can be undefined (if not set, all values are true by default)
main_compression_reinforcement_direction String Direction of main compression reinforcement, can be undefined (is not set, WITH_MAIN_COMPRESSION_FORCE as default) - Reinforcement direction with the main compression force (WITH_MAIN_COMPRESSION_FORCE) - Defined in reinforcement direction (DEFINED_IN_REINFORCEMENT_DIRECTION)
property_surface_reinforcement_defined_direction_phi String Reinforcement direction (PHI_1, PHI_2)

# concreteDesignUltimateConfigurationSP.SetSurfaces_UserDefinedMinimumLongitudinalReinforcementPercentage(property_user_defined_minimum_longitudinal_reinforcement_percentage, property_minimum_reinforcement, property_minimum_secondary_reinforcement, property_minimum_tension_reinforcement, property_minimum_compression_reinforcement)

Sets User-defined minimum longitudinal reinforcement percentage

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_user_defined_minimum_longitudinal_reinforcement_percentage Boolean User-defined minimum longitudinal reinforcement percentage, can be undefined (is not set, false as default)
property_minimum_reinforcement Number Minimum reinforcement, can be undefined (is not set, 0% as default)
property_minimum_secondary_reinforcement Number Minimum secondary reinforcement from main reinforcement direction, can be undefined (is not set, 20% as default)
property_minimum_tension_reinforcement Number Minimum tension reinforcement, can be undefined (is not set, 0% as default)
property_minimum_compression_reinforcement Number Minimum compression reinforcement, can be undefined (is not set, 0% as default)

# concreteDesignUltimateConfigurationSP.SetSurfaces_UserDefinedMaximumLongitudinalReinforcementPercentage(property_user_defined_maximum_longitudinal_reinforcement_percentage, property_user_defined_maximum_longitudinal_reinforcement_percentage_value)

Sets User-defined maximum longitudinal reinforcement percentage

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_user_defined_maximum_longitudinal_reinforcement_percentage Boolean User-defined maximum longitudinal reinforcement percentage, can be undefined (is not set, true as default)
property_user_defined_maximum_longitudinal_reinforcement_percentage_value Number Maximum reinforcement, can be undefined (is not set, 4% as default)

# concreteDesignUltimateConfigurationSP.SetSurfaces_MinimumShearReinforcement(property_minimum_shear_reinforcement)

Sets Minimum shear reinforcement acc. to 10.3.13

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_minimum_shear_reinforcement Boolean Minimum shear reinforcement, can be undefined (is not set, true as default)

# concreteDesignUltimateConfigurationSP.SetSurfaces_UserDefinedMinimumShearReinforcementPercentage(property_user_defined_minimum_shear_reinforcement_percentage, property_user_defined_minimum_shear_reinforcement_percentage_value)

Sets User-defined minimum shear reinforcement percentage

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_user_defined_minimum_shear_reinforcement_percentage Boolean Minimum shear reinforcement percentage, can be undefined (is not set, false as default)
property_user_defined_minimum_shear_reinforcement_percentage_value Number Minimum reinforcement, can be undefined, (is not set, 0% as default)

# concreteDesignUltimateConfigurationSP.SetSurfaces_NeutralAxisDepthLimitation(property_member_consider_neutral_axis_depth_limitation, property_member_value_of_neutral_axis_depth_limitation_user_value)

Sets Neutral Axis Depth Limitation

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_member_consider_neutral_axis_depth_limitation Boolean Consider depth limitation of neutral axis acc. to 8.1.5, 8.1.6, can be undefined (is not set, false as default)
property_member_value_of_neutral_axis_depth_limitation_user_value String/Number Value of neutral axis depth limitation (AUTOMATICALLY or user number value), can be undefined (is not set, AUTOMATICALLY as default)

# concreteDesignUltimateConfigurationSP.SetPunching_PunchingLoad(property_node_used_punching_load_for_columns, property_node_direction_of_punching_force_for_columns, property_node_used_punching_load_for_walls, property_node_direction_of_punching_force_for_walls, property_node_distance_to_perimeter_used_for_integration_for_columns, property_node_distance_to_perimeter_used_for_integration_for_walls)

Sets Punching Load

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_node_used_punching_load_for_columns String/Number Used punching load for columns (SINGLE_FORCE, SMOOTHED_SHEAR_FORCE or user-defined value), can be undefined (is not set, SINGLE_FORCE as default)
property_node_direction_of_punching_force_for_columns String Direction of punching force (DETERMINE, PLUS_Z, MINUS_Z), can be undefined (is not set, DETERMINE as default)
property_node_used_punching_load_for_walls String/Number Used punching load for walls (SMOOTHED_SHEAR_FORCE or user defined value), can be undefined (is not set, SMOOTHED_SHEAR_FORCE as default)
property_node_direction_of_punching_force_for_walls String Direction of punching force (DETERMINE, PLUS_Z, MINUS_Z), can be undefined (is not set, DETERMINE as default)
property_node_distance_to_perimeter_used_for_integration_for_columns Number Distance to perimeter used for integration (k * d), can be undefined (is not set, 2.0 as default)
property_node_distance_to_perimeter_used_for_integration_for_walls Number Distance to perimeter used for integration (k * d), can be undefined (is not set, 2.0 as default)

# concreteDesignUltimateConfigurationSP.SetPunching_AdditionalParameters_Perimeter(property_node_define_perimeter, property_node_distance, property_node_define_iterative_critical_section_for_foundation, property_node_distance_of_iterative_critical_section_for_foundation_to_loaded_area, property_node_define_sections_for_analysis_of_punching_shear_reinforcement, property_node_number_of_inner_control_perimeters, property_node_define_distance_to_loaded_area, property_node_first_distance, property_node_radial_spacing, property_node_define_outer_control_perimeter, property_node_distance_of_outer_control_perimeter_to_loaded_area)

Sets Additional Parameters - Perimeter

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_node_define_perimeter Boolean Perimeter defined, can be undefined (is not set, false as default)
property_node_distance Number Distance, can be undefined (is not set, 0.29 as default)
property_node_define_iterative_critical_section_for_foundation Boolean Define iterative critical section for foundation, can be undefined (is not set, false as default)
property_node_distance_of_iterative_critical_section_for_foundation_to_loaded_area Number Distance to load area, can be undefined (is not set, 0.29 as default)
property_node_define_sections_for_analysis_of_punching_shear_reinforcement Boolean Define sections for analysis of punching shear reinforcement, can be undefined (is not set, false as default)
property_node_number_of_inner_control_perimeters Number Number, can be undefined (is not set, 2 as default)
property_node_define_distance_to_loaded_area Boolean Distance to load area, can be undefined (is not set, false as default)
property_node_first_distance Number 1st distance, can be undefined (is not set, 0.3 as default)
property_node_radial_spacing Number Radial spacing, can be undefined (is not set, 0.2 as default)
property_node_define_outer_control_perimeter Boolean Define outer control perimeter, can be undefined (is not set, false as default)
property_node_distance_of_outer_control_perimeter_to_loaded_area Number Distance to load area, can be undefined (2 as default)

# concreteDesignUltimateConfigurationSP.SetPunching_AdditionalParameters_Thickness(property_node_variable_thickness_definition, property_node_reference_surfaces_thickness, property_node_reference_surface_no)

Sets Additional Parameters - Thickness

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_node_variable_thickness_definition String/Number Definition of variable thickness (AUTO or user-defined value), can be undefined (is not set, AUTO as default)
property_node_reference_surfaces_thickness String/Number Thickness of reference surfaces (MINIMUM_THICKNESS, MAXIMUM_THICKNESS, SELECTED or user-defined value), can be undefined (is not set, MINIMUM_THICKNESS as default)
property_node_reference_surface_no Number Reference surface No., can be undefined (is not set, 1 as default)

# concreteDesignUltimateConfigurationSP.SetPunching_NeutralAxisDepthLimitation(property_node_consider_neutral_axis_depth_limitation, property_node_value_of_neutral_axis_depth_limitation)

Sets Neutral Axis Depth Limitation

Kind: instance method of ConcreteDesignUltimateConfigurationSP

Param Type Description
property_node_consider_neutral_axis_depth_limitation Boolean Consider depth limitation of neutral axis acc. to 8.1.5, 8.1.6, can be undefined (is not set, false as default)
property_node_value_of_neutral_axis_depth_limitation String/Number Value of neutral axis depth limitation (AUTOMATICALLY or user-defined value), can be undefined (is not set, AUTOMATICALLY/0.8 as default)

# Functions

SteelDesignFireResistanceConfiguration(no, members_no, member_sets_no, comment, params)

Creates Steel Design Fire resistance Configuration

SteelDesignServiceabilityConfiguration(no, members_no, member_sets_no, comment, params)

Creates Steel Design Serviceability Configuration

SteelDesignStrengthConfigurationAISC(no, members_no, member_sets_no, comment, params)

Creates Steel Design Strength Configuration for AISC code of standard

SteelDesignUltimateConfigurationAS(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for AS code of standard

SteelDesignUltimateConfigurationBS(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for BS code of standard

SteelDesignUltimateConfigurationCSA(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for CSA code of standard

SteelDesignUltimateConfigurationEC3(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for EN code of standard

SteelDesignUltimateConfigurationGB(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for GB code of standard

SteelDesignUltimateConfigurationIS(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for IS code of standard

SteelDesignUltimateConfigurationNBR(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for NBR code of standard

SteelDesignUltimateConfigurationNTC(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for NTC code of standard

SteelDesignUltimateConfigurationSIA(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for SIA code of standard

SteelDesignUltimateConfigurationSP(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration

# SteelDesignFireResistanceConfiguration(no, members_no, member_sets_no, comment, params)

Creates Steel Design Fire resistance Configuration

Kind: global function

Param Type Description
no Number Fire resistance Configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignFireResistanceConfiguration.GetNo() ⇒

Kind: instance method of SteelDesignFireResistanceConfiguration
Returns: Fire resistance Configuration index

# steelDesignFireResistanceConfiguration.GetFireResistanceConfiguration() ⇒

Kind: instance method of SteelDesignFireResistanceConfiguration
Returns: Fire resistance Configuration object

# steelDesignFireResistanceConfiguration.SetName(name)

Sets Name

Kind: instance method of SteelDesignFireResistanceConfiguration

Param Type Description
name String Fire resistance Configuration name, can be undefined

# steelDesignFireResistanceConfiguration.SetFinalTemperature(property_define_final_temperature)

Defines final temperature

Kind: instance method of SteelDesignFireResistanceConfiguration

Param Type Description
property_define_final_temperature String Final temperature (MANUALLY, ANALYTICALLY), can be undefined (is not set, ANALYTICALLY as default)

# steelDesignFireResistanceConfiguration.SetAnalyticallyDesignSettings(property_required_time_of_fire_resistance, property_time_interval_of_analysis, property_fire_exposure, property_fire_exposure_3_sides_covered_width_calculated, property_fire_exposure_3_sides_covered_width_user_defined, property_fire_exposure_3_sides_covered_width_user_defined_value)

Sets Fire design settings (Analytically final temperature must be set)

Kind: instance method of SteelDesignFireResistanceConfiguration

Param Type Description
property_required_time_of_fire_resistance Number Required time of fire resistance, can be undefined (is not set, 15 min. by default)
property_time_interval_of_analysis Number Time interval of analysis, can be undefined (is not set, 5.000 s. by default)
property_fire_exposure String Fire exposure (3_SIDES, ALL_SIDES), can be undefined (is not set, ALL_SIDES by default)
property_fire_exposure_3_sides_covered_width_calculated Boolean Assume total width of section as covered, can be undefined (is not set, true as default)
property_fire_exposure_3_sides_covered_width_user_defined Boolean Assume user-defined width of section as covered, can be undefined (is not set, false as default)
property_fire_exposure_3_sides_covered_width_user_defined_value Number User-defined width, can be undefined (is not set, 0 s. as default)

# steelDesignFireResistanceConfiguration.SetAnalyticallyFireProtection(property_protection_type, property_unit_mass, property_thermal_conductivity, property_specific_heat, property_thickness)

Sets Fire protection (Analytically final temperature must be set)

Kind: instance method of SteelDesignFireResistanceConfiguration

Param Type Description
property_protection_type String Protection type (CONTOUR, HOLLOW), can be undefined (is not set, CONTOUR as default)
property_unit_mass Number Unit mass, can be undefined (is not set, 300.00 as default)
property_thermal_conductivity Number Thermal conductivity, can be undefined (is not set, 0.120 as default)
property_specific_heat Number Specific heat, can be undefined (is not set, 1200.0 as default)
property_thickness Number Thickness, can be undefined (is not set, 10.0 as default)

# steelDesignFireResistanceConfiguration.SetAnalyticallyTemperatureCurve(property_standard_temperature_time_curve, property_external_fire_curve, property_hydrocarbon_curve, property_coefficient_of_heat_transfer_by_convention)

Temperature curve for determination of temperature of gases (Analytically final temperature must be set)

Kind: instance method of SteelDesignFireResistanceConfiguration

Param Type Description
property_standard_temperature_time_curve Boolean Standard temperature-time curve, can be undefined (is not set, true as default)
property_external_fire_curve Boolean External fire curve, can be undefined (is not set, false as default)
property_hydrocarbon_curve Boolean Hydrocarbon curve, can be undefined (is not set, false as default)
property_coefficient_of_heat_transfer_by_convention Number Coefficient of heat transfer by convection, can be undefined (is not set, 25 as default)

# steelDesignFireResistanceConfiguration.SetAnalyticallyThermalActions(property_configuration_factor, property_surface_emissivity_of_carbon_steel_member, property_surface_emissivity_of_stainless_steel_member, property_emissivity_of_fire, property_temperature_limit_of_galvanization_effect, property_surface_emissivity_of_carbon_steel_member_with_temperature_below_limit)

Sets Thermal actions for temperature analysis (Analytically final temperature must be set)

Kind: instance method of SteelDesignFireResistanceConfiguration

Param Type Description
property_configuration_factor Number Configuration factor, can be undefined (is not set, 1.000 as default)
property_surface_emissivity_of_carbon_steel_member Number Surface emissivity of carbon steel member, can be undefined (is not set, 0.700 as default)
property_surface_emissivity_of_stainless_steel_member Number Surface emissivity of stainless steel member, can be undefined (is not set, 0.400 as default)
property_emissivity_of_fire Number Emissivity of fire, can be undefined (is not set, 1.000 as default)
property_temperature_limit_of_galvanization_effect Number Galvanized surface of carbon steel member, Temperature limit of galvanization effect, can be undefined (is not set, 500 as default)
property_surface_emissivity_of_carbon_steel_member_with_temperature_below_limit Number Galvanized surface of carbon steel member, Surface emissivity of carbon steel member with temperature below, can be undefined (is not set, 0.350 as default)

# steelDesignFireResistanceConfiguration.SetManuallyFinalTemperature(property_material_final_temperature, property_fire_exposure, property_member_with_fire_protection)

Sets Manually final temperature

Kind: instance method of SteelDesignFireResistanceConfiguration

Param Type Description
property_material_final_temperature Number Material final temperature, can be undefined (is not set, 300 as default)
property_fire_exposure String Fire exposure (3_SIDES, ALL_SIDES), can be undefined (is not set, ALL_SIDES as default)
property_member_with_fire_protection Boolean Member with fire protection, can be undefined (is not set, false as default)

# SteelDesignServiceabilityConfiguration(no, members_no, member_sets_no, comment, params)

Creates Steel Design Serviceability Configuration

Kind: global function

Param Type Description
no Number Serviceability configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignServiceabilityConfiguration.GetNo() ⇒

Kind: instance method of SteelDesignServiceabilityConfiguration
Returns: Serviceability configuration index

# steelDesignServiceabilityConfiguration.GetServiceabilityConfiguration() ⇒

Kind: instance method of SteelDesignServiceabilityConfiguration
Returns: Serviceability configuration object

# steelDesignServiceabilityConfiguration.SetName(name)

Sets Name

Kind: instance method of SteelDesignServiceabilityConfiguration

Param Type Description
name String Serviceability configuration name, can be undefined

# steelDesignServiceabilityConfiguration.SetDesignParametersEC3(property_sl_beam_limit_characteristic, property_sl_beam_limit_frequent, property_sl_beam_limit_quasi_permanent, property_sl_cantilever_limit_characteristic, property_sl_cantilever_limit_frequent, property_sl_cantilever_limit_quasi_permanent, property_vibration_design, property_lowb_design_of_steel_structure, property_lowb_road_bridge, property_lowb_railway_bridge)

Sets Design parameters

Kind: instance method of SteelDesignServiceabilityConfiguration

Param Type Description
property_sl_beam_limit_characteristic Number Beam limits - action combination, characteristic, can be undefined (is not set, 300 as default)
property_sl_beam_limit_frequent Number Beam limits - action combination, frequent, can be undefined (is not set, 200 as default)
property_sl_beam_limit_quasi_permanent Number Beam limits - action combination, quasi-permanent, can be undefined (is not set, 200 as default)
property_sl_cantilever_limit_characteristic Number Cantilever limits - action combination, characteristic, can be undefined (is not set, 150 as default)
property_sl_cantilever_limit_frequent Number Cantilever limits - action combination, frequent, can be undefined (is not set, 100 as default)
property_sl_cantilever_limit_quasi_permanent Number Cantilever limits - action combination, quasi-permanent, can be undefined (is not set, 100 as default)
property_vibration_design Number Vibration design, can be undefined (is not set, 5 mm as default)
property_lowb_design_of_steel_structure Boolean Limitation of web breathing, Design as steel bridge structure acc. to EN 1993-2, 7.4, can be undefined (is not set, false as default)
property_lowb_road_bridge Boolean Limitation of web breathing, Road bridge, can be undefined (is not set, true as default)
property_lowb_railway_bridge Boolean Limitation of web breathing, Railway bridge, can be undefined (is not set, false as default)

# steelDesignServiceabilityConfiguration.SetDesignParametersAISC(property_sl_beam_limit, property_sl_cantilever_limit)

Sets Design parameters

Kind: instance method of SteelDesignServiceabilityConfiguration

Param Type Description
property_sl_beam_limit Number Beam limits, can be undefined (is not set, 360 as default)
property_sl_cantilever_limit Number Cantilever limits, can be undefined (is not set, 180 as default)

# steelDesignServiceabilityConfiguration.SetDesignParametersIS(property_sl_beam_limit, property_sl_cantilever_limit)

Sets Design parameters

Kind: instance method of SteelDesignServiceabilityConfiguration

Param Type Description
property_sl_beam_limit Number Beam limits, can be undefined (is not set, 360 as default)
property_sl_cantilever_limit Number Cantilever limits, can be undefined (is not set, 180 as default)

# steelDesignServiceabilityConfiguration.SetDesignParametersBS(property_sl_beam_limit_value, property_sl_cantilever_limit_value, property_vibration_design)

Sets Design parameters

Kind: instance method of SteelDesignServiceabilityConfiguration

Param Type Description
property_sl_beam_limit_value Number Beam limits, can be undefined (is not set, 360 as default)
property_sl_cantilever_limit_value Number Cantilever limits, can be undefined (is not set, 180 as default)
property_vibration_design Number Vibration design, can be undefined (is not set, 5 mm as default)

# steelDesignServiceabilityConfiguration.SetDesignParametersGB(property_sl_beam_limit_characteristic_permanent_and_variable, property_sl_beam_limit_characteristic_variable, property_sl_cantilever_limit_characteristic_permanent_and_variable, property_sl_cantilever_limit_characteristic_variable)

Sets Design parameters

Kind: instance method of SteelDesignServiceabilityConfiguration

Param Type Description
property_sl_beam_limit_characteristic_permanent_and_variable Number Beam limits acc. to GB 50017, Annex B, permanent and variable, can be undefined (is not set, 1000 as default)
property_sl_beam_limit_characteristic_variable Number Beam limits acc. to GB 50017, Annex B, variable, can be undefined (is not set, 1000 as default)
property_sl_cantilever_limit_characteristic_permanent_and_variable Number Cantilever limits acc. to GB 50017, Annex B, permanent and variable, can be undefined (is not set, 500 as default)
property_sl_cantilever_limit_characteristic_variable Number Cantilever limits acc. to GB 50017, Annex B, variable, can be undefined (is not set, 500 as default)

# steelDesignServiceabilityConfiguration.SetDesignParametersCSA(property_sl_beam_limit, property_sl_cantilever_limit)

Sets Design parameters

Kind: instance method of SteelDesignServiceabilityConfiguration

Param Type Description
property_sl_beam_limit Number Beam limits, can be undefined (is not set, 360 as default)
property_sl_cantilever_limit Number Cantilever limits, can be undefined (is not set, 180 as default)

# steelDesignServiceabilityConfiguration.SetDesignParametersAS(property_sl_beam_limit_short_term_effects, property_sl_beam_limit_long_term_effects, property_sl_cantilever_limit_short_term_effects, property_sl_cantilever_limit_long_term_effects)

Sets Design parameters

Kind: instance method of SteelDesignServiceabilityConfiguration

Param Type Description
property_sl_beam_limit_short_term_effects Number Beam limits, short-term effects, can be undefined (is not set, 500 as default)
property_sl_beam_limit_long_term_effects Number Beam limits, long-term effects, can be undefined (is not set, 250 as default)
property_sl_cantilever_limit_short_term_effects Number Cantilever limits, short-term effects, can be undefined (is not set, 250 as default)
property_sl_cantilever_limit_long_term_effects Number Cantilever effects, long-term effects, can be undefined (is not set, 125 as default)

# steelDesignServiceabilityConfiguration.SetDesignParametersSP(property_sl_beam_limit, property_sl_cantilever_limit)

Sets Design parameters

Kind: instance method of SteelDesignServiceabilityConfiguration

Param Type Description
property_sl_beam_limit Number Beam limits, can be undefined (is not set, 360 as default)
property_sl_cantilever_limit Number Cantilever limits, can be undefined (is not set, 180 as default)

# SteelDesignStrengthConfigurationAISC(no, members_no, member_sets_no, comment, params)

Creates Steel Design Strength Configuration for AISC code of standard

Kind: global function

Param Type Description
no Number Strength Configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignStrengthConfigurationAISC.GetNo() ⇒

Kind: instance method of SteelDesignStrengthConfigurationAISC
Returns: Strength Configuration index

# steelDesignStrengthConfigurationAISC.GetUltimateConfiguration() ⇒

Kind: instance method of SteelDesignStrengthConfigurationAISC
Returns: Strength Configuration object

# steelDesignStrengthConfigurationAISC.SetName(name)

Sets Name

Kind: instance method of SteelDesignStrengthConfigurationAISC

Param Type Description
name String Fire resistance Configuration name, can be undefined

# steelDesignStrengthConfigurationAISC.SetGeneral(property_perform_stability_analysis)

Sets general design parameters

Kind: instance method of SteelDesignStrengthConfigurationAISC

Param Type Description
property_perform_stability_analysis Boolean Perform stability design, can be undefined (true as default)

# steelDesignStrengthConfigurationAISC.SetLimitValues(property_limit_values_tension, property_limit_values_compression, property_limit_values_shear_y, property_limit_values_shear_z, property_limit_values_torsion, property_limit_values_bending_about_major_axis_y, property_limit_values_bending_about_minor_axis_z)

Sets limit values for special cases design parameters

Kind: instance method of SteelDesignStrengthConfigurationAISC

Param Type Description
property_limit_values_tension Number Tension, can be undefined (is not set, 0.001 as default)
property_limit_values_compression Number Compression, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_y Number Shear Y, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_z Number Shear Z, can be undefined (is not set, 0.001 as default)
property_limit_values_torsion Number Shear stress due to torsion, can be undefined (is not set, 0.010 as default)
property_limit_values_bending_about_major_axis_y Number Bending about major axis Y, can be undefined (is not set, 0.001 as default)
property_limit_values_bending_about_minor_axis_z Number Bending about minor axis Z, can be undefined (is not set, 0.001 as default)

# steelDesignStrengthConfigurationAISC.SetLocalBuckling(property_check_width_thickness_ratio_of_elements_not_defined_in_tab_b4_1b, property_unstiffened_elements, property_stiffened_elements)

Sets local buckling

Kind: instance method of SteelDesignStrengthConfigurationAISC

Param Type Description
property_check_width_thickness_ratio_of_elements_not_defined_in_tab_b4_1b Boolean Check of the width-to-thickness ratio of elements not defined in Tab. B4.1b, can be undefined (is not set, false as default)
property_unstiffened_elements Number Unstiffened elements, can be undefined (is not set, 12.500)
property_stiffened_elements Number Stiffened elements, can be undefined (is not set, 42.000 as default)

# steelDesignStrengthConfigurationAISC.SetPositionOfPositiveTransverse(property_load_acts_vp_downwards_on_top_flange, property_load_acts_vp_at_shear_point, property_load_acts_vp_at_center_point, property_load_acts_vp_downwards_on_bottom_flange)

Sets position of positive transverse load application (only one option can be set)

Kind: instance method of SteelDesignStrengthConfigurationAISC

Param Type Description
property_load_acts_vp_downwards_on_top_flange Boolean On profile edge (destabilizing effect), can be undefined (is not set, true as default)
property_load_acts_vp_at_shear_point Boolean At shear point, can be undefined (is not set, false as default)
property_load_acts_vp_at_center_point Boolean At center point, can be undefined (is not set, false as default)
property_load_acts_vp_downwards_on_bottom_flange Boolean On profile edge (stabilizing effect)

# SteelDesignUltimateConfigurationAS(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for AS code of standard

Kind: global function

Param Type Description
no Number Ultimate Configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignUltimateConfigurationAS.GetNo() ⇒

Kind: instance method of SteelDesignUltimateConfigurationAS
Returns: Ultimate Configuration index

# steelDesignUltimateConfigurationAS.GetUltimateConfiguration() ⇒

Kind: instance method of SteelDesignUltimateConfigurationAS
Returns: Ultimate Configuration object

# steelDesignUltimateConfigurationAS.SetName(name)

Sets Name

Kind: instance method of SteelDesignUltimateConfigurationAS

Param Type Description
name String Fire resistance Configuration name, can be undefined

# steelDesignUltimateConfigurationAS.SetGeneral(property_perform_stability_analysis)

Sets general design parameters

Kind: instance method of SteelDesignUltimateConfigurationAS

Param Type Description
property_perform_stability_analysis Boolean Perform stability design, can be undefined (true as default)

# steelDesignUltimateConfigurationAS.SetLimitValues(property_limit_values_tension, property_limit_values_compression, property_limit_values_shear_y, property_limit_values_shear_z, property_limit_values_torsion, property_limit_values_bending_about_major_axis_y, property_limit_values_bending_about_minor_axis_z)

Sets limit values for special cases design parameters

Kind: instance method of SteelDesignUltimateConfigurationAS

Param Type Description
property_limit_values_tension Number Tension, can be undefined (is not set, 0.001 as default)
property_limit_values_compression Number Compression, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_y Number Shear Y, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_z Number Shear Z, can be undefined (is not set, 0.001 as default)
property_limit_values_torsion Number Shear stress due to torsion, can be undefined (is not set, 0.010 as default)
property_limit_values_bending_about_major_axis_y Number Bending about major axis Y, can be undefined (is not set, 0.001 as default)
property_limit_values_bending_about_minor_axis_z Number Bending about minor axis Z, can be undefined (is not set, 0.001 as default)

# steelDesignUltimateConfigurationAS.SetOptions(property_options_plastic_design_acc_to_45_and_843, property_options_use_proportioning_method, property_options_use_alternative_calculation)

Sets Options

Kind: instance method of SteelDesignUltimateConfigurationAS

Param Type Description
property_options_plastic_design_acc_to_45_and_843 Boolean Plastic design acc. to 4.5 and 8.4.3, can be undefined (is not set, false as default)
property_options_use_proportioning_method Boolean Use proportioning method acc. to 5.12.2, can be undefined (is not set, false as default)
property_options_use_alternative_calculation Boolean Use alternative calculation acc. to 8.3 and 8.4, can be undefined (is not set, false as default)

# steelDesignUltimateConfigurationAS.SetSectionManufacture(property_residual_stresses_user_defined, property_residual_stresses_type)

Sets Section manufacture

Kind: instance method of SteelDesignUltimateConfigurationAS

Param Type Description
property_residual_stresses_user_defined Boolean User-defined residual stresses to calculate slenderness limits acc. to tab. 5.2 or tab. 6.2.4, can be undefined (is not set, false as default)
property_residual_stresses_type String Residual stress (SR - stress relieved, HR - hot-rolled or hot -finished, CF - cold-formed, LW - lightly welded longitudinally, HW - heavily welded longitudinally), can be undefined (is not set, Sr as default)

# steelDesignUltimateConfigurationAS.SetPositionOfPositiveTransverse(property_vertical_position_downwards_on_top_flange, property_vertical_position_at_shear_point, property_vertical_position_at_center_point, property_vertical_position_downwards_on_bottom_flange)

Sets position of positive transverse load application (only one option can be set)

Kind: instance method of SteelDesignUltimateConfigurationAS

Param Type Description
property_vertical_position_downwards_on_top_flange Boolean On profile edge (destabilizing effect), can be undefined (is not set, true as default)
property_vertical_position_at_shear_point Boolean At shear point, can be undefined (is not set, false as default)
property_vertical_position_at_center_point Boolean At center point, can be undefined (is not set, false as default)
property_vertical_position_downwards_on_bottom_flange Boolean On profile edge (stabilizing effect)

# steelDesignUltimateConfigurationAS.SetFabricationOfWeldedSections(property_welded_sections_rolled_flange, property_welded_sections_flame_cut_flange)

Sets Fabrication of welded sections acc. to tab. 6.3.3 (only one option can be set)

Kind: instance method of SteelDesignUltimateConfigurationAS

Param Type Description
property_welded_sections_rolled_flange Boolean Rolled flange edges, can be undefined (is not set, true as default)
property_welded_sections_flame_cut_flange Boolean Flame-cut flange edges, can be undefined (is not set, false as default)

# SteelDesignUltimateConfigurationBS(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for BS code of standard

Kind: global function

Param Type Description
no Number Ultimate Configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignUltimateConfigurationBS.GetNo() ⇒

Kind: instance method of SteelDesignUltimateConfigurationBS
Returns: Ultimate Configuration index

# steelDesignUltimateConfigurationBS.GetUltimateConfiguration() ⇒

Kind: instance method of SteelDesignUltimateConfigurationBS
Returns: Ultimate Configuration object

# steelDesignUltimateConfigurationBS.SetName(name)

Sets Name

Kind: instance method of SteelDesignUltimateConfigurationBS

Param Type Description
name String Fire resistance Configuration name, can be undefined

# steelDesignUltimateConfigurationBS.SetGeneral(property_perform_stability_analysis)

Sets general design parameters

Kind: instance method of SteelDesignUltimateConfigurationBS

Param Type Description
property_perform_stability_analysis Boolean Perform stability design, can be undefined (true as default)

# steelDesignUltimateConfigurationBS.SetLimitValues(property_limit_values_tension, property_limit_values_compression, property_limit_values_shear_y, property_limit_values_shear_z, property_limit_values_torsion_shear_stress, property_limit_values_bending_about_major_axis_y, property_limit_values_bending_about_minor_axis_z)

Sets Limit values for special cases design parameters

Kind: instance method of SteelDesignUltimateConfigurationBS

Param Type Description
property_limit_values_tension Number Tension, can be undefined (is not set, 0.001 as default)
property_limit_values_compression Number Compression, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_y Number Shear Y, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_z Number Shear Z, can be undefined (is not set, 0.001 as default)
property_limit_values_torsion_shear_stress Number Shear stress due to torsion, can be undefined (is not set, 0.010 as default)
property_limit_values_bending_about_major_axis_y Number Bending about major axis Y, can be undefined (is not set, 0.001 as default)
property_limit_values_bending_about_minor_axis_z Number Bending about minor axis Z, can be undefined (is not set, 0.001 as default)

# steelDesignUltimateConfigurationBS.SetOptions(property_options_forced_semi_compact_design, property_options_more_exact_method_for_shear_buckling)

Sets Options

Kind: instance method of SteelDesignUltimateConfigurationBS

Param Type Description
property_options_forced_semi_compact_design Boolean Forced semi-compact design, can be undefined (is not set, false as default)
property_options_more_exact_method_for_shear_buckling Boolean More exact method for shear buckling resistance, can be undefined (is not set, false as default)

# steelDesignUltimateConfigurationBS.SetPositionOfPositiveTransverse(property_load_acts_vp_downwards_on_top_flange, property_load_acts_vp_at_shear_point, property_load_acts_vp_at_center_point, property_load_acts_vp_downwards_on_bottom_flange)

Sets position of positive transverse load application (only one option can be set)

Kind: instance method of SteelDesignUltimateConfigurationBS

Param Type Description
property_load_acts_vp_downwards_on_top_flange Boolean On profile edge (destabilizing effect), can be undefined (is not set, true as default)
property_load_acts_vp_at_shear_point Boolean At shear point, can be undefined (is not set, false as default)
property_load_acts_vp_at_center_point Boolean At center point, can be undefined (is not set, false as default)
property_load_acts_vp_downwards_on_bottom_flange Boolean On profile edge (stabilizing effect)

# steelDesignUltimateConfigurationBS.SetEquivalentUniformMomentFactors(property_moment_factors_lateral_torsional_buckling_calculated, property_moment_factors_lateral_torsional_buckling_user_defined, property_moment_factors_lateral_torsional_buckling_user_defined_value, property_moment_factors_flexural_buckling_major_calculated, property_moment_factors_flexural_buckling_major_user_defined, property_moment_factors_flexural_buckling_major_user_defined_value, property_moment_factors_flexural_buckling_minor_calculated, property_moment_factors_flexural_buckling_minor_user_defined, property_moment_factors_flexural_buckling_minor_user_defined_value)

Sets Equivalent uniform moment factors

Kind: instance method of SteelDesignUltimateConfigurationBS

Param Type Description
property_moment_factors_lateral_torsional_buckling_calculated Boolean Factor mLT (acc. to equation from tab. 18), can be undefined (is not set, false as default), must be undefined if property_moment_factors_lateral_torsional_buckling_user_defined is defined
property_moment_factors_lateral_torsional_buckling_user_defined Boolean Factor mLT (user-defined), can be undefined (is not set, true as default), must be undefined if property_moment_factors_lateral_torsional_buckling_calculated is defined
property_moment_factors_lateral_torsional_buckling_user_defined_value Number User-defined factor mLT, can be undefined (is not set, 1.000 as default)
property_moment_factors_flexural_buckling_major_calculated Boolean Factor my (acc. to equation from tab. 26), can be undefined (is not set, false as default), must be undefined if property_moment_factors_flexural_buckling_major_user_defined is defined
property_moment_factors_flexural_buckling_major_user_defined Boolean Factor my (user-defined), can be undefined (is not set, true as default), must be undefined if property_moment_factors_flexural_buckling_major_calculated is defined
property_moment_factors_flexural_buckling_major_user_defined_value Number User-defined factor my, can be undefined (is not set, 1.000 as default)
property_moment_factors_flexural_buckling_minor_calculated Boolean Factor mz (acc. to equation from tab. 26), can be undefined (is not set, false as default), must be undefined if property_moment_factors_flexural_buckling_minor_user_defined is defined
property_moment_factors_flexural_buckling_minor_user_defined Boolean Factor mz (user-defined), can be undefined (is not set, true as default), must be undefined if property_moment_factors_flexural_buckling_minor_calculated is defined
property_moment_factors_flexural_buckling_minor_user_defined_value Number User-defined factor mz, can be undefined (is not set, 1.000 as default)

# SteelDesignUltimateConfigurationCSA(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for CSA code of standard

Kind: global function

Param Type Description
no Number Ultimate Configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignUltimateConfigurationCSA.GetNo() ⇒

Kind: instance method of SteelDesignUltimateConfigurationCSA
Returns: Ultimate Configuration index

# steelDesignUltimateConfigurationCSA.GetUltimateConfiguration() ⇒

Kind: instance method of SteelDesignUltimateConfigurationCSA
Returns: Ultimate Configuration object

# steelDesignUltimateConfigurationCSA.SetName(name)

Sets Name

Kind: instance method of SteelDesignUltimateConfigurationCSA

Param Type Description
name String Fire resistance Configuration name, can be undefined

# steelDesignUltimateConfigurationCSA.SetGeneral(property_perform_stability_analysis)

Sets general design parameters

Kind: instance method of SteelDesignUltimateConfigurationCSA

Param Type Description
property_perform_stability_analysis Boolean Perform stability design, can be undefined (true as default)

# steelDesignUltimateConfigurationCSA.SetLimitValues(property_limit_values_tension, property_limit_values_compression, property_limit_values_shear_y, property_limit_values_shear_z, property_limit_values_torsion, property_limit_values_bending_about_major_axis_y, property_limit_values_bending_about_minor_axis_z)

Sets limit values for special cases design parameters

Kind: instance method of SteelDesignUltimateConfigurationCSA

Param Type Description
property_limit_values_tension Number Tension, can be undefined (is not set, 0.001 as default)
property_limit_values_compression Number Compression, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_y Number Shear Y, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_z Number Shear Z, can be undefined (is not set, 0.001 as default)
property_limit_values_torsion Number Shear stress due to torsion, can be undefined (is not set, 0.010 as default)
property_limit_values_bending_about_major_axis_y Number Bending about major axis Y, can be undefined (is not set, 0.001 as default)
property_limit_values_bending_about_minor_axis_z Number Bending about minor axis Z, can be undefined (is not set, 0.001 as default)

# steelDesignUltimateConfigurationCSA.SetOptions(property_options_elastic_design, property_options_consider_n_equal_to_1_34, property_options_consider_n_equal_to_2_24, property_options_calculate_omega_1_according_to_13_8_6, property_options_set_omega_1_manually, property_options_omega_1_xu_user_defined_value, property_options_omega_1_yv_user_defined_value)

Sets Options

Kind: instance method of SteelDesignUltimateConfigurationCSA

Param Type Description
property_options_elastic_design Boolean Elastic design also for section class 1 or 2, can be undefined (is not set, false as default)
property_options_consider_n_equal_to_1_34 Boolean Parameter for compressive resistance acc. to 13.3.1, Consider n = 1.34, can be undefined (is not set, true as default)
property_options_consider_n_equal_to_2_24 Boolean Parameter for compressive resistance acc. to 13.3.1, Consider n = 2.24, can be undefined (is not set, true as default)
property_options_calculate_omega_1_according_to_13_8_6 Boolean Coefficient of uniform bending effect, automatically acc. to 13.8.6, can be undefined (is not set, true as default)
property_options_set_omega_1_manually Boolean Coefficient of uniform bending effect, user-defined value, can be undefined (is not set, false as default)
property_options_omega_1_xu_user_defined_value Number Value of omega1 in y-direction, can be undefined (is not set, 1.00 as default)
property_options_omega_1_yv_user_defined_value Number Value of omega1 in z-direction, can be undefined (is not set, 1.00 as default)

# steelDesignUltimateConfigurationCSA.SetStructureType(property_structure_type_unbraced_frame_y_direction, property_structure_type_unbraced_frame_z_direction)

Sets Structure type

Kind: instance method of SteelDesignUltimateConfigurationCSA

Param Type Description
property_structure_type_unbraced_frame_y_direction Boolean Unbraced frame in y-direction, can be undefined (is not set, false as default)
property_structure_type_unbraced_frame_z_direction Boolean Unbraced frame in z-direction, can be undefined (is not set, false as default)

# steelDesignUltimateConfigurationCSA.SetPositionOfPositiveTransverse(property_load_act_vp_downwards_on_top_flange, property_load_act_vp_at_shear_point, property_load_act_vp_at_center_point, property_load_act_vp_downwards_on_bottom_flange)

Sets position of positive transverse load application (only one option can be set)

Kind: instance method of SteelDesignUltimateConfigurationCSA

Param Type Description
property_load_act_vp_downwards_on_top_flange Boolean On profile edge (destabilizing effect), can be undefined (is not set, true as default)
property_load_act_vp_at_shear_point Boolean At shear point, can be undefined (is not set, false as default)
property_load_act_vp_at_center_point Boolean At center point, can be undefined (is not set, false as default)
property_load_act_vp_downwards_on_bottom_flange Boolean On profile edge (stabilizing effect)

# SteelDesignUltimateConfigurationEC3(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for EN code of standard

Kind: global function

Param Type Description
no Number Ultimate Configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignUltimateConfigurationEC3.GetNo() ⇒

Kind: instance method of SteelDesignUltimateConfigurationEC3
Returns: Ultimate Configuration index

# steelDesignUltimateConfigurationEC3.GetUltimateConfiguration() ⇒

Kind: instance method of SteelDesignUltimateConfigurationEC3
Returns: Ultimate Configuration object

# steelDesignUltimateConfigurationEC3.SetName(name)

Sets name

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
name String Ultimate Configuration name, can be undefined

# steelDesignUltimateConfigurationEC3.SetGeneral(property_perform_stability_analysis)

Sets general design parameters

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
property_perform_stability_analysis Boolean Perform stability design, can be undefined (true as default)

# steelDesignUltimateConfigurationEC3.SetLimitValues(property_limit_values_tension, property_limit_values_compression, property_limit_values_shear_y, property_limit_values_shear_z, property_limit_values_torsion, property_limit_values_bending_about_major_axis_y, property_limit_values_bending_about_minor_axis_z)

Sets limit values for special cases design parameters

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
property_limit_values_tension Number Tension, can be undefined (is not set, 0.001 as default)
property_limit_values_compression Number Compression, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_y Number Shear Y, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_z Number Shear Z, can be undefined (is not set, 0.001 as default)
property_limit_values_torsion Number Shear stress due to torsion, can be undefined (is not set, 0.010 as default)
property_limit_values_bending_about_major_axis_y Number Bending about major axis Y, can be undefined (is not set, 0.001 as default)
property_limit_values_bending_about_minor_axis_z Number Bending about minor axis Z, can be undefined (is not set, 0.001 as default)

# steelDesignUltimateConfigurationEC3.SetThinWalledAnalysis(property_thin_walled_analysis_maximum_number_of_iterations, property_thin_walled_analysis_maximum_difference_between_iterations, property_thin_walled_analysis_neglect_bending_moments_due_to_shift, property_thin_walled_analysis_consider_annex_e, property_thin_walled_analysis_increase_material_factor)

Sets thin-walled analysis design parameters

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
property_thin_walled_analysis_maximum_number_of_iterations Number Maximum number of iterations, can be undefined (is not set, 3 as default)
property_thin_walled_analysis_maximum_difference_between_iterations Number Maximum difference between iterations, can be undefined (is not set, 1.00% as default)
property_thin_walled_analysis_neglect_bending_moments_due_to_shift Boolean Neglect bending moments due to the shift of the centroid, can be undefined (is not set, false as default)
property_thin_walled_analysis_consider_annex_e Boolean Consider effective widths according to EN 1993-1-5, Annex E, can be undefined (is not set, false as default)
property_thin_walled_analysis_increase_material_factor Boolean For limit c/t of class 3, increase material factor epsilon acc. to 5.5.2(9), can be undefined (is not set, true as default), only when Perform stability design is on

# steelDesignUltimateConfigurationEC3.SetOptions(property_options_elastic_design, property_options_use_verification_for_elastic_design, property_options_use_linear_interaction)

Sets design parameters options

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
property_options_elastic_design Boolean Elastic design (also for class 1 and class 2 sections), can be undefined (is not set, false as default)
property_options_use_verification_for_elastic_design Boolean Use verification acc. to equation 6.1 for elastic design, can be undefined (is not set, false as default)
property_options_use_linear_interaction Boolean Use linear interaction acc. to 6.2.1(7) for section check for M+N, can be undefined (is not set, false as default)

# steelDesignUltimateConfigurationEC3.SetDesignOfColdFormedSection(property_design_of_cold_formed_sections_activate, property_forming_factor_k)

Sets design of cold-formed sections acc. to EN 1993-1-3

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
property_design_of_cold_formed_sections_activate Boolean Perform design of cold-formed sections, can be undefined (is not set, true as default)
property_forming_factor_k String Forming factor k acc. to 3.2.2(3) (ROLL_FORMING, OTHER_METHODS_OF_FORMING), can be undefined (is not set, ROLL_FORMING as default)

# steelDesignUltimateConfigurationEC3.SetDesignOfShearBuckling(property_design_of_shear_buckling_activate)

Sets design of share buckling Acc. to EN 1993-1-5

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
property_design_of_shear_buckling_activate Boolean Perform design of shear buckling, can be undefined (is not set, true as default)

# steelDesignUltimateConfigurationEC3.SetStabilityAnalyses(property_use_gamma_m1)

Sets stability analyses with second-order internal forces

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
property_use_gamma_m1 Boolean Use gama M1 for determination of the section resistance, can be undefined (is not set, false as default)

# steelDesignUltimateConfigurationEC3.SetCalculationMethod(property_structure_type_sway_yy, property_structure_type_sway_zz, property_gm_enable_also_for_non_i_sections, property_extensional_methods, property_interpolation_acc_to_eq_666, property_european_lateral_torsional_buckling_curves, property_adapted_method)

Sets calculation method (Perform stability design is on)

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
property_structure_type_sway_yy Boolean Sway y-y, can be undefined (is not set, false as default)
property_structure_type_sway_zz Boolean Sway z-z, can be undefined (is not set, false as default)
property_gm_enable_also_for_non_i_sections Boolean Enable also for non-l-sections, can be undefined (is not set, true as default)
property_extensional_methods Boolean Extension methods, can be undefined (is not set, false as default)
property_interpolation_acc_to_eq_666 Boolean Interpolation acc. to Eq. 6.66, Extension method must be on (in case european lateral-torsional buckling curve is defined must be undefined)
property_european_lateral_torsional_buckling_curves Boolean European lateral-torsional buckling curve, Extension method must be on (in case interpolation is defined must be undefined)
property_adapted_method Boolean Adapted method (enable double bending), European lateral-torsional buckling curve must be on, can be undefined (is not set, false as default)

# steelDesignUltimateConfigurationEC3.SetSecondOrderEffects(property_soe_major_y_axis, property_soe_major_y_axis_increasing_factor, property_soe_minor_z_axis, property_soe_minor_z_axis_increasing_factor)

Include second-order effects Acc. to 5.2.2(4) by increasing bending moment about

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
property_soe_major_y_axis Boolean Major x-axis, can be undefined (is not set, false as default)
property_soe_major_y_axis_increasing_factor Number Increasing factor for major x-axis, Major x-axis must be on, can be undefined (is not set, 1.150 as default)
property_soe_minor_z_axis String Major z-axis, can be undefined (is not set, false as default)
property_soe_minor_z_axis_increasing_factor Number Increasing factor for major z-axis, Major z-axis must be on, can be undefined (is not set, 1.150 as default)

# steelDesignUltimateConfigurationEC3.SetPositionOfPositiveTransverse(property_load_acts_vp_downwards_on_top_flange, property_load_acts_vp_at_shear_point, property_load_acts_vp_at_center_point, property_load_acts_vp_downwards_on_bottom_flange)

Sets position of positive transverse load application (only one option can be set)

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
property_load_acts_vp_downwards_on_top_flange Boolean On profile edge (destabilizing effect), can be undefined (is not set, true as default)
property_load_acts_vp_at_shear_point Boolean At shear point, can be undefined (is not set, false as default)
property_load_acts_vp_at_center_point Boolean At center point, can be undefined (is not set, false as default)
property_load_acts_vp_downwards_on_bottom_flange Boolean On profile edge (is not set, stabilizing effect)

# steelDesignUltimateConfigurationEC3.SetLateralTorsionalBuckling(property_determine_lateral_torsion_eq_6_56, property_determine_lateral_torsion_eq_6_56_or_6_57, property_determine_lateral_torsion_f_factor, property_perform_design_for_doubly_symmetric_hollow_sections)

Sets parameters for lateral-torsional buckling

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
property_determine_lateral_torsion_eq_6_56 Boolean Always according to Eq. 6.56 general case (conservative), can be undefined (is not set, false as default)
property_determine_lateral_torsion_eq_6_56_or_6_57 Boolean If possible, according to Eq. 6.57, otherwise according to Eq. 6.56, can be undefined (is not set, true as default)
property_determine_lateral_torsion_f_factor Boolean Use factor f for modification of chi L, T acc. to 6.3.2.3(2), can be undefined (is not set, true as default)
property_perform_design_for_doubly_symmetric_hollow_sections Boolean Perform design for non-circular doubly symmetric hollow sections, can be undefined (is not set, true as default)

# steelDesignUltimateConfigurationEC3.SetParameters(property_param_k_annex_a, property_param_k_annex_b)

Sets Parameters

Kind: instance method of SteelDesignUltimateConfigurationEC3

Param Type Description
property_param_k_annex_a Boolean Method 1 acc. to Annex A, can be undefined (is not set, false as default)
property_param_k_annex_b Boolean Method 2 acc. to Annex B, can be undefined (is not set, true as default)

# SteelDesignUltimateConfigurationGB(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for GB code of standard

Kind: global function

Param Type Description
no Number Ultimate Configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignUltimateConfigurationGB.GetNo() ⇒

Kind: instance method of SteelDesignUltimateConfigurationGB
Returns: Ultimate Configuration index

# steelDesignUltimateConfigurationGB.GetUltimateConfiguration() ⇒

Kind: instance method of SteelDesignUltimateConfigurationGB
Returns: Ultimate Configuration object

# steelDesignUltimateConfigurationGB.SetName(name)

Sets Name

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
name String Fire resistance Configuration name, can be undefined

# steelDesignUltimateConfigurationGB.SetGeneral(property_perform_stability_analysis)

Sets general design parameters

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_perform_stability_analysis Boolean Perform stability design, can be undefined (true as default)

# steelDesignUltimateConfigurationGB.SetLimitValues(property_limit_values_tension, property_limit_values_compression, property_limit_values_shear_y, property_limit_values_shear_z, property_limit_values_torsion, property_limit_values_bending_about_major_axis_y, property_limit_values_bending_about_minor_axis_z)

Sets limit values for special cases design parameters

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_limit_values_tension Number Tension, can be undefined (is not set, 0.001 as default)
property_limit_values_compression Number Compression, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_y Number Shear Y, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_z Number Shear Z, can be undefined (is not set, 0.001 as default)
property_limit_values_torsion Number Shear stress due to torsion, can be undefined (is not set, 0.010 as default)
property_limit_values_bending_about_major_axis_y Number Bending about major axis Y, can be undefined (is not set, 0.001 as default)
property_limit_values_bending_about_minor_axis_z Number Bending about minor axis Z, can be undefined (is not set, 0.001 as default)

# steelDesignUltimateConfigurationGB.SetOptions(property_options_elastic_or_fatigue_design, property_options_take_post_buckling_strength_of_web, property_options_plastic_design)

Sets Options

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_options_elastic_or_fatigue_design Boolean Elastic of fatigue design acc. to 6.1.2 and 8.1.1, can be undefined (is not set, false as default)
property_options_take_post_buckling_strength_of_web Boolean Post-buckling strength of web for l-shape section acc. to 6.4.1, can be undefined (is not set, false as default)
property_options_plastic_design Boolean Plastic resistance of section acc. to 10.1, 10.3 and 10.4, can be undefined (is not set, false as default)

# steelDesignUltimateConfigurationGB.SetImportanceFactorOfStructure(property_importance_factor_is_used, property_importance_factor_value)

Sets Importance factor of structure

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_importance_factor_is_used Boolean Use the importance factor of structure for all load combinations, can be undefined (is not set, true as default)
property_importance_factor_value Number Importance factor acc. to 3.1.9, can be undefined (is not set, 1.000 as default)

# steelDesignUltimateConfigurationGB.SetAnotherStandard(property_partial_safety_factor_is_user_defined, property_partial_safety_factor_value)

Sets Partial safety factor of materials from another standard

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_partial_safety_factor_is_user_defined Boolean User-defined factor, can be undefined (is not set, false as default)
property_partial_safety_factor_value Number Partial safety factor, can be undefined (is not set, 1.000 as default)

# steelDesignUltimateConfigurationGB.SetStabilityAnalysis(property_stability_analysis_equivalent_member, property_stability_analysis_p_delta_second_order, property_stability_analysis_direct_method)

Sets Stability analysis (only one option can be set)

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_stability_analysis_equivalent_member Boolean Equivalent member method acc. to 5.3, can be undefined (is not set, true as default)
property_stability_analysis_p_delta_second_order Boolean Elastic second-order P-Delta method acc. to 5.4, can be undefined (is not set, false as default)
property_stability_analysis_direct_method Boolean Direct method acc. to 5.5, can be undefined (is not set, false as default)

# steelDesignUltimateConfigurationGB.SetOverallStabilityFactor(property_determination_of_overall_stability_use_approximate_calculation, property_tolerance_of_ltb_support_distribution)

Sets Determination of overall stability factor of beams acc. to annex C

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_determination_of_overall_stability_use_approximate_calculation Boolean Use approximate calculation acc. to C.0.5 for I- and H-sections, can be undefined (is not set, false as default)
property_tolerance_of_ltb_support_distribution Number Tolerance for uniform distribution of side supports for tab. C.0.1, can be undefined (is not set, 0.05 as default)

# steelDesignUltimateConfigurationGB.SetDistorsionalBucklingOfBeams(property_check_compression_flange)

Sets Distorsional buckling of beams acc. to 6.2.7

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_check_compression_flange Boolean Check compression of flange acc. to 6.2.7 for I-sections, can be undefined (true as default)

# steelDesignUltimateConfigurationGB.SetPositionOfPositiveTransverse(property_load_acts_vp_downwards_on_top_flange, property_load_acts_vp_at_shear_point, property_load_acts_vp_at_center_point, property_load_acts_vp_downwards_on_bottom_flange)

Sets position of positive transverse load application (only one option can be set)

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_load_acts_vp_downwards_on_top_flange Boolean On profile edge (destabilizing effect), can be undefined (is not set, true as default)
property_load_acts_vp_at_shear_point Boolean At shear point, can be undefined (is not set, false as default)
property_load_acts_vp_at_center_point Boolean At center point, can be undefined (is not set, false as default)
property_load_acts_vp_downwards_on_bottom_flange Boolean On profile edge (stabilizing effect)

# steelDesignUltimateConfigurationGB.SetLocalStability(property_is_compression_flange_torsionally_restrained)

Sets Local stability acc. to 6.3

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_is_compression_flange_torsionally_restrained Boolean Torsion of compression flange is restrained, can be undefined (true as default)

# steelDesignUltimateConfigurationGB.SetWeldedSection(property_welded_cross_sections_classification_rolled, property_welded_cross_sections_classification_flame_cut, property_welded_cross_sections_classification_sheared)

Sets Classification of welded sections acc. to tab. 7.2.1 (only one option can be set)

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_welded_cross_sections_classification_rolled Boolean Rolled flange edges, can be undefined (is not set, true as default)
property_welded_cross_sections_classification_flame_cut Boolean Flame-cut flange edge, can be undefined (is not set, false as default)
property_welded_cross_sections_classification_sheared Boolean Shared flange edges, can be undefined (is not set, false as default)

# steelDesignUltimateConfigurationGB.SetGeneralSections(property_general_cross_sections_buckling_about_y_u, property_general_cross_sections_buckling_about_z_v)

Sets Classification of general sections acc. to tyb 7.2.1

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_general_cross_sections_buckling_about_y_u String Buckling about y/u axis, can be undefined (is not set, C as default)
property_general_cross_sections_buckling_about_z_v String Buckling about z/v axis, can be undefined (is not set, D as default)

# steelDesignUltimateConfigurationGB.SetImaginaryAxis(property_effective_length_of_built_up_part_l1)

Sets Connections of Built-up sections with imaginary axes acc. to 7.2.3

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_effective_length_of_built_up_part_l1 Number Longitudinal distance of built-up sections joints, can be undefined (is not set, 0.200 as default)

# steelDesignUltimateConfigurationGB.SetEquivalentMomentFactors(property_frame_column_y_u, property_frame_column_y_u_unbraced, property_unbraced_frame_column_beta_m_y_u, property_frame_column_y_u_braced, property_frame_column_z_v, property_frame_column_z_v_unbraced, property_unbraced_frame_column_beta_m_z_v, property_frame_column_z_v_braced, property_cantilever_beta_m_y_u, property_cantilever_beta_m_z_v)

Sets Equivalent Moment Factors Acc. to 8.2

Kind: instance method of SteelDesignUltimateConfigurationGB

Param Type Description
property_frame_column_y_u Boolean Equivalent Moment Factors Acc. to 8.2, can be undefined (is not set, false as default)
property_frame_column_y_u_unbraced Boolean The member is considered an unbraced frame column for the calculation of equivalent moment factors acc. to 8.2, can be undefined (is nit set, true as default)
property_unbraced_frame_column_beta_m_y_u NUmber The user-defined value of the factor is used for the calculation, can be undefined (is not set, 1.0 as default)
property_frame_column_y_u_braced Boolean The member is considered a braced frame column for the calculation of equivalent moment factors acc. to 8.2, can be undefined (is not set, false as default)
property_frame_column_z_v Boolean Equivalent Moment Factors Acc. to 8.2, can be undefined (is not set, false as default)
property_frame_column_z_v_unbraced Boolean The member is considered an unbraced frame column for the calculation of equivalent moment factors acc. to 8.2, can be undefined (is not set, true as default)
property_unbraced_frame_column_beta_m_z_v Number The user-defined value of the factor set here is used for the calculation, the recommended value is 1.0, can be undefined (is not set, 1.0 as default)
property_frame_column_z_v_braced Boolean The member is considered a braced frame column for the calculation of equivalent moment factors acc. to 8.2, can be undefined (is not set, false as default)
property_cantilever_beta_m_y_u Number The equivalent moment factor acc. to 8.2 for calculation of cantilever (settings in effective lengths, βmy), can be undefined (is not set, 1.0 as default)
property_cantilever_beta_m_z_v Number The equivalent moment factor acc. to 8.2 for calculation of cantilever (settings in effective lengths, βmz), can be undefined (is not set, 1.0 as default)

# SteelDesignUltimateConfigurationIS(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for IS code of standard

Kind: global function

Param Type Description
no Number Ultimate Configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignUltimateConfigurationIS.GetNo() ⇒

Kind: instance method of SteelDesignUltimateConfigurationIS
Returns: Ultimate Configuration index

# steelDesignUltimateConfigurationIS.GetUltimateConfiguration() ⇒

Kind: instance method of SteelDesignUltimateConfigurationIS
Returns: Ultimate Configuration object

# steelDesignUltimateConfigurationIS.SetName(name)

Sets Name

Kind: instance method of SteelDesignUltimateConfigurationIS

Param Type Description
name String Fire resistance Configuration name, can be undefined

# steelDesignUltimateConfigurationIS.SetGeneral(property_perform_stability_analysis)

Sets general design parameters

Kind: instance method of SteelDesignUltimateConfigurationIS

Param Type Description
property_perform_stability_analysis Boolean Perform stability design, can be undefined (true as default)

# steelDesignUltimateConfigurationIS.SetLimitValues(property_limit_values_tension, property_limit_values_compression, property_limit_values_shear_y, property_limit_values_shear_z, property_limit_values_torsion, property_limit_values_bending_about_major_axis_y, property_limit_values_bending_about_minor_axis_z)

Sets Limit values for special cases design parameters

Kind: instance method of SteelDesignUltimateConfigurationIS

Param Type Description
property_limit_values_tension Number Tension, can be undefined (is not set, 0.001 as default)
property_limit_values_compression Number Compression, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_y Number Shear Y, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_z Number Shear Z, can be undefined (is not set, 0.001 as default)
property_limit_values_torsion Number Shear stress due to torsion, can be undefined (is not set, 0.010 as default)
property_limit_values_bending_about_major_axis_y Number Bending about major axis Y, can be undefined (is not set, 0.001 as default)
property_limit_values_bending_about_minor_axis_z Number Bending about minor axis Z, can be undefined (is not set, 0.001 as default)

# steelDesignUltimateConfigurationIS.SetElasticDesign(property_elastic_design)

Sets Elastic design

Kind: instance method of SteelDesignUltimateConfigurationIS

Param Type Description
property_elastic_design Boolean Elastic design (also for class 1 and class 2 sections), can be undefined (true as default)

# steelDesignUltimateConfigurationIS.SetDesignOfShearBuckling(property_activate_shear_buckling, property_design_of_shear_buckling_method_a, property_design_of_shear_buckling_method_b)

Sets Design of shear buckling acc. to 8.4.2

Kind: instance method of SteelDesignUltimateConfigurationIS

Param Type Description
property_activate_shear_buckling Boolean Active, can be undefined (is not set, true as default)
property_design_of_shear_buckling_method_a Boolean Design of shear buckling acc. to 8.4.2.2(a), can be undefined (is not set, true as default)
property_design_of_shear_buckling_method_b Boolean If possible, design of shear buckling acc. to 8.4.2.2(b), otherwise acc. to 8.4.2.2(a), can be undefined (is not set, false as default)

# steelDesignUltimateConfigurationIS.SetCombined(property_use_conservative_equation)

Sets Combined axial force and bending moment acc. to 9.3.1.1

Kind: instance method of SteelDesignUltimateConfigurationIS

Param Type Description
property_use_conservative_equation Boolean Use conservative equation, can be undefined (true as default)

# steelDesignUltimateConfigurationIS.SetCalculationMethod(property_structure_type_sway_yy, property_structure_type_sway_zz)

Sets Calculation method (Perform stability design is on)

Kind: instance method of SteelDesignUltimateConfigurationIS

Param Type Description
property_structure_type_sway_yy Boolean Sway y-y, can be undefined (is not set, false as default)
property_structure_type_sway_zz Boolean Sway z-z, can be undefined (is not set, false as default)

# steelDesignUltimateConfigurationIS.SetPositionOfPositiveTransverse(property_vertical_position_downwards_on_top_flange, property_vertical_position_at_shear_point, property_vertical_position_at_center_point, property_vertical_position_downwards_on_bottom_flange)

Sets Position of positive transverse load application (only one option can be set)

Kind: instance method of SteelDesignUltimateConfigurationIS

Param Type Description
property_vertical_position_downwards_on_top_flange Boolean On profile edge (destabilizing effect), can be undefined (is not set, true as default)
property_vertical_position_at_shear_point Boolean At shear point, can be undefined (is not set, false as default)
property_vertical_position_at_center_point Boolean At center point, can be undefined (is not set, false as default)
property_vertical_position_downwards_on_bottom_flange Boolean On profile edge (stabilizing effect)

# SteelDesignUltimateConfigurationNBR(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for NBR code of standard

Kind: global function

Param Type Description
no Number Ultimate Configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignUltimateConfigurationNBR.GetNo() ⇒

Kind: instance method of SteelDesignUltimateConfigurationNBR
Returns: Ultimate Configuration index

# steelDesignUltimateConfigurationNBR.GetUltimateConfiguration() ⇒

Kind: instance method of SteelDesignUltimateConfigurationNBR
Returns: Ultimate Configuration object

# steelDesignUltimateConfigurationNBR.SetName(name)

Sets Name

Kind: instance method of SteelDesignUltimateConfigurationNBR

Param Type Description
name String Ultimate Configuration name, can be undefined

# steelDesignUltimateConfigurationNBR.SetGeneral(property_perform_stability_analysis)

Sets general design parameters

Kind: instance method of SteelDesignUltimateConfigurationNBR

Param Type Description
property_perform_stability_analysis Boolean Perform stability design, can be undefined (true as default)

# steelDesignUltimateConfigurationNBR.SetLimitValues(property_limit_values_tension, property_limit_values_compression, property_limit_values_torsion_shear_stress, property_limit_values_shear_y, property_limit_values_shear_z, property_limit_values_bending_about_major_axis_y, property_limit_values_bending_about_minor_axis_z)

Sets limit values for special cases design parameters

Kind: instance method of SteelDesignUltimateConfigurationNBR

Param Type Description
property_limit_values_tension Number Tension, can be undefined (is not set, 0.001 as default)
property_limit_values_compression Number Compression, can be undefined (is not set, 0.001 as default)
property_limit_values_torsion_shear_stress Number Shear stress due to torsion (is not set, 0.01 as default)
property_limit_values_shear_y Number Shear Y, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_z Number Shear Z, can be undefined (is not set, 0.001 as default)
property_limit_values_bending_about_major_axis_y Number Bending about major axis Y, can be undefined (is not set, 0.001 as default)
property_limit_values_bending_about_minor_axis_z Number Bending about minor axis Z, can be undefined (is not set, 0.001 as default)

# steelDesignUltimateConfigurationNBR.SetOptions(property_reduction_coefficient_c_t, property_wall_thickness_reduction)

Sets Options for Design parameters

Kind: instance method of SteelDesignUltimateConfigurationNBR

Param Type Description
property_reduction_coefficient_c_t Number Net area reduction coefficient, can be undefined (is not set, 1.0 as default)
property_wall_thickness_reduction Boolean Use reduced wall thickness for circular pipes in shear acc. to 5.4.3.6, can be undefined (is not set, true as default)

# steelDesignUltimateConfigurationNBR.SetPositionOfPositiveTransverse(property_vertical_position_downwards_on_top_flange, property_vertical_position_at_shear_point, property_vertical_position_at_center_point, property_vertical_position_downwards_on_bottom_flange)

Sets Position of positive Transverse load application

Kind: instance method of SteelDesignUltimateConfigurationNBR

Param Type Description
property_vertical_position_downwards_on_top_flange Boolean On profile edge (destabilizing effect), can be undefined (is not set, true as default)
property_vertical_position_at_shear_point Boolean At shear point, can be undefined (is not set, false as default)
property_vertical_position_at_center_point Boolean At center point, can be undefined (is not set, false as default)
property_vertical_position_downwards_on_bottom_flange Boolean On profile edge (stabilizing effect), can be undefined (is not set, false as default)

# SteelDesignUltimateConfigurationNTC(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for NTC code of standard

Kind: global function

Param Type Description
no Number Ultimate Configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignUltimateConfigurationNTC.GetNo() ⇒

Kind: instance method of SteelDesignUltimateConfigurationNTC
Returns: Ultimate Configuration index

# steelDesignUltimateConfigurationNTC.GetUltimateConfiguration() ⇒

Kind: instance method of SteelDesignUltimateConfigurationNTC
Returns: Ultimate Configuration object

# steelDesignUltimateConfigurationNTC.SetName(name)

Sets Name

Kind: instance method of SteelDesignUltimateConfigurationNTC

Param Type Description
name String Fire resistance Configuration name, can be undefined

# SteelDesignUltimateConfigurationSIA(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration for SIA code of standard

Kind: global function

Param Type Description
no Number Ultimate Configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignUltimateConfigurationSIA.GetNo() ⇒

Kind: instance method of SteelDesignUltimateConfigurationSIA
Returns: Ultimate Configuration index

# steelDesignUltimateConfigurationSIA.GetUltimateConfiguration() ⇒

Kind: instance method of SteelDesignUltimateConfigurationSIA
Returns: Ultimate Configuration object

# steelDesignUltimateConfigurationSIA.SetName(name)

Sets Name

Kind: instance method of SteelDesignUltimateConfigurationSIA

Param Type Description
name String Ultimate Configuration name, can be undefined

# steelDesignUltimateConfigurationSIA.SetGeneral(property_perform_stability_analysis)

Sets general design parameters

Kind: instance method of SteelDesignUltimateConfigurationSIA

Param Type Description
property_perform_stability_analysis Boolean Perform stability design, can be undefined (true as default)

# steelDesignUltimateConfigurationSIA.SetLimitValues(property_limit_values_tension, property_limit_values_compression, property_limit_values_shear_y, property_limit_values_shear_z, property_limit_values_torsion, property_limit_values_bending_about_major_axis_y, property_limit_values_bending_about_minor_axis_z)

Sets limit values for special cases design parameters

Kind: instance method of SteelDesignUltimateConfigurationSIA

Param Type Description
property_limit_values_tension Number Tension, can be undefined (is not set, 0.001 as default)
property_limit_values_compression Number Compression, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_y Number Shear Y, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_z Number Shear Z, can be undefined (is not set, 0.001 as default)
property_limit_values_torsion Number Shear stress due to torsion, can be undefined (is not set, 0.010 as default)
property_limit_values_bending_about_major_axis_y Number Bending about major axis Y, can be undefined (is not set, 0.001 as default)
property_limit_values_bending_about_minor_axis_z Number Bending about minor axis Z, can be undefined (is not set, 0.001 as default)

# steelDesignUltimateConfigurationSIA.SetOptions(property_options_consider_shear_area_acc_to_5_2_4, property_options_consider_shear_buckling)

Sets Design parameters options

Kind: instance method of SteelDesignUltimateConfigurationSIA

Param Type Description
property_options_consider_shear_area_acc_to_5_2_4 Boolean Consider shear area acc. to 5.2.4, can be undefined (is not set, false as default)
property_options_consider_shear_buckling Boolean Consider shear buckling design, can be undefined (is not set, true as default)

# steelDesignUltimateConfigurationSIA.SetPositionOfPositiveTransverse(property_load_acts_vp_downwards_on_top_flange, property_load_acts_vp_at_shear_point, property_load_acts_vp_at_center_point, property_load_acts_vp_downwards_on_bottom_flange)

Sets position of positive transverse load application (only one option can be set)

Kind: instance method of SteelDesignUltimateConfigurationSIA

Param Type Description
property_load_acts_vp_downwards_on_top_flange Boolean On profile edge (destabilizing effect), can be undefined (is not set, true as default)
property_load_acts_vp_at_shear_point Boolean At shear point, can be undefined (is not set, false as default)
property_load_acts_vp_at_center_point Boolean At center point, can be undefined (is not set, false as default)
property_load_acts_vp_downwards_on_bottom_flange Boolean On profile edge (is not set, stabilizing effect)

# SteelDesignUltimateConfigurationSP(no, members_no, member_sets_no, comment, params)

Creates Steel Design Ultimate Configuration

Kind: global function

Param Type Description
no Number Ultimate Configuration index, can be undefined
members_no Array List of members assigned, can be undefined
member_sets_no Array List of member sets assigned, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignUltimateConfigurationSP.GetNo() ⇒

Kind: instance method of SteelDesignUltimateConfigurationSP
Returns: Ultimate Configuration index

# steelDesignUltimateConfigurationSP.GetUltimateConfiguration() ⇒

Kind: instance method of SteelDesignUltimateConfigurationSP
Returns: Ultimate Configuration object

# steelDesignUltimateConfigurationSP.SetName(name)

Sets Name

Kind: instance method of SteelDesignUltimateConfigurationSP

Param Type Description
name String Fire resistance Configuration name, can be undefined

# steelDesignUltimateConfigurationSP.SetGeneral(property_perform_stability_analysis)

Sets general design parameters

Kind: instance method of SteelDesignUltimateConfigurationSP

Param Type Description
property_perform_stability_analysis Boolean Perform stability design, can be undefined (is not set, true as default)

# steelDesignUltimateConfigurationSP.SetLimitValues(property_limit_values_tension, property_limit_values_compression, property_limit_values_shear_perpendicular_to_axis_yu, property_limit_values_shear_perpendicular_to_axis_zv, property_limit_values_torsion, property_limit_values_bending_about_major_axis_yu, property_limit_values_bending_about_minor_axis_zv)

Sets Limit values for special cases design parameters

Kind: instance method of SteelDesignUltimateConfigurationSP

Param Type Description
property_limit_values_tension Number Tension, can be undefined (is not set, 0.001 as default)
property_limit_values_compression Number Compression, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_perpendicular_to_axis_yu Number Shear Y, can be undefined (is not set, 0.001 as default)
property_limit_values_shear_perpendicular_to_axis_zv Number Shear Z, can be undefined (is not set, 0.001 as default)
property_limit_values_torsion Number Shear stress due to torsion, can be undefined (is not set, 0.010 as default)
property_limit_values_bending_about_major_axis_yu Number Bending about major axis Y, can be undefined (is not set, 0.001 as default)
property_limit_values_bending_about_minor_axis_zv Number Bending about minor axis Z, can be undefined (is not set, 0.001 as default)

# steelDesignUltimateConfigurationSP.SetServiceFactor(property_service_factor_acc_to_table_1)

Sets Service factor

Kind: instance method of SteelDesignUltimateConfigurationSP

Param Type Description
property_service_factor_acc_to_table_1 Number Factor acc. to table 1, can be undefined (is not set, 0.90 as default)

# steelDesignUltimateConfigurationSP.SetPartialSafetyFactor(property_partial_safety_factor_acc_to_table_3)

Sets Partial safety factor for material

Kind: instance method of SteelDesignUltimateConfigurationSP

Param Type Description
property_partial_safety_factor_acc_to_table_3 Number Factor acc. to table 3, can be undefined (is not set, 1.02 as default)

# steelDesignUltimateConfigurationSP.SetOptions(property_options_plastic_design)

Sets Options

Kind: instance method of SteelDesignUltimateConfigurationSP

Param Type Description
property_options_plastic_design Boolean Plastic design (class 2 and 3 acc. to SNIP II-23-81), can be undefined (is not set, false as default)

# steelDesignUltimateConfigurationSP.SetLoadSafetyCoefficient(property_load_safety_coefficient_is_used, property_load_safety_coefficient_value)

Sets Load safety coefficient

Kind: instance method of SteelDesignUltimateConfigurationSP

Param Type Description
property_load_safety_coefficient_is_used Boolean Use load safety coefficient gama-f as limit for coefficients cy and cz from tab. E.1, can be undefined (is not set, true as default)
property_load_safety_coefficient_value Number Load safety coefficient gama-f used in tab. E.1, can be undefined (is not set, 1.100 as default)

# steelDesignUltimateConfigurationSP.SetDesignParameters(property_tolerance_of_ltb_support_distribution, property_tolerance_of_concentrated_load_position, property_vertical_position_downwards_on_top_flange, property_vertical_position_downwards_on_bottom_flange)

Sets Design parameters

Kind: instance method of SteelDesignUltimateConfigurationSP

Param Type Description
property_tolerance_of_ltb_support_distribution Number Tolerance for uniform distribution of side supports for tab. Z.1, can be undefined (is not set, 0.05 as default)
property_tolerance_of_concentrated_load_position Number Tolerance for position of concentrated load for tab. Z.1, can be undefined (is not set, 0.05 as default)
property_vertical_position_downwards_on_top_flange Boolean Vertical position on profile edge (destabilizing effect), can be undefined (is not set, true as default)
property_vertical_position_downwards_on_bottom_flange Boolean Vertical position on profile edge (stabilizing effect), can be undefined (false as default)

# Functions

ConcreteDesignConcreteDurability(no, members_no, surfaces_no, member_sets_no, comment, params)

Creates Concrete design Concrete durability

ConcreteDesignEffectiveLength(no, members_no, member_sets_no, comment, params)

Creates Concrete design effective length

ConcreteDesignPunchingReinforcement(no, nodes_no, material_no, comment, params)

Creates Concrete design punching reinforcement

ConcreteDesignReinforcementDirection(no, surfaces_no, comment, params)

Creates Concrete design reinforcement direction

ConcreteDesignSurfaceReinforcement(no, surfaces_no, material_no, reinforcement_type, comment, params)

Creates Concrete design surface reinforcement

# ConcreteDesignConcreteDurability(no, members_no, surfaces_no, member_sets_no, comment, params)

Creates Concrete design Concrete durability

Kind: global function

Param Type Description
no Number Concrete durability index, can be undefined
members_no Array List of members indexes, can be undefined
surfaces_no Array List of surfaces indexes, can be undefined
member_sets_no Array List of member sets indexes, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# concreteDesignConcreteDurability.GetNo() ⇒

Kind: instance method of ConcreteDesignConcreteDurability
Returns: Concrete durability number

# concreteDesignConcreteDurability.GetConcreteDurability() ⇒

Kind: instance method of ConcreteDesignConcreteDurability
Returns: Concrete durability object

# concreteDesignConcreteDurability.SetName(name)

Sets Name

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
name String Name, can be undefined (when undefined, generated name is used)

# concreteDesignConcreteDurability.SetNoRiskOfCorrosionOrAttack(no_risk_of_corrosion_or_attack, no_risk_of_corrosion_or_attack_enabled)

Sets no risk of corrosion or attack

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
no_risk_of_corrosion_or_attack String No risk of corrosion or attack type (VERY_DRY), can be undefined (is not set, VERY_DRY as default)
no_risk_of_corrosion_or_attack_enabled Boolean Enable/disable, can be undefined (true as default)

# concreteDesignConcreteDurability.SetCorrosionInducedByCarbonation(corrosion_induced_by_carbonation, corrosion_induced_by_carbonation_enabled)

Sets Corrosion induced by carbonation

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
corrosion_induced_by_carbonation String Corrosion induced by carbonation type (DRY_OR_PERMANENTLY_WET, WET_RARELY_DRY, MODERATE_HUMIDITY, CYCLIC_WET_AND_DRY), can be undefined (is not set, DRY_OR_PERMANENTLY_WET as default)
corrosion_induced_by_carbonation_enabled Boolean Enable/disable, can be undefined (true as default)

# concreteDesignConcreteDurability.SetCorrosionInducedByChlorides(corrosion_induced_by_chlorides, corrosion_induced_by_chlorides_enabled)

Sets Corrosion induced by chlorides

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
corrosion_induced_by_chlorides String Corrosion induced by chlorides (MODERATE_HUMIDITY, WET_RARELY_DRY, CYCLIC_WET_AND_DRY), can be undefined (is not set, MODERATE_HUMIDITY as default)
corrosion_induced_by_chlorides_enabled Boolean Enable/disable, can be undefined (true as default)

# concreteDesignConcreteDurability.SetCorrosionInducedByChloridesFromSeaWater(corrosion_induced_by_chlorides_from_sea_water, corrosion_induced_by_chlorides_from_sea_water_enabled)

Sets Corrosion induced by chlorides from sea water

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
corrosion_induced_by_chlorides_from_sea_water String Corrosion induced by chlorides from sea water (AIRBORNE_SALT, PERMANENTLY_SUBMERGED, SPLASH_AND_SPRAY_ZONES), can be undefined (is not set, AIRBORNE_SALT as default)
corrosion_induced_by_chlorides_from_sea_water_enabled Boolean Enable/disable, can be undefined (true as default)

# concreteDesignConcreteDurability.SetFreezeThawAttack(freeze_thaw_attack, freeze_thaw_attack_enabled)

Sets Freeze/Thaw attack

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
freeze_thaw_attack String Freeze/thaw attack (MODERATE_SATURATION_NO_DEICING, MODERATE_SATURATION_DEICING, HIGH_SATURATION_NO_DEICING, HIGH_SATURATION_DEICING), can be undefined (is not set, MODERATE_SATURATION_NO_DEICING as default)
freeze_thaw_attack_enabled Boolean Enable/disable, can be undefined (true as default)

# concreteDesignConcreteDurability.SetChemicalAttack(chemical_attack, chemical_attack_enabled)

Sets Chemical attack

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
chemical_attack String Chemical attack (SLIGHTLY_AGGRESSIVE, MODERATELY_AGGRESSIVE, HIGHLY_AGGRESSIVE), can be undefined (is not set, SLIGHTLY_AGGRESSIVE as default)
chemical_attack_enabled Boolean Enable/disable, can be undefined (true as default)

# concreteDesignConcreteDurability.SetConcreteCorrosionInducedByWear(concrete_corrosion_induced_by_wear, concrete_corrosion_induced_by_wear_enabled)

Sets Concrete corrosion induced by wear

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
concrete_corrosion_induced_by_wear String Concrete corrosion induced ba wear (MODERATE, HIGH, VERY_HIGH), can be undefined (is not set, MODERATE as default)
concrete_corrosion_induced_by_wear_enabled Boolean Enable/disable, can be undefined (true as default)

# concreteDesignConcreteDurability.SetStructuralClassAccordingTo4_4_1_2(increase_design_working_life_from_50_to_100_years_enabled, position_of_reinforcement_not_affected_by_construction_process_enabled, special_quality_control_of_production_enabled, air_entrainment_of_more_than_4_percent_enabled)

Sets Structural class according to 4.4.1.2(5)

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
increase_design_working_life_from_50_to_100_years_enabled Boolean Increase design working life from 50 to 100 years, can be undefined (is not set, false as default)
position_of_reinforcement_not_affected_by_construction_process_enabled Boolean Position of reinforcement not affected by construction process (slab geometry), can be undefined (is not set, false as default)
special_quality_control_of_production_enabled Boolean Special quality control of the concrete production, can be undefined (is not set, false as default)
air_entrainment_of_more_than_4_percent_enabled Boolean Air entrainment of more then 4% according to 4.4.1.2(5), can be undefined (is not set, false as default)

# concreteDesignConcreteDurability.SetStructuralClassUserDefined(userdefined_structural_class)

Sets User-defined structural class

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
userdefined_structural_class String User-defined structural class (S1, S2, S3, S4, S5, S6), can be undefined (is not set, S4 as default)

# concreteDesignConcreteDurability.SetStainlessSteel(stainless_steel, stainless_steel_enabled)

Sets Reduction of concrete cover for durability - Stainless steel

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
stainless_steel String/Number Stainless steel (STANDARD - According to standard, or user-defined value), can be undefined (is not set, STANDARD as default)
stainless_steel_enabled Boolean Enable/disable, can be undefined (true as default)

# concreteDesignConcreteDurability.SetAdditionalProtection(additional_protection, additional_protection_enabled)

Sets Reduction of concrete cover for durability - Additional protection

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
additional_protection String/Number Additional protection (STANDARD - According to standard, or user-defined value), can be undefined (is not set, STANDARD as default)
additional_protection_enabled Boolean Enable/disable, can be undefined (true as default)

# concreteDesignConcreteDurability.SetAllowanceForDeviation(allowance_of_deviation_type, concrete_cast_enabled, concrete_cast, userdefined_allowance_of_deviation_factor)

Sets Allowance for deviation

Kind: instance method of ConcreteDesignConcreteDurability

Param Type Description
allowance_of_deviation_type String Allowance for deviation (STANDARD, DEFINED)
concrete_cast_enabled Boolean Concrete cast against uneven surfaces according to 4.4.1.3(4), can be undefined (is not set, false as default)
concrete_cast String Concrete cast (AGAINST_PREPARED_GROUND, DIRECTLY_AGAINST_SOIL), can be undefined (is not set, AGAINST_PREPARED_GROUND as default)
userdefined_allowance_of_deviation_factor Number User-defined allowance of deviation factor, can be undefined (is not set, 10 mm as default)

# ConcreteDesignEffectiveLength(no, members_no, member_sets_no, comment, params)

Creates Concrete design effective length

Kind: global function

Param Type Description
no Number Concrete design effective length index, can be undefined
members_no Array List of members indexes, can be undefined
member_sets_no Array List of member sets indexes, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# concreteDesignEffectiveLength.GetNo() ⇒

Kind: instance method of ConcreteDesignEffectiveLength
Returns: Effective length number

# concreteDesignEffectiveLength.GetEffectiveLength() ⇒

Kind: instance method of ConcreteDesignEffectiveLength
Returns: Effective length object

# concreteDesignEffectiveLength.SetName(name)

Sets Name

Kind: instance method of ConcreteDesignEffectiveLength

Param Type Description
name String Name, can be undefined (when undefined, generated name is used)

# concreteDesignEffectiveLength.SetDeterminationType(flexural_buckling_about_y, flexural_buckling_about_z)

Sets Determination type

Kind: instance method of ConcreteDesignEffectiveLength

Param Type Description
flexural_buckling_about_y Boolean Consider effective length for flexural buckling about y (major axis), can be undefined (is not set, true as default)
flexural_buckling_about_z Boolean Consider effective length for flexural buckling about z (minor axis), can be undefined (is not set, true as default)

# concreteDesignEffectiveLength.SetStructureType(structure_type_about_axis_y, structure_type_about_axis_z)

Sets Structure type

Kind: instance method of ConcreteDesignEffectiveLength

Param Type Description
structure_type_about_axis_y String About y-axis (UNBRACED, BRACED, COMBINED (only SP)), can be undefined (is not set, UNBRACED as default)
structure_type_about_axis_z String About z-axis (UNBRACED, BRACED, COMBINED (only SP)), can be undefined (is not set, UNBRACED as default)

# concreteDesignEffectiveLength.SetNodalSupportsStartWithSupportType(support_type)

Sets Nodal supports type for start sequence node

Kind: instance method of ConcreteDesignEffectiveLength

Param Type Description
support_type String Support type (NONE, FIXED_IN_Z, FIXED_IN_Y, FIXED_ALL), can be undefined (if not set, FIXED_IN_Z as default)

# concreteDesignEffectiveLength.SetNodalSupportsEndWithSupportType(support_type)

Sets Nodal supports type for end sequence node

Kind: instance method of ConcreteDesignEffectiveLength

Param Type Description
support_type String Support type (NONE, FIXED_IN_Z, FIXED_IN_Y, FIXED_ALL), can be undefined (if not set, FIXED_IN_Z as default)

# concreteDesignEffectiveLength.DifferentPropertiesForNodalSupports(different_properties)

Sets Different properties state for nodal supports

Kind: instance method of ConcreteDesignEffectiveLength

Param Type Description
different_properties Boolean Different properties, can be undefined (true as default)

# concreteDesignEffectiveLength.InsertNodalSupportIntermediateNodeWithSupportType(support_type)

Inserts Intermediate node with support type

Kind: instance method of ConcreteDesignEffectiveLength

Param Type Description
support_type String Support type (NONE, FIXED_IN_Z, FIXED_IN_Y, FIXED_ALL), can be undefined (if not set, FIXED_IN_Z as default)

# concreteDesignEffectiveLength.SetEffectiveLengthFactors(row, flexural_buckling_y, flexural_buckling_z, braced_flexural_buckling_y, braced_flexural_buckling_z, unbraced_flexural_buckling_y, unbraced_flexural_buckling_z)

Sets Effective length factors for segment sequence

Kind: instance method of ConcreteDesignEffectiveLength

Param Type Description
row Number Segment sequence row
flexural_buckling_y Number Flexural buckling y, can be undefined (1.00 as default if it's enabled)
flexural_buckling_z Number Flexural axes z, can be undefined (1.00 as default if it's enabled)
braced_flexural_buckling_y Number Braced flexural axes y, can be undefined (1.00 as default if it's enabled)
braced_flexural_buckling_z Number Braced flexural axes z, can be undefined (1.00 as default if it's enabled)
unbraced_flexural_buckling_y Number Unbraced flexural axes y, can be undefined (1.00 as default if it's enabled)
unbraced_flexural_buckling_z Number Unbraced flexural axes z, can be undefined (1.00 as default if it's enabled)

# concreteDesignEffectiveLength.SetOverwriteEffectiveLengths(row, flexural_buckling_y, flexural_buckling_z, braced_flexural_buckling_y, braced_flexural_buckling_z, unbraced_flexural_buckling_y, unbraced_flexural_buckling_z)

Sets Overwrite effective length for segment sequence

Kind: instance method of ConcreteDesignEffectiveLength

Param Type Description
row Number Segment sequence row
flexural_buckling_y Number Flexural buckling y, can be undefined (1.00 as default if it's enabled)
flexural_buckling_z Number Flexural axes z, can be undefined (1.00 as default if it's enabled)
braced_flexural_buckling_y Number Braced flexural axes y, can be undefined (1.00 as default if it's enabled)
braced_flexural_buckling_z Number Braced flexural axes z, can be undefined (1.00 as default if it's enabled)
unbraced_flexural_buckling_y Number Unbraced flexural axes y, can be undefined (1.00 as default if it's enabled)
unbraced_flexural_buckling_z Number Unbraced flexural axes z, can be undefined (1.00 as default if it's enabled)

# ConcreteDesignPunchingReinforcement(no, nodes_no, material_no, comment, params)

Creates Concrete design punching reinforcement

Kind: global function

Param Type Description
no Number Concrete design punching reinforcement index, can be undefined
nodes_no Array List of nodes indexes, can be undefined
material_no Array Material number, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# concreteDesignPunchingReinforcement.GetNo() ⇒

Kind: instance method of ConcreteDesignPunchingReinforcement
Returns: Punching reinforcement number

# concreteDesignPunchingReinforcement.GetSurfaceReinforcement() ⇒

Kind: instance method of ConcreteDesignPunchingReinforcement
Returns: Punching reinforcement object

# concreteDesignPunchingReinforcement.SetName(name)

Sets Name

Kind: instance method of ConcreteDesignPunchingReinforcement

Param Type Description
name String Name, can be undefined (when undefined, generated name is used)

# concreteDesignPunchingReinforcement.SetType(type)

Sets type

Kind: instance method of ConcreteDesignPunchingReinforcement

Param Type Description
type String Type (VERTICAL)

# concreteDesignPunchingReinforcement.SetPlacement(placement_type)

Sets Placement

Kind: instance method of ConcreteDesignPunchingReinforcement

Param Type Description
placement_type String Placement (UNIFORM, AUTOMATICALLY)

# concreteDesignPunchingReinforcement.SetOptions(loading_area_for_single_forces_enabled, longitudinal_reinforcement_from_surface_enabled)

sets Options

Kind: instance method of ConcreteDesignPunchingReinforcement

Param Type Description
loading_area_for_single_forces_enabled Boolean Load area for single forces, can be undefined (is not set, false as default)
longitudinal_reinforcement_from_surface_enabled Boolean Longitudinal reinforcement from surface, can be undefined (is not set, true as default)

# ConcreteDesignReinforcementDirection(no, surfaces_no, comment, params)

Creates Concrete design reinforcement direction

Kind: global function

Param Type Description
no Number Concrete design reinforcement direction index, can be undefined
surfaces_no Array List of surfaces indexes, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# concreteDesignReinforcementDirection.GetNo() ⇒

Kind: instance method of ConcreteDesignReinforcementDirection
Returns: Reinforcement direction number

# concreteDesignReinforcementDirection.GetReinforcementDirection() ⇒

Kind: instance method of ConcreteDesignReinforcementDirection
Returns: Reinforcement direction object

# concreteDesignReinforcementDirection.SetName(name)

Sets Name

Kind: instance method of ConcreteDesignReinforcementDirection

Param Type Description
name String Name, can be undefined (when undefined, generated name is used)

# concreteDesignReinforcementDirection.SetDirectionType(reinforcement_direction_type)

Sets Direction type

Kind: instance method of ConcreteDesignReinforcementDirection

Param Type Description
reinforcement_direction_type String Direction type (FIRST_REINFORCEMENT_IN_X, FIRST_REINFORCEMENT_IN_Y, ROTATED)

# concreteDesignReinforcementDirection.SetDirectionRotations(first_reinforcement_angle, second_reinforcement_angle)

Sets Reinforcement direction rotations about z related to x

Kind: instance method of ConcreteDesignReinforcementDirection

Param Type Description
first_reinforcement_angle Number First reinforcement angle
second_reinforcement_angle Number Second reinforcement angle

# ConcreteDesignSurfaceReinforcement(no, surfaces_no, material_no, reinforcement_type, comment, params)

Creates Concrete design surface reinforcement

Kind: global function

Param Type Description
no Number Concrete design surface reinforcement index, can be undefined
surfaces_no Array List of surfaces indexes, can be undefined
material_no Array Material number, can be undefined
reinforcement_type String Reinforcement type (MESH, REBAR, STIRRUPS), can be undefined (is not set, REBAR as default)
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# concreteDesignSurfaceReinforcement.GetNo() ⇒

Kind: instance method of ConcreteDesignSurfaceReinforcement
Returns: Surface reinforcement number

# concreteDesignSurfaceReinforcement.GetSurfaceReinforcement() ⇒

Kind: instance method of ConcreteDesignSurfaceReinforcement
Returns: Surface reinforcement object

# concreteDesignSurfaceReinforcement.SetName(name)

Sets Name

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
name String Name, can be undefined (when undefined, generated name is used)

# concreteDesignSurfaceReinforcement.SetLocationType(location_type)

Sets location type

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
location_type String Location type (ON_SURFACE, FREE_RECTANGULAR, FREE_CIRCULAR, FREE_POLYGON)

# concreteDesignSurfaceReinforcement.SetRebarDiameter(rebar_diameter)

Sets Rebar diameter

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
rebar_diameter Number/String Rebar diameter

# concreteDesignSurfaceReinforcement.SetRebarSpacing(rebar_spacing)

Sets Rebar diameter

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
rebar_spacing Number Rebar spacing

# concreteDesignSurfaceReinforcement.SetRebarDiameterAuto(rebar_diameter_auto_minimum, rebar_diameter_auto_maximum, rebar_diameter_auto_diameters, rebar_diameter_auto_priority)

Sets Rebar auto diameter (geometry, settings)

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
rebar_diameter_auto_minimum Number Minimum diameter, can be undefined (is not set, 10 mm as default)
rebar_diameter_auto_maximum Number Maximum diameter, can be undefined (is not set, 20 mm as default)
rebar_diameter_auto_diameters String Diameters for reinforcement (e.g. '8.0, 10.0, 12.0 ...'), can be undefined
rebar_diameter_auto_priority Number Priority, can be undefined (is not set, 1 as default)

# concreteDesignSurfaceReinforcement.SetRebarSpacingAuto(rebar_spacing_auto_minimum, rebar_spacing_auto_maximum, rebar_spacing_auto_increment, rebar_spacing_auto_priority)

Sets Rebar auto diameter (geometry, settings)

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
rebar_spacing_auto_minimum Number Minimum spacing, can be undefined (is not set, 0.1 m as default)
rebar_spacing_auto_maximum Number Maximum spacing, can be undefined (is not set, 0.3 m as default)
rebar_spacing_auto_increment Number Increment, can be undefined (is not set, 0.1 m as default)
rebar_spacing_auto_priority Number Priority, can be undefined (is not set, 1 as default)

# concreteDesignSurfaceReinforcement.SetAdditionalTransverseReinforcement(additional_transverse_reinforcement_enabled)

Enabled/disabled Additional transverse reinforcement

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
additional_transverse_reinforcement_enabled Boolean Enabled/disabled, can be undefined (true as default);

# concreteDesignSurfaceReinforcement.SetAdditionalRebarDiameter(additional_rebar_diameter)

Sets Additional rebar diameter

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
additional_rebar_diameter Number Additional rebar diameter

# concreteDesignSurfaceReinforcement.SetAdditionalRebarSpacing(additional_rebar_spacing)

Sets Additional rebar spacing

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
additional_rebar_spacing Number Additional rebar spacing

# concreteDesignSurfaceReinforcement.SetAdditionalRebarDiameterAuto(additional_rebar_diameter_auto_minimum, additional_rebar_diameter_auto_maximum, additional_rebar_diameter_auto_diameters, additional_rebar_diameter_auto_priority)

Sets Additional rebar auto diameter (geometry, settings)

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
additional_rebar_diameter_auto_minimum Number Minimum diameter, can be undefined (is not set, 10 mm as default)
additional_rebar_diameter_auto_maximum Number Maximum diameter, can be undefined (is not set, 20 mm as default)
additional_rebar_diameter_auto_diameters String Diameters for reinforcement (e.g. '8.0, 10.0, 12.0, 14.0')
additional_rebar_diameter_auto_priority Number Priority, can be undefined (is not set, 1 as default)

# concreteDesignSurfaceReinforcement.SetAdditionalRebarSpacingAuto(additional_rebar_spacing_auto_minimum, additional_rebar_spacing_auto_maximum, additional_rebar_spacing_auto_increment, additional_rebar_spacing_auto_priority)

Sets Additional rebar auto spacing (geometry, settings)

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
additional_rebar_spacing_auto_minimum Number Minimum spacing, can be undefined (is not set, 0.1 m as default)
additional_rebar_spacing_auto_maximum Number Maximum diameter, can be undefined (is not set, 0.3 m as default)
additional_rebar_spacing_auto_increment Number Increment, can be undefined (is not set, 0.010 m as default)
additional_rebar_spacing_auto_priority Number Priority, can be undefined (is not set, 1 as default)

# concreteDesignSurfaceReinforcement.SetStirrupsDiameter(stirrup_diameter)

Sets Stirrups diameter

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
stirrup_diameter Number Stirrups diameter

# concreteDesignSurfaceReinforcement.SetStirrupsSpacing(stirrup_spacing)

Sets Stirrups spacing

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
stirrup_spacing Number Stirrups spacing

# concreteDesignSurfaceReinforcement.SetStirrupsDiameterAuto(stirrup_diameter_auto_minimum, stirrup_diameter_auto_maximum, stirrup_diameter_auto_diameters, stirrup_diameter_auto_priority)

Sets Stirrups auto diameter (geometry, settings)

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
stirrup_diameter_auto_minimum Number Minimum diameter, can be undefined (is not set, 10 mm as default)
stirrup_diameter_auto_maximum Number Maximum diameter, can be undefined (is not set, 20 mm as default)
stirrup_diameter_auto_diameters String Diameters for reinforcement (e.g. '8.0, 10.0, 12.0 ...'), can be undefined
stirrup_diameter_auto_priority Number Priority, can be undefined (is not set, 1 as default)

# concreteDesignSurfaceReinforcement.SetStirrupsSpacingAuto(stirrup_spacing_auto_minimum, stirrup_spacing_auto_maximum, stirrup_spacing_auto_increment, stirrup_spacing_auto_priority)

Sets Stirrups auto spacing (geometry, settings)

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
stirrup_spacing_auto_minimum Number Minimum spacing, can be undefined (is not set, 0.1 m as default)
stirrup_spacing_auto_maximum Number Maximum spacing, can be undefined (is not set, 0.3 m as default)
stirrup_spacing_auto_increment Number Increment, can be undefined (is not set, 0.01 m as default)
stirrup_spacing_auto_priority Number Priority, can be undefined (is not set, 1 as default)

# concreteDesignSurfaceReinforcement.SetAssignment(additional_offset_to_concrete_cover_top, additional_offset_to_concrete_cover_bottom)

Sets Assignments

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
additional_offset_to_concrete_cover_top Number Additional offset to concrete cover, Top (-z), can be undefined (if not set, top (-z) and 0.0 mm are set)
additional_offset_to_concrete_cover_bottom Number Additional offset to concrete cover, Top (-z), can be undefined (if not set, top (-z) and 0.0 mm are set)

# concreteDesignSurfaceReinforcement.SetReinforcementDirection(reinforcement_direction_type, design_reinforcement_direction, first_direction_point_1, first_direction_point_2, second_direction_point_1, second_direction_point_2)

Sets Reinforcement direction

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
reinforcement_direction_type String Reinforcement direction (IN_DESIGN_REINFORCEMENT_DIRECTION, PARALLEL_TO_TWO_POINTS), can be undefined (is not set, IN_DESIGN_REINFORCEMENT_DIRECTION as default)
design_reinforcement_direction String In reinforcement direction of design (A_S_1, A_S_2), can be undefined (if direction type IN_DESIGN_REINFORCEMENT_DIRECTION and direction of design is not set, A_S_1 as default)
first_direction_point_1 Number Parallel to two points - AX, can be undefined
first_direction_point_2 Number Parallel to two points - AY, can be undefined
second_direction_point_1 Number Parallel to two points - BX, can be undefined
second_direction_point_2 Number Parallel to two points - BY, can be undefined

# concreteDesignSurfaceReinforcement.SetProjection(projection_coordinate_system, projection_plane)

Sets Projection

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
projection_coordinate_system Number Coordination system, can be undefined (is not set, 1 as default - if any)
projection_plane String Projection (XY_OR_UV, YZ_OR_VW, XZ_OR_UW), can be undefined (is ot set, XY_OR_UV as default)

# concreteDesignSurfaceReinforcement.SetReinforcementLocationFreeRectangular(location_rectangle_type, value_1, value_2, value_3, value_4, location_rotation)

Sets Reinforcement location

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
location_rectangle_type String Location rectangle type (CORNER_POINTS, CENTER_AND_SIDES), can be undefined (is not set, CORNER_POINTS as default)
value_1 Number X1 (CORNER_POINTS) / CX (CENTER_AND_SIDES)
value_2 Number Y1 (CORNER_POINTS) / CY (CENTER_AND_SIDES)
value_3 Number X2 (CORNER_POINTS) / center side a (CENTER_AND_SIDES)
value_4 Number Y2 (CORNER_POINTS) / center side b (CENTER_AND_SIDES)
location_rotation Number Rectangle rotation about Z

# concreteDesignSurfaceReinforcement.SetReinforcementActionRegion(acting_region_from, acting_region_to)

Sets Reinforcement action region

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
acting_region_from Number From, can be undefined (is not set, infinity as default)
acting_region_to Number To, can be undefined (is not set, infinity as default)

# concreteDesignSurfaceReinforcement.SetReinforcementLocationFreePolygon(polygon_points)

Sets Reinforcement location

Kind: instance method of ConcreteDesignSurfaceReinforcement

Param Type Description
polygon_points Array Polygon points ([[X1, Y1, (Comment1)], [X2, Y2, (Comment2)], ... [Xn, Yn, (Comment)]]), at least coordinations must be specified

# Functions

SteelDesignBoundaryCondition(no, members_no, member_sets_no, comment, params)

Creates Steel design boundary condition

SteelDesignEffectiveLength(no, members_no, member_sets_no, comment, params)

Creates Steel design effective length

SteelDesignMemberLocalSectionReduction(no, members_no, member_sets_no, comment, params)

Creates Steel design Member local section reduction

# SteelDesignBoundaryCondition(no, members_no, member_sets_no, comment, params)

Creates Steel design boundary condition

Kind: global function

Param Type Description
no Number Steel design boundary condition index, can be undefined
members_no Array List of members indexes, can be undefined
member_sets_no Array List of member sets indexes, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignBoundaryCondition.GetNo() ⇒

Kind: instance method of SteelDesignBoundaryCondition
Returns: Steel design boundary condition number

# steelDesignBoundaryCondition.GetBoundaryCondition() ⇒

Kind: instance method of SteelDesignBoundaryCondition
Returns: Boundary condition internal object

# steelDesignBoundaryCondition.SetName(name)

Sets name

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
name String Name, can be undefined (when undefined, generated name is used)

# steelDesignBoundaryCondition.SetNodalSupportsStartWithSupportType(support_type)

Sets Nodal supports for start node sequence

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
support_type String Support type (NONE, FIXED_IN_Y, TORSION, FIXED_IN_Y_AND_TORSION, FIXED_IN_Y_AND_WARPING, TORSION_AND_WARPING, FIXED_IN_Y_AND_TORSION_AND_WARPING, FIXED_ALL), can be undefined (FIXED_IN_Y_AND_TORSION as default)

# steelDesignBoundaryCondition.SetNodalSupportsEndWithSupportType(support_type)

Sets Nodal supports for end node sequence

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
support_type String Support type (NONE, FIXED_IN_Y, TORSION, FIXED_IN_Y_AND_TORSION, FIXED_IN_Y_AND_WARPING, TORSION_AND_WARPING, FIXED_IN_Y_AND_TORSION_AND_WARPING, FIXED_ALL), can be undefined (FIXED_IN_Y_AND_TORSION as default)

# steelDesignBoundaryCondition.SetNodalSupportsStartWithIndividuallySupportType(support_in_y, restraint_about_x, restraint_about_z, restraint_warping)

Sets individually values for start node sequence

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
support_in_y Boolean Support in y', can be undefined (is not set, false as default)
restraint_about_x Boolean Restraint about x', can be undefined (is not set, false as default)
restraint_about_z Boolean Restraint about z', can be undefined (is not set, false as default)
restraint_warping Boolean Warping, can be undefined (is not set, false as default)

# steelDesignBoundaryCondition.SetNodalSupportsEndWithIndividuallySupportType(support_in_y, restraint_about_x, restraint_about_z, restraint_warping)

Sets individually values for end node sequence

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
support_in_y Boolean Support in y', can be undefined (is not set, false as default)
restraint_about_x Boolean Restraint about x', can be undefined (is not set, false as default)
restraint_about_z Boolean Restraint about z', can be undefined (is not set, false as default)
restraint_warping Boolean Warping, can be undefined (is not set, false as default)

# steelDesignBoundaryCondition.InsertNodalSupportIntermediateNode(support_in_y, restraint_about_x, restraint_about_z, restraint_warping)

Inserts Nodal support intermediate node

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
support_in_y Boolean Support in y', can be undefined (is not set, false as default)
restraint_about_x Boolean Restraint about x', can be undefined (is not set, false as default)
restraint_about_z Boolean Restraint about z', can be undefined (is not set, false as default)
restraint_warping Boolean Warping, can be undefined (is not set, false as default)

# steelDesignBoundaryCondition.SetAdditionalParametersForStart(rotation, eccentricity_type_z, eccentricity_x, eccentricity_z)

Sets Additional parameters for start node sequence

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
rotation Number Rotation, can be undefined (is not set, 0.00 as default)
eccentricity_type_z String Type of eccentricity in z-axis (NONE, AT_UPPER_FLANGE, AT_LOWER_FLANGE, USER_VALUE), can be undefined (is not set, USER_VALUE as default)
eccentricity_x Number Eccentricity in x'-axis, can be undefined (is not set, 0.0 as default)
eccentricity_z Number Eccentricity in z'-axis, can be undefined (is not set, 0.0 as default)

# steelDesignBoundaryCondition.SetAdditionalParametersForEnd(rotation, eccentricity_type_z, eccentricity_x, eccentricity_z)

Sets Additional parameters for end node sequence

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
rotation Number Rotation, can be undefined (is not set, 0.00 as default)
eccentricity_type_z String Type of eccentricity in z-axis (NONE, AT_UPPER_FLANGE, AT_LOWER_FLANGE, USER_VALUE), can be undefined (is not set, USER_VALUE as default)
eccentricity_x Number Eccentricity in x'-axis, can be undefined (is not set, 0.0 as default)
eccentricity_z Number Eccentricity in z'-axis, can be undefined (is not set, 0.0 as default)

# steelDesignBoundaryCondition.SetAdditionalParametersForIntermediateRow(row, rotation, eccentricity_type_z, eccentricity_x, eccentricity_z)

Sets Additional parameters for intermediate node

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
row Number Row, first intermediate row begins on index 2
rotation Number Rotation, can be undefined (is not set, 0.00 as default)
eccentricity_type_z String Type of eccentricity in z-axis (NONE, AT_UPPER_FLANGE, AT_LOWER_FLANGE, USER_VALUE), can be undefined (is not set, USER_VALUE as default)
eccentricity_x Number Eccentricity in x'-axis, can be undefined (is not set, 0.0 as default)
eccentricity_z Number Eccentricity in z'-axis, can be undefined (is not set, 0.0 as default)

# steelDesignBoundaryCondition.SetIntermediateNodes(intermediate_nodes)

Sets Intermediate nodes state

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
intermediate_nodes Boolean Intermediate nodes, can be undefined (true as default)

# steelDesignBoundaryCondition.SetDifferentPropertiesForNodalSupports(different_properties_supports)

Sets Different properties state for nodal supports

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
different_properties_supports Boolean Different properties, can be undefined (true as default)

# steelDesignBoundaryCondition.SetMemberHingesForStart(release_in_y, release_about_x, release_about_z, release_warping)

Sets Hinge releases for start node sequence

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
release_in_y Number Release in y, can be undefined (is not set, false as default)
release_about_x Number Release about x, can be undefined (is not set, false as default)
release_about_z Number Release about z, can be undefined (is not set, false as default)
release_warping Number Release of warping, can be undefined (is not set, false as default)

# steelDesignBoundaryCondition.SetMemberHingesForEnd(release_in_y, release_about_x, release_about_z, release_warping)

Sets Hinge releases for end node sequence

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
release_in_y Number Release in y, can be undefined (is not set, false as default)
release_about_x Number Release about x, can be undefined (is not set, false as default)
release_about_z Number Release about z, can be undefined (is not set, false as default)
release_warping Number Release of warping, can be undefined (is not set, false as default)

# steelDesignBoundaryCondition.SetMemberHingeIntermediateNode(row, release_in_y, release_about_x, release_about_z, release_warping)

Sets member hinge intermediate node

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
row Number Row (intermediate node begins on index 2)
release_in_y Number Release in y, can be undefined (is not set, false as default)
release_about_x Number Release about x, can be undefined (is not set, false as default)
release_about_z Number Release about z, can be undefined (is not set, false as default)
release_warping Number Release of warping, can be undefined (is not set, false as default)

# steelDesignBoundaryCondition.SetDifferentPropertiesForMemberHinges(different_properties_hinges)

Sets Different properties state for member hinges

Kind: instance method of SteelDesignBoundaryCondition

Param Type Description
different_properties_hinges Boolean Different properties, can be undefined (true as default)

# steelDesignBoundaryCondition.IsNodalSupportsEndEdit() ⇒

Kind: instance method of SteelDesignBoundaryCondition
Returns: Nodal supports are set correctly

# SteelDesignEffectiveLength(no, members_no, member_sets_no, comment, params)

Creates Steel design effective length

Kind: global function

Param Type Description
no Number Steel design effective length index, can be undefined
members_no Array List of members indexes, can be undefined
member_sets_no Array List of member sets indexes, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignEffectiveLength.GetNo() ⇒

Kind: instance method of SteelDesignEffectiveLength
Returns: Effective length number

# steelDesignEffectiveLength.GetEffectiveLength() ⇒

Kind: instance method of SteelDesignEffectiveLength
Returns: Effective length object

# steelDesignEffectiveLength.SetName(name)

Sets Name

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
name String Name, can be undefined (when undefined, generated name is used)

# steelDesignEffectiveLength.SetDeterminationType(flexural_buckling_about_y, flexural_buckling_about_z, torsional_buckling, lateral_torsional_buckling, determination_mcr)

Sets Determination Type

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
flexural_buckling_about_y Boolean Consider effective lengths for flexural buckling about y/u, can be undefined (if not set, true as default)
flexural_buckling_about_z Boolean Consider effective lengths for flexural buckling about z/v, can be undefined (if not set, true as default)
torsional_buckling Boolean Consider effective lengths for torsional buckling (for all standards except IS, BS and SP ones), can be undefined (if not set, true as default)
lateral_torsional_buckling Boolean Consider effective lengths for lateral-torsional buckling, can be undefined (if not set, true as default)
determination_mcr String Determination of elastic critical moment Mcr (for all standards except SP one), values are different along to current code for standard, can be undefined

# steelDesignEffectiveLength.SetBucklingAxes(principal_section_axes, geometric_section_axes)

Sets Buckling axes

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
principal_section_axes Boolean Principal section axes y/u and z/v, can be undefined (if not set, true as default)
geometric_section_axes Boolean Geometric section axes y and z, can be undefined (if not set, false as default)

# steelDesignEffectiveLength.SetBucklingFactorType(buckling_factor_type)

Sets Buckling factor type

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
buckling_factor_type String Buckling factor type (THEORETICAL, RECOMMENDED), can be undefined (if not set, THEORETICAL as default)

# steelDesignEffectiveLength.SetMemberType(member_type, member_type_yy, member_type_zz)

Sets Member type

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
member_type String Member type (BEAM, CANTILEVER), can be undefined (if not set, BEAM as default)
member_type_yy String Member type y-y (BEAM, CANTILEVER), can be undefined (if not set, BEAM as default)
member_type_zz String Member type z-z (BEAM, CANTILEVER), can be undefined (if not set, BEAM as default)

# steelDesignEffectiveLength.SetEffectiveLengthsAccToStandard(standard_of_effective_lengths)

Sets Effective lengths acc. to standard

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
standard_of_effective_lengths String Standard (AISC_360, AISI_S100), can be undefined (if not set, AISC_360 as default)

# steelDesignEffectiveLength.SetSegmentsRestrainedBothEnds(moment_modification_restrained_segments_as, modification_factor_alpha_restrained_segments_as, slenderness_reduction_restrained_segments_as)

Sets Segments fully or partially restrained at both ends

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
moment_modification_restrained_segments_as String Moment modification factor αm acc. to 5.6.1.1(a) (BASIC_VALUE, ACC_TO_5611_II, ACC_TO_5611_III, EIGENVALUE_METHOD, USER_DEFINED), can be undefined (if not set, BASIC_VALUE as default)
modification_factor_alpha_restrained_segments_as Number User defined αm, can be undefined (if not set, 1.00 as default)
slenderness_reduction_restrained_segments_as String Slenderness reduction factor αs acc. to Eq. 5.6.1.1(2) (ACC_TO_5611, EIGENVALUE_METHOD), can be undefined (if not set, ACC_TO_5611 as default)

# steelDesignEffectiveLength.SetSegmentsUnrestrainedOneEnd(moment_modification_unrestrained_segments_as, modification_factor_alpha_unrestrained_segments_as, slenderness_reduction_unrestrained_segments_as)

Sets Segments unrestrained at one end

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
moment_modification_unrestrained_segments_as String Moment modification factor αm acc. to 5.6.1.1(a) (BASIC_VALUE, ACC_TO_5611_II, USER_DEFINED), can be undefined (if not set, BASIC_VALUE as default)
modification_factor_alpha_unrestrained_segments_as Number User defined αm, can be undefined (if not set, 1.00 as default)
slenderness_reduction_unrestrained_segments_as String Slenderness reduction factor αs acc. to 5.6.2 (ACC_TO_5611, EIGENVALUE_METHOD), can be undefined (if not set, ACC_TO_5611 as default)

# steelDesignEffectiveLength.SetModificationFactor(modification_factor_cb_aisi, modification_factor_cb_aisi_user_defined_value)

Sets Modification factor Cb/ω2 (only for CSA/AISI S100, NBR, CSA standards)

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
modification_factor_cb_aisi String Factor type (CB_BASIC_VALUE, AUTOMATICALLY_ACC_TO_EQ_F2112, CB_USER_DEFINED), can be undefined (if not set, CB_BASIC_VALUE as default)
modification_factor_cb_aisi_user_defined_value Number User-defined value, can be undefined (if not set, 1.5 (Cb), 1.0 (ω2) as default)

# steelDesignEffectiveLength.SetNodalSupportsStartWithSupportType(support_type)

Sets Nodal supports type for start sequence node

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
support_type String Support type (NONE, FIXED_IN_Z, FIXED_IN_Y, RESTRAINT_ABOUT_X, FIXED_IN_Z_AND_TORSION, FIXED_IN_Z_Y_AND_TORSION, FIXED_IN_Z_AND_TORSION_AND_WARPING, FIXED_IN_Z_Y_AND_TORSION_AND_WARPING, FIXED_ALL, INDIVIDUALLY), can be undefined (if not set, FIXED_IN_Z_Y_AND_TORSION as default)

# steelDesignEffectiveLength.SetNodalSupportsEndWithSupportType(support_type)

Sets Nodal supports type for end sequence node

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
support_type String Support type (NONE, FIXED_IN_Z, FIXED_IN_Y, RESTRAINT_ABOUT_X, FIXED_IN_Z_AND_TORSION, FIXED_IN_Z_Y_AND_TORSION, FIXED_IN_Z_AND_TORSION_AND_WARPING, FIXED_IN_Z_Y_AND_TORSION_AND_WARPING, FIXED_ALL, INDIVIDUALLY), can be undefined (if not set, FIXED_IN_Z_Y_AND_TORSION as default)

# steelDesignEffectiveLength.SetNodalSupportsStartWithIndividuallySupportType(support_in_y, support_in_z, restraint_about_x, restraint_about_z, restraint_warping)

Sets Nodal supports individually values for start sequence node

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
support_in_y Boolean Fixed support in y/u, can be undefined (if not set, true as default)
support_in_z Boolean Fixed support in z/v, can be undefined (if not set, true as default)
restraint_about_x Boolean Restraint about x, can be undefined (if not set, true as default)
restraint_about_z Boolean Restraint about z, can be undefined (if not set, false as default)
restraint_warping Boolean Warping ω, can be undefined (if not set, false as default)

# steelDesignEffectiveLength.SetNodalSupportsEndWithIndividuallySupportType(support_in_y, support_in_z, restraint_about_x, restraint_about_z, restraint_warping)

Sets Nodal supports individually values for end sequence node

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
support_in_y Boolean Fixed support in y/u, can be undefined (if not set, true as default)
support_in_z Boolean Fixed support in z/v, can be undefined (if not set, true as default)
restraint_about_x Boolean Restraint about x, can be undefined (if not set, true as default)
restraint_about_z Boolean Restraint about z, can be undefined (if not set, false as default)
restraint_warping Boolean Warping ω, can be undefined (if not set, false as default)

# steelDesignEffectiveLength.InsertNodalSupportIntermediateNodeWithSupportType(support_type)

Inserts Intermediate node with support type

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
support_type String Support type (NONE, FIXED_IN_Z, FIXED_IN_Y, RESTRAINT_ABOUT_X, FIXED_IN_Z_AND_TORSION, FIXED_IN_Z_Y_AND_TORSION, FIXED_IN_Z_AND_TORSION_AND_WARPING, FIXED_IN_Z_Y_AND_TORSION_AND_WARPING, FIXED_ALL, INDIVIDUALLY), can be undefined (if not set, FIXED_IN_Z_Y_AND_TORSION as default)

# steelDesignEffectiveLength.InsertNodalIndividuallySupportIntermediateNode(support_in_y, support_in_z, restraint_about_x, restraint_about_z, restraint_warping)

Insert Intermediate node with individually support values

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
support_in_y Boolean Fixed support in y/u, can be undefined (if not set, true as default)
support_in_z Boolean Fixed support in z/v, can be undefined (if not set, true as default)
restraint_about_x Boolean Restraint about x, can be undefined (if not set, true as default)
restraint_about_z Boolean Restraint about z, can be undefined (if not set, false as default)
restraint_warping Boolean Warping ω, can be undefined (if not set, false as default)

# steelDesignEffectiveLength.SetDifferentPropertiesForNodalSupports(different_properties)

Sets Different properties state for nodal supports

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
different_properties Boolean Different properties, can be undefined (true as default)

# steelDesignEffectiveLength.SetEffectiveLengthFactors(row, flexural_buckling_u, flexural_buckling_v, flexural_buckling_y, flexural_buckling_z, torsional_buckling, lateral_torsional_buckling, critical_moment, lateral_torsional_buckling_top, lateral_torsional_buckling_bottom)

Sets Effective length factors for segment sequence

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
row Number Segment sequence row
flexural_buckling_u Number Principal axes u, can be undefined (1.00 as default if it's enabled)
flexural_buckling_v Number Principal axes v, can be undefined (1.00 as default if it's enabled)
flexural_buckling_y Number Geometrical axes y, can be undefined (1.00 as default if it's enabled)
flexural_buckling_z Number Geometrical axes z, can be undefined (1.00 as default if it's enabled)
torsional_buckling Number Torsional, can be undefined (1.00 as default if it's enabled)
lateral_torsional_buckling Number Lateral-torsional buckling, can be undefined (1.00 as default if it's enabled)
critical_moment Number Critical moment, can be undefined (1.00 as default if it's enabled)
lateral_torsional_buckling_top Number Lateral-torsional buckling top, can be undefined (1.00 as default if it's enabled)
lateral_torsional_buckling_bottom Number Lateral-torsional buckling bottom, can be undefined (1.00 as default if it's enabled)

# steelDesignEffectiveLength.SetOverwriteEffectiveLengths(row, flexural_buckling_u, flexural_buckling_v, flexural_buckling_y, flexural_buckling_z, torsional_buckling, lateral_torsional_buckling, critical_moment, lateral_torsional_buckling_top, lateral_torsional_buckling_bottom)

Sets Overwrite effective length for segment sequence

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
row Number Segment sequence row
flexural_buckling_u Number Principal axes u, can be undefined (1.00 as default if it's enabled)
flexural_buckling_v Number Principal axes v, can be undefined (1.00 as default if it's enabled)
flexural_buckling_y Number Geometrical axes y, can be undefined (1.00 as default if it's enabled)
flexural_buckling_z Number Geometrical axes z, can be undefined (1.00 as default if it's enabled)
torsional_buckling Number Torsional, can be undefined (1.00 as default if it's enabled)
lateral_torsional_buckling Number Lateral-torsional buckling, can be undefined (1.00 as default if it's enabled)
critical_moment Number Critical moment, can be undefined (1.00 as default if it's enabled)
lateral_torsional_buckling_top Number Lateral-torsional buckling top, can be undefined (1.00 as default if it's enabled)
lateral_torsional_buckling_bottom Number Lateral-torsional buckling bottom, can be undefined (1.00 as default if it's enabled)

# steelDesignEffectiveLength.SetEccentricity(row, eccentricity_type, eccentricity_ez)

Sets Eccentricity

Kind: instance method of SteelDesignEffectiveLength

Param Type Description
row Number Segment sequence row
eccentricity_type String Eccentricity type (NONE, AT_UPPER_FLANGE, AT_LOWER_FLANGE, USER_VALUE), can be undefined (if not set, NONE as default)
eccentricity_ez Number User-defined eccentricity value

# SteelDesignMemberLocalSectionReduction(no, members_no, member_sets_no, comment, params)

Creates Steel design Member local section reduction

Kind: global function

Param Type Description
no Number Steel design member local section reduction index, can be undefined
members_no Array List of members indexes, can be undefined
member_sets_no Array List of member sets indexes, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# steelDesignMemberLocalSectionReduction.GetNo() ⇒

Kind: instance method of SteelDesignMemberLocalSectionReduction
Returns: Member local section reduction number

# steelDesignMemberLocalSectionReduction.GetMemberLocalSectionReduction() ⇒

Kind: instance method of SteelDesignMemberLocalSectionReduction
Returns: Member local section reduction object

# steelDesignMemberLocalSectionReduction.SetName(name)

Sets Name

Kind: instance method of SteelDesignMemberLocalSectionReduction

Param Type Description
name String Name, can be undefined (when undefined, generated name is used)

# steelDesignMemberLocalSectionReduction.AddReductionType(reduction_type, position, multiple)

Adds reduction type and location

Kind: instance method of SteelDesignMemberLocalSectionReduction

Param Type Description
reduction_type String Reduction type (DESIGN_PARAMETERS, SECTION_VALUES), can be undefined (DESIGN_PARAMETERS as default)
position Number Position
multiple Boolean Multiple, can be undefined (false as default)

# steelDesignMemberLocalSectionReduction.SetDesignParameters(row, definition_type, reduction_area)

Sets Design parameters

Kind: instance method of SteelDesignMemberLocalSectionReduction

Param Type Description
row Number Row
definition_type String Definition type (ABSOLUTE, RELATIVE), can be undefined (ABSOLUTE as default)
reduction_area Number Area of reduction

# steelDesignMemberLocalSectionReduction.SetSectionValues(row, definition_type, sectional_area, shear_area_y, shear_area_z, moment_of_inertia_y, moment_of_inertia_z, torsional_constant)

Sets Section values

Kind: instance method of SteelDesignMemberLocalSectionReduction

Param Type Description
row Number Row
definition_type String Definition type (ABSOLUTE, RELATIVE), can be undefined (ABSOLUTE as default)
sectional_area Number Net sectional area / Sectional area factor, can be undefined (is not set, 0.1 / 100 as default)
shear_area_y Number Net shear area y / Shear area y factor, can be undefined (is not set, 0.1 / 100 as default)
shear_area_z Number Net shear area z / Shear area z factor, can be undefined (is not set, 0.1 / 100 as default)
moment_of_inertia_y Number Net moment of inertia y / Moment of inertia y factor, can be undefined (is not set, 0.1 / 100 as default)
moment_of_inertia_z Number Net moment of inertia z / Moment of inertia z factor, can be undefined (is not set, 0.1 / 100 as default)
torsional_constant Number Net torsional constant / Torsional constant factor, can be undefined (is not set, 0.1 / 100 as default)

# steelDesignMemberLocalSectionReduction.SetMultipleDefinition(row, multiple_number, multiple_offset_definition_type, multiple_offset)

Sets multiple definition

Kind: instance method of SteelDesignMemberLocalSectionReduction

Param Type Description
row Number Row
multiple_number Number Number, can be undefined (is not set, 2 as default)
multiple_offset_definition_type String Offset definition type (ABSOLUTE, RELATIVE), can be undefined (is not set, ABSOLUTE as default)
multiple_offset Number Offset