# Load Cases And Combinations
Go to [source] (opens new window)
# CombinationWizard
# CombinationWizard(no, name, static_analysis_settings, stability_analysis_setting, consider_imperfection_case, generate_same_CO_without_IC, initial_state_case, initial_state_definition_type, structure_modification, user_defined_action_combinations, favorable_permanent_actions, reduce_number_of_generated_combinations, comment, params, model)
Parameters
no (int) – Combination Wizard Tag
name (int) – User-Defined Name
static_analysis_settings (int) – Assign Static Analysis Settings
stability_analysis_setting (int) – Assign Stability Analysis Setting
consider_imperfection_case (bool) – Enable/disable Imperfection Case
generate_same_CO_without_IC (bool) – Enable/disable Generate same CO without IC
initial_state_case (int) – Assign Initial State Case
initial_state_definition_type (enum) – Initial State Defintion Type Enumeration
structure_modification (int) – Structure Modification to be considered
user_defined_action_combinations (bool) – Enable/disable User defined Combinations
favorable_permanent_actions (bool) – Enable/diable Favourable Permanent Actions
reduce_number_of_generated_combinations (bool) – Enable/disable Reduce Number of Generated Combinations
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# CombinationWizard.SetResultCombination(o, name, stability_analysis_setting, consider_imperfection_case, generate_same_CO_without_IC, user_defined_action_combinations, favorable_permanent_actions, generate_subcombinations_of_type_superposition, comment, params, model)
Parameters
no (int) – Combination Wizard Tag
name (int) – User-Defined Name
stability_analysis_setting (int) – Assign Stability Analysis Setting
consider_imperfection_case (bool) – Enable/disable Imperfection Case
generate_same_CO_without_IC (bool) – Enable/disable Generate same CO without IC
user_defined_action_combinations (bool) – Enable/disable User defined Combinations
favorable_permanent_actions (bool) – Enable/diable Favourable Permanent Actions
generate_subcombinations_of_type_superposition (bool) – Enable/disable Subcombinations of Type Superposition
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# DesignSituation
# DesignSituation(no, design_situation_type, active, name, comment, params, model)
Parameters
no (int) – Design Situation Tag
design_situation_type (enum) – Design Situation Type Enumeration
active (bool) – Enable/Disable Design Situation Activity
name (str, optional) – User-Defined Name
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# LoadCase
# LoadCase(no, name, self_weight, action_category, imperfection_case, structure_modification, comment, params, model)
Parameters
no (int) – Load Case Tag
name (str) – Load Case Name
self_weight (list) – Self-Weight Parameters
self_weight = [self_weight_active, self_weight_factor_x, self_weight_factor_y, self_weight_factor_z]
action_category (enum) – Action Category Enumeration
imperfection_case (int, optional) – Assign Imperfection Case
structure_modification (int, optional) – Assign Structure Modification
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# LoadCase.StaticAnalysis(no, name, to_solve, analysis_settings_no, action_category, self_weight, imperfection_case, structure_modification, comment, params, model)
Parameters
no (int) – Load Case Tag
name (str) – Load Case Name
to_solve (bool) – Enable/Disbale Load Case Solver Status
analysis_settings_no (int) – Analysis Settings Number
action_category (enum) – Action Category Enumeration
self_weight (list) – Self-weight Considerations
- for self-weight considerations;
self_weight = [True, self_weight_factor_x, self_weight_factor_y, self_weight_factor_z]
- for no self-weight considerations;
self_weight = [False]
- for self-weight considerations;
imperfection_case (int, optional) – Assign Imperfection Case
structure_modification (int, optional) – Assign Structure Modification
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# LoadCasesAndCombinations
# LoadCasesAndCombinations(params, model)
Parameters
params (dict, optional): Combination Wizard Parameters
params = {"current_standard_for_combination_wizard": 6207 (opens new window), "activate_combination_wizard_and_classification": True, "activate_combination_wizard": True, "result_combinations_active": False, "result_combinations_parentheses_active": False, "result_combinations_consider_sub_results": False, "combination_name_according_to_action_category": False}
model (RSTAB Class, optional) – Model to be edited
# LoadCasesAndCombinations.getAvailableLoadActionCategoryTypes(model)
Parameters
- model (RSTAB Class, optional) – Model to be read
# LoadCombination
# LoadCombination(no, analysis_type, design_situation, name, static_analysis_settings, consider_imperfection, consider_initial_state, structure_modification, to_solve, combination_items, comment, params, model)
Parameters
no (int) – Load Combination Tag
analysis_type (enum) – Analysis Type Enumeration
design_situation (int) – Design Situation
name (str) – User defined Combination Name
static_analysis_settings (int) – Static Analysis Settings Number
consider_imperfection (bool) – Consider Imperfection Options
consider_initial_state (bool) – Consider Initial State
structure_modification (bool) – Enable/Disable Structure Modification
to_solve (bool) – Decide to solve
combination_items (list of list) – Combination Items
- for Combination Items;
combination_items = [[factor, load_case, action, is_leading],…]
- for Combination Items;
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# ModalAnalysisSettings
# ModalAnalysisSettings(no, name, number_of_modes_method, number_of_modes, solution_method, find_modes_beyond_frequency, frequency_f, maxmimum_natural_frequency, effective_modal_mass_factor, mass_matrix_type, mass_conversion_type, acting_masses, neglect_masses, comment, params, model)
Parameters
no (int) – Setting Tag
name (str) – Setting Name
number_of_modes_method (enum) – Method for dertermining the number of nodes
number_of_modes (int) – Number of modes
solution_method (enum) – Modal solution method enumeration
find_modes_beyond_frequency (bool) – Find modes beyond frequency
frequency_f (float) – Frequency f (Hz)
maxmimum_natural_frequency (float) – Maximum natural frequency
effective_modal_mass_factor (float) – Effective modal mass factor
mass_matrix_type (enum) – Modal Mass Matrix Type Enumeration
mass_conversion_type (enum) – Modal Mass Conversion Type Enumeration
acting_masses (list) – Acting Masses Directions List
neglect_masses (enum) – Modal Neglect Masses Enumeration
comment (str, optional) – Comment
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# ModalAnalysisSettings.EffectiveMass(no, name, solution_method, effective_modal_mass_factor, mass_matrix_type, mass_conversion_type, acting_masses, neglect_masses, comment, params, model)
Parameters
no (int) – Setting Tag
name (str) – Setting Name
solution_method (enum) – Modal solution method enumeration
effective_modal_mass_factor (float) – Effective modal mass factor
mass_matrix_type (enum) – Modal Mass Matrix Type Enumeration
mass_conversion_type (enum) – Modal Mass Conversion Type Enumeration
acting_masses (list) – Acting Masses Directions List
neglect_masses (enum) – Modal Neglect Masses Enumeration
comment (str, optional) – Comment
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# ModalAnalysisSettings.MaximumFrequency(no, name, solution_method, find_modes_beyond_frequency, frequency_f, maxmimum_natural_frequency, mass_matrix_type, mass_conversion_type, acting_masses, neglect_masses, comment, params, model)
Parameters
no (int) – Setting Tag
name (str) – Setting Name
solution_method (enum) – Modal solution method enumeration
find_modes_beyond_frequency (bool) – Find modes beyond frequency
frequency_f (float) – Frequency f (Hz)
maxmimum_natural_frequency (float) – Maximum natural frequency
mass_matrix_type (enum) – Modal Mass Matrix Type Enumeration
mass_conversion_type (enum) – Modal Mass Conversion Type Enumeration
acting_masses (list) – Acting Masses Directions List
neglect_masses (enum) – Modal Neglect Masses Enumeration
comment (str, optional) – Comment
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# ModalAnalysisSettings.UserDefined(no, name, number_of_modes, solution_method, find_modes_beyond_frequency, frequency_f, mass_matrix_type, mass_conversion_type, acting_masses, neglect_masses, comment, params, model)
Parameters
no (int) – Setting Tag
name (str) – Setting Name
number_of_modes (int) – Number of modes
solution_method (enum) – Modal solution method enumeration
find_modes_beyond_frequency (bool) – Find modes beyond frequency
frequency_f (float) – Frequency f (Hz)
mass_matrix_type (enum) – Modal Mass Matrix Type Enumeration
mass_conversion_type (enum) – Modal Mass Conversion Type Enumeration
acting_masses (list) – Acting Masses Directions List
neglect_masses (enum) – Modal Neglect Masses Enumeration
comment (str, optional) – Comment
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# ResultCombination
# ResultCombination(no, comment, params, model)
Parameters
no (int) – Result Combination Tag
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# SpectralAnalysisSettings
# SpectralAnalysisSettings(no, name, periodic_combination, directional_combination, equivalent_linear_combination, save_mode_results, signed_dominant_mode_results, directional_component_scale_value, damping_for_cqc_rule, constant_d_for_each_mode, comment, params, model)
Parameters
no (int) – Sprectral Analysis Settings Tag
name (str) – Sprectral Analysis Settings Name
periodic_combination (enum) – Periodic Combination Rule Enumeration
directional_combination (enum) – Directional Component Combination Rule Enumeration
equivalent_linear_combination (bool) – Equivalent Linear Combination Boolean
save_mode_results (bool) – Save Mode Results Boolean
signed_dominant_mode_results (bool) – Signed Dominant Mode Results Boolean
directional_component_scale_value (float) – Directional Component Scale Value
damping_for_cqc_rule (enum) – Cqs Damping Rule Enumeration
constant_d_for_each_mode (float) – Constant d for Each Mode
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# StabilityAnalysisSettings
# StabilityAnalysisSettings(no, name, comment, params, model)
Parameters
no (int) – Stability Analysis Setting Tag
name (str) – Stability Analysis Setting Name
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# StabilityAnalysisSettings.EigenvalueMethod(no, name, number_of_lowest_eigenvalues, considered_favored_effect, critical_load_factor, minimum_initial_strain, local_torsional_rotations, eigenvalue_method, matrix_type, comment, params, model)
Parameters
no (int) – Stability Analysis Setting Tag
name (str, optional) – Stability Analysis Setting Name
number_of_lowest_eigenvalues (int) – Number of Lowest Eigenvalues
considered_favored_effect (bool) – Considered Favored Effect
critical_load_factor (int, optional) – Critical Load Factor
- for find_eigenvectors_beyond_critical_load_factor == False:
critical_load_factor = None
- for find_eigenvectors_beyond_critical_load_factor == True:
critical_load_factor = int
- for find_eigenvectors_beyond_critical_load_factor == False:
minimum_initial_strain (optional) – Minimum Initial Strain
- for minimum initial strain application:
minimum_initial_strain != 0 or minimum_initial_strain
- for no minimum initial strain application:
minimum_initial_strain == 0 or minimum_initial_strain is None
- for minimum initial strain application:
local_torsional_rotations (optional) – Local Torsional Rotations
- for no local torsional rotations display:
local_torsional_rotations = None
- for local torsional rotations display:
local_torsional_rotations = double
- for no local torsional rotations display:
eigenvalue_method (enum) – StabilityAnalysisSettings Eigenvalue Method Enumeration
matrix_type (enum) – StabilityAnalysisSettings Matrix Type Enumeration
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# StabilityAnalysisSettings.IncrementalyMethodWithEigenvalue(no, name, number_of_lowest_eigenvalues, considered_favored_effect, critical_load_factor, minimum_initial_strain, local_torsional_rotations, incrementally_increasing_loading, stopping_of_load_increasing, save_results_of_all_increments, eigenvalue_method, matrix_type, comment, params, model)
Parameters
no (int) – Stability Analysis Setting Tag
name (str, optional) – Stability Analysis Setting Name
number_of_lowest_eigenvalues (int) – Number of Lowest Eigenvalues
considered_favored_effect (bool) – Considered Favored Effect
critical_load_factor (int, optional) – Critical Load Factor
- for find_eigenvectors_beyond_critical_load_factor == False:
critical_load_factor = None
- for find_eigenvectors_beyond_critical_load_factor == True:
critical_load_factor = int
- for find_eigenvectors_beyond_critical_load_factor == False:
minimum_initial_strain (optional) – Minimum Initial Strain
- for minimum initial strain application:
minimum_initial_strain != 0 or minimum_initial_strain
- for no minimum initial strain application:
minimum_initial_strain is None
- for minimum initial strain application:
local_torsional_rotations (optional) – Local Torsional Rotations
- for no local torsional rotations display:
local_torsional_rotations = None
- for local torsional rotations display:
local_torsional_rotations = double
- for no local torsional rotations display:
incrementally_increasing_loading (list) – Incrementally Increasing Loading
incrementally_increasing_loading = [initial_load_factor, load_factor_increment, refinement_of_the_last_load_increment, maximum_number_of_load_increments]
stopping_of_load_increasing (list, optional) – Stopping of Load Increasing
- for stopping of load increasing deactivated:
stopping_of_load_increasing = None
- for result u:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_DISPLACEMENT_U, limit_result_displacement, limit_node]
- for result uX:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_DISPLACEMENT_U_X, limit_result_displacement, limit_node]
- for result uY:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_DISPLACEMENT_U_Y, limit_result_displacement, limit_node]
- for result uZ:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_DISPLACEMENT_U_Z, limit_result_displacement, limit_node]
- for result phi:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_ROTATION_PHI, limit_result_rotation, limit_node]
- for result phiX:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_ROTATION_PHI_X, limit_result_rotation, limit_node]
- or result phiY:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_ROTATION_PHI_Y, limit_result_rotation, limit_node]
- for result phiZ:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_ROTATION_PHI_Z, limit_result_rotation, limit_node]
- for stopping of load increasing deactivated:
save_results_of_all_increments (bool, optional) – Save Results of All Increments
eigenvalue_method (enum) – StabilityAnalysisSettings Eigenvalue Method Enumeration
matrix_type (enum) – StabilityAnalysisSettings Matrix Type Enumeration
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# StabilityAnalysisSettings.IncrementalyMethodWithoutEigenvalue(no, name, minimum_initial_strain, local_torsional_rotations, incrementally_increasing_loading, stopping_of_load_increasing, save_results_of_all_increments, comment, params, model)
Parameters
no (int) – Stability Analysis Setting Tag
name (str, optional) – Stability Analysis Setting Name
minimum_initial_strain (optional) – Minimum Initial Strain
- for minimum initial strain application:
minimum_initial_strain != 0 or minimum_initial_strain
- for no minimum initial strain application:
minimum_initial_strain == 0 or minimum_initial_strain is None
- for minimum initial strain application:
local_torsional_rotations (optional) – Local Torsional Rotations
- for no local torsional rotations display:
local_torsional_rotations = None
- for local torsional rotations display:
local_torsional_rotations = double
- for no local torsional rotations display:
incrementally_increasing_loading (list) – Incrementally Increasing Loading
incrementally_increasing_loading = [initial_load_factor, load_factor_increment, refinement_of_the_last_load_increment, maximum_number_of_load_increments]
stopping_of_load_increasing (list, optional) – Stopping of Load Increasing
- for stopping of load increasing deactivated:
stopping_of_load_increasing = None
- for result u:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_DISPLACEMENT_U, limit_result_displacement, limit_node]
- for result uX:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_DISPLACEMENT_U_X, limit_result_displacement, limit_node]
- for result uY:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_DISPLACEMENT_U_Y, limit_result_displacement, limit_node]
- for result uZ:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_DISPLACEMENT_U_Z, limit_result_displacement, limit_node]
- for result phi:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_ROTATION_PHI, limit_result_rotation, limit_node]
- for result phiX:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_ROTATION_PHI_X, limit_result_rotation, limit_node]
- for result phiY:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_ROTATION_PHI_Y, limit_result_rotation, limit_node]
- for result phiZ:
stopping_of_load_increasing = [StabilityAnalysisSettingsStoppingOfLoadIncreasingResult.RESULT_TYPE_ROTATION_PHI_Z, limit_result_rotation, limit_node]
- for stopping of load increasing deactivated:
save_results_of_all_increments (bool, optional) – Save Results of All Increments
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# StaticAnalysisSettings
# StaticAnalysisSettings(no, name, analysis_type, comment, params, model)
Parameters
no (int) – Static Analysis Setting Tag
name (str) – Static Analysis Setting Name
analysis_type (enum) – Analysis Type Enumeration
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# StaticAnalysisSettings.GeometricallyLinear(no, name, load_modification, bourdon_effect, mass_conversion, comment, params, model)
Parameters
no (int) – Static Analysis Setting Tag
name (str) – Static Analysis Setting Name
load_modification (list) – Load Modification Parameters
load_modification = [loading_by_multiplier_factor, multiplier_factor, dividing_results]
mass_conversion (list) – Mass Conversion Parameters
mass_conversion = [mass_conversion_enabled, mass_conversion_factor_in_direction_x, mass_conversion_factor_in_direction_y, mass_conversion_factor_in_direction_z]
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# StaticAnalysisSettings.LargeDeformation(no, name, iterative_method, precision_of_convergence_criteria_for_nonlinear_calculation, max_number_of_iterations, number_of_load_increments, load_modification, bourdon_effect, mass_conversion, comment, params, model)
Parameters
no (int) – Static Analysis Setting Tag
name (str) – Static Analysis Setting Name
iterative_method (enum) – Static Analysis Settings Iterative Method for Non-linear Analysis Enumeration
precision_of_convergence_criteria_for_nonlinear_calculation (float) – Precision of Convergence defaults to 0
max_number_of_iterations (float) – Maximum Number of Iterations
number_of_load_increments (float) – Number of Load Increments
load_modification (list) – Load Modification Parameters
load_modification = [loading_by_multiplier_factor, multiplier_factor, dividing_results]
bourdon_effect (bool) – Bourdon Effect Boolean
mass_conversion (list) – Mass Conversion Parameters
mass_conversion = [mass_conversion_enabled, mass_conversion_factor_in_direction_x, mass_conversion_factor_in_direction_y, mass_conversion_factor_in_direction_z]
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
# StaticAnalysisSettings.SecondOrderPDelta(no, name, max_number_of_iterations, number_of_load_increments, load_modification, precision_of_convergence_criteria_for_nonlinear_calculation, favorable_effect_due_to_tension_in_members, bourdon_effect, internal_forces_to_deformed_structure, mass_conversion, comment, params, model)
Parameters
no (int) – Static Analysis Setting Tag
name (str) – Static Analysis Setting Name
max_number_of_iterations (int) – Maximum Number of Iterations
number_of_load_increments (int) – Number of Load Increments
load_modification (list) – Modify Loading by Multiplier Factor
load_modification = [modify_loading_by_multiplier_factor, loading_multiplier_factor, divide_results_by_loading_factor]
precision_of_convergence_criteria_for_nonlinear_calculation (float) – Precision of Convergence defaults to 0
favorable_effect_due_to_tension_in_members (bool) – Favorable Effect due to Tension In Members Boolean
bourdon_effect (bool) – Bourdon Effect Boolean
internal_forces_to_deformed_structure (list) – Internal Forces to Deformed Structure List
internal_forces_to_deformed_structure = [refer_internal_forces_to_deformed_structure, internal_forces_to_deformed_structure_for_moments, internal_forces_to_deformed_structure_for_normal_forces, internal_forces_to_deformed_structure_for_shear_forces]
mass_conversion (list) – Mass Conversion Parameters
mass_conversion = [mass_conversion_enabled, mass_conversion_factor_in_direction_x, mass_conversion_factor_in_direction_y, mass_conversion_factor_in_direction_z]
comment (str, optional) – Comments
params (dict, optional) – Any WS Parameter relevant to the object and its value in form of a dictionary
model (RSTAB Class, optional) – Model to be edited
← Imperfections Loads →