pytabs.cases package

Submodules

pytabs.cases.case_direct_history_linear module

class pytabs.cases.case_direct_history_linear.CaseDirectHistoryLinear(sap_model: None)[source]

Bases: object

CaseDirectHistoryLinear interface

pytabs.cases.case_direct_history_nonlinear module

class pytabs.cases.case_direct_history_nonlinear.CaseDirectHistoryNonlinear(sap_model: None)[source]

Bases: object

CaseDirectHistoryNonlinear interface

pytabs.cases.case_hyperstatic module

class pytabs.cases.case_hyperstatic.CaseHyperStatic(sap_model: None)[source]

Bases: object

CaseHyperStatic interface

pytabs.cases.case_modal_eigen module

class pytabs.cases.case_modal_eigen.CaseModalEigen(sap_model: None)[source]

Bases: object

CaseModalEigen interface

pytabs.cases.case_modal_history_linear module

class pytabs.cases.case_modal_history_linear.CaseModalHistoryLinear(sap_model: None)[source]

Bases: object

CaseModalHistoryLinear interface

pytabs.cases.case_modal_history_nonlinear module

class pytabs.cases.case_modal_history_nonlinear.CaseModalHistoryNonlinear(sap_model: None)[source]

Bases: object

CaseModalHistoryNonlinear interface

pytabs.cases.case_modal_ritz module

class pytabs.cases.case_modal_ritz.CaseModalRitz(sap_model: None)[source]

Bases: object

CaseModalRitz interface

pytabs.cases.case_response_spectrum module

class pytabs.cases.case_response_spectrum.CaseResponseSpectrum(sap_model: None)[source]

Bases: object

CaseResponseSpectrum interface

pytabs.cases.case_static_linear module

class pytabs.cases.case_static_linear.CaseStaticLinear(sap_model: None)[source]

Bases: object

CaseStaticLinearStaged interface

get_initial_case(name: str) → str[source]

Retrieves the initial condition assumed for the specified load case.

Parameters:

name (str) – name of an existing static linear load case

Returns:

blank, None, or the name of an existing analysis case

Return type:

str

get_loads(name: str) → StaticLinearLoadData[source]

Retrieves the load data for the specified load case.

Parameters:

name (str) – name of an existing static linear load case

Returns:

load data

Return type:

StaticLinearLoadData

set_case(name: str) → None[source]

Initializes a static linear load case.

Parameters:

name (str) – name of an existing or new load case

set_initial_case(name: str, initial_case_name: str) → None[source]

Sets the initial condition for the specified load case.

Parameters:

  • name (str) – name of an existing static linear load case

  • initial_case_name (str) – name of an existing analysis case, can be blank or None

set_loads(name: str, number_loads: int, load_types: list[eLinearStaticCaseLoadType], load_names: list[str], scale_factors: list[float]) → None[source]

Sets the load data for the specified analysis case.

Parameters:

  • name (str) – name of an existing static nonlinear load case

  • number_loads (int) – number of loads assigned to the specified analysis case

  • load_types (list[eLinearStaticCaseLoadType]) – load type; one of eLinearStaticCaseLoadType

  • load_names (list[str]) – for a load this is the name of a defined load pattern, for an acceleration this is UX, UY, UZ, RX, RY or RZ and for a mode this is the mode number.

  • scale_factors (list[float]) – scaling factor for load or mode, or magnitude of an acceleration

pytabs.cases.case_static_nonlinear module

class pytabs.cases.case_static_nonlinear.CaseStaticNonlinear(sap_model: None)[source]

Bases: object

CaseStaticNonlinearStaged interface

set_case(name: str) → None[source]

Initializes a static nonlinear load case.

Parameters:

name (str) – name of an existing or new load case. If this is an existing case, that case is modified; otherwise, a new case is added

set_geometric_nonlinearity(name: str, geometry_nonlinearity_type: eGeometryNonlinearityType) → None[source]

Sets the geometric nonlinearity option for the specified load case.

Parameters:

  • name (str) – name of an existing static nonlinear load case

  • geometry_nonlinearity_type (eGeometryNonlinearityTypes) – one of load case

set_initial_case(name: str, initial_case_name: str) → None[source]

Sets the nonlinear static load case to be considered to contain the initial conditions.

Parameters:

  • name (str) – name of existing nonlinear static load case

  • initial_case_name (str) – name of nonlinear static load case to be considered as the initial conditions

set_load_application(name: str, load_application_control: eLoadApplicationControlType, displacement_control: eDisplacementControlType, displacement: float, displacement_monitor: eDisplacementMonitorType, monitored_dof: eMonitoredDisplacementDoF, point_name: str, generalized_displacement: str) → None[source]

Set load case load application control parameters.

Parameters:

  • name (str) – name of existing nonlinear static load case

  • load_application_control (eLoadApplicationControlType) – load application control method

  • displacement_control (eDisplacementControlType) – displacement control method

  • displacement (float) – monitored displacement magnitude

  • displacement_monitor (eDisplacementMonitorType) – displacement monitor method

  • monitored_dof (eMonitoredDisplacementDoF) – monitored degree of freedom

  • point_name (str) – name of existing point to be monitored

  • generalized_displacement (str) – generalized displacement input (refer ETABS manual)

set_loads(name: str, number_loads: int, load_types: list[eNonlinearStaticCaseLoadType], load_names: list[str], scale_factors: list[float]) → None[source]

Sets the load data for the specified analysis case.

Parameters:

  • name (str) – name of an existing static nonlinear load case

  • number_loads (int) – number of loads assigned to the specified analysis case

  • load_types (list[eNonlinearStaticCaseLoadType]) – load type; one of eNonlinearStaticCaseLoadType

  • load_names (list[str]) – for a load this is the name of a defined load pattern, for an acceleration this is UX, UY, UZ, RX, RY or RZ and for a mode this is the mode number.

  • scale_factors (list[float]) – scaling factor for load or mode, or magnitude of an acceleration

set_mass_source(name: str, mass_source: str) → None[source]

Sets the mass source for the specified analysis case.

Parameters:

  • name (str) – name of an existing static nonlinear load case

  • mass_source (str) – name of an existing mass source

set_modal_case(name: str, modal_case: str) → None[source]

Sets the mass source for the specified analysis case.

Parameters:

  • name (str) – name of an existing static nonlinear load case

  • modal_case (str) – name of an existing modal load case

set_results_saved(name: str, save_multiple_steps: bool, min_saved_steps: int = 10, max_saved_steps: int = 100, save_positive_displacements_only: bool = True) → None[source]

Set results saved settings for specified load case.

Parameters:

  • name (str) – name of an existing static nonlinear load case

  • save_multiple_steps (bool) – if True, save multiple steps, if False save final step only

  • min_saved_steps (int, optional) – minimum number of steps saved per stage, defaults to 10

  • max_saved_steps (int, optional) – maximum number of steps saved per stage, defaults to 100

  • save_positive_displacements_only (bool, optional) – if True save positive displacement increments only, defaults to True

pytabs.cases.case_static_nonlinear_staged module

class pytabs.cases.case_static_nonlinear_staged.CaseStaticNonlinearStaged(sap_model: None)[source]

Bases: object

CaseStaticNonlinearStaged interface

set_case(name: str) → None[source]

Initializes a static nonlinear staged load case.

Parameters:

name (str) – name of an existing or new load case

set_geometric_nonlinearity(name: str, geometry_nonlinearity_type: eGeometryNonlinearityType) → None[source]

Sets the geometric nonlinearity option for the specified load case.

Parameters:

  • name (str) – name of an existing static nonlinear staged load case

  • geometry_nonlinearity_type (eGeometryNonlinearityTypes) – one of load case

set_initial_case(name: str, initial_case_name: str) → None[source]

Sets the nonlinear static load case to be considered to contain the initial conditions.

Parameters:

  • name (str) – name of existing nonlinear static staged load case

  • initial_case_name (str) – name of nonlinear static load case to be considered as the initial conditions

set_mass_source(name: str, mass_source: str) → None[source]

Sets the mass source for the specified analysis case.

Parameters:

  • name (str) – name of an existing static nonlinear staged load case

  • mass_source (str) – name of an existing mass source

set_material_nonlinearity(name: str, time_dependent_materials: bool = True) → None[source]

Sets the status of time dependent material properties for the specified load case.

Parameters:

  • name (str) – name of an existing static nonlinear staged load case

  • time_dependent_materials (bool, optional) – True to enable time dependent materials, defaults to True

set_stage_data(name: str, stage: int, number_operations: int, operation_types: list[eStageOperationType], object_types: list[eStageObjectType], object_names: list[str], ages: list[float], my_types: list[eStageMyType], my_names: list[str], scaling_factors: list[float]) → None[source]

Sets stage data for the specified stage in the specified load case.

Parameters:

  • name (str) – name of an existing static nonlinear staged load case

  • stage (int) – stage in the specified load case for which data is to be set

  • number_operations (int) – number of operations to set for the specified stage

  • operation_types (list[eStageOperationType]) – operation type of each operation

  • object_types (list[eStageObjectType]) – object type associated with each operation

  • object_names (list[str]) – name of the object associated with each operation

  • ages (list[float]) – ages of the added structure at the time it is added, in days (only applies to .ADD operation types)

  • my_types (list[eStageMyType]) – load type or object type for each operation, depending on operation type (refer CSI ETABS API Manual)

  • my_names (list[str]) – load assignment or object name for each operation, depending on operation type (refer CSI ETABS API Manual)

  • scaling_factors (list[float]) – scale factor for the load assigned to the operation (only applies to .LOAD_NEW and .LOAD_ALL operation types)

set_stage_definitions(name: str, number_stages: int, durations: list[float], output_statuses: list[bool], output_names: list[str], comments: list[str]) → None[source]

Sets the stage definition data for the specified load case.

Parameters:

  • name (str) – name of an existing static nonlinear staged load case

  • number_stages (int) – number of stages to be defined for the specified load case

  • durations (list[float]) – duration in days for each stage

  • output_statuses (list[bool]) – True or False, indicating if analysis output is to be saved for each stage

  • output_names (list[str]) – user-specified output name for each stage

  • comments (list[str]) – user comment for each stage, may be a blank string

Module contents