Pile
- class itasca.structure.Pile
Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.
- area() float.
Get the cross-section area of the pile element.
- axial_yield() float.
Get the axial tensile yield strength (force units) of the pile element.
- component_id() int.
Get the Pile component id.
- connectivity(component: int) bool.
Get the index of the node with component-ID id in the element. A ValueError exception is raised if no node in that element matches.
- delete() None.
Delete this structural element.
- density() float.
Get the density of this structural element.
- extra(slot: int) any.
Get the Pile extra data in the given slot.
- force() (vec3, vec3).
Get the force at each end of the pile in the element local system.
- force_nodal() (vec3, vec3, vec3, vec3).
Get the generalized nodal force acting at each end in the global system. The end 1 translational and rotational components are given first.
- gap() ((float, float, float, float), (float, float, float, float)).
Get the gap components in normal spring at each end of the pile element. The gap forms a rectangular shape in the pile cross-sectional plane, which is defined by the local yz-axes of the pile element node. The gap consists of four values denoting gap size in the positive and negative y- and z-directions. The components are the positive y-direction, negative y-direction, positive z-direction, and negative z-direction, respectively. The gap is always being tracked, but only affects behavior if the normal coupling spring gap-use flag function. The gap values for end 1 are given first.
- group([slot: str or int]) str.
Get the Pile group name in a given slot.
- group_remove(group_name: str or int[, slot: str or int]) bool.
Remove from the given group from all group slots of the Pile. One argument of type string, giving the group name, is required. The return value is a bool which is True if the group was removed from any slot, otherwise False.
- groups() {slot: group_name}.
Get a dictionary describing which groups this Pile is part of. The keys of the dictionary are the slot names and the values are the group names.
- id() int.
Get the Pile structural element id.
- in_group(group_name: str or int[, slot: str or int]) bool.
Test if the Pile is part of a given group. If the optional argument slot is given, only that slot is searched. Otherwise, all group slots are searched.
- length() float.
Get the length of the pile element.
- load() -> None. () vec3.
Get the uniform applied distributed load acting on the pile element in the local y- and z-directions. The x-component of the return value will always be 0.0.
- local_system() Tens3.
Get local coordinate system of this element as a 3x3 tensor.
- mark() bool.
Get the mark flag on the structural element. The structural element logic may modify this flag during command processing and cycling.
- moi() vec3.
Get the moment of inertia of the pile. This is defined as the moment of inertia with respect to the x-, y-, and z-axes.
- moment() (vec3, vec3).
Get the moment at each end of the pile in the element local system.
- moment_plastic() float.
Get the plastic moment capacity in the pile.
- moment_plastic_y() float.
Get the plastic moment capacity in Y in the pile.
- moment_plastic_z() float.
Get the plastic moment capacity in Z in the pile.
- nodes() tuple of Structural element node objects.
Get a tuple containing the structural element nodes attached to this elemment.
- normal_cohesion() float.
Get the normal coupling spring cohesive strength of the pile element.
- normal_dir() (vec3, vec3).
Get the global direction in which the pile element is being loaded by the coupling normal spring at each end.
- normal_disp() (float, float).
Get the displacement in the coupling normal spring at each end of the pile element. Sign convention for normal spring is positive/negative, indicating separation/overlap.
- normal_friction() float.
Get the normal coupling spring friction angle of the pile element.
- normal_gap() bool.
Get the normal coupling spring gap-use flag. True denotes gap is on, and False value denotes gap is off.
- normal_state() (int, int).
Get the yield state of the coupling normal spring at each end of the pile element. Return values 0, 1 and 2 denotes never yielded, now yielding, or yielded in the past, respectively.
- normal_stiffness() float.
Get the normal coupling spring stiffness of the pile element.
- normal_stress() (float, float).
Get the stress in the coupling normal spring at each end of the pile element. Sign convention for the normal spring is positive/negative, indicating separation/overlap.
- perimeter() float.
Get the exposed perimeter of the pile element.
- poisson() float.
Get the Poisson’s ratio of the pile element.
- pos() vec3.
Get the position vector of the element, defined as the element centroid.
- rockbolt() bool.
Get a boolean flag of the rockbolt. True denotes the rockbolt flag is on, and False denotes the rockbolt flag is off.
- set_area(float) None.
Set the cross-section area of the pile element.
- set_axial_yield(float) None.
Set the axial tensile yield strength (force units) of the pile element.
- set_density(float) None.
Set the density of this structural element.
- set_extra(slot: int, value: any) None.
Set the Pile extra data in the given slot.
- set_group(group_name: str or int[, slot: str or int]) None.
Set the Pile group name in a given slot.
- set_load(vec3) None.
Set the uniform applied distributed load acting on the pile element in the local y- and z-directions. The x-component is ignored on assignment.
- set_mark(bool) None.
Set the mark flag on the structural element. The structural element logic may modify this flag during command processing and cycling.
- set_moi(vec3) None.
Set the moment of inertia of the pile. This is defined as the moment of inertia with respect to the x-, y-, and z-axes.
- set_moment_plastic(float) None.
Set the plastic moment capacity in the pile.
- set_moment_plastic_y(float) None.
Set the plastic moment capacity in Y in the pile.
- set_moment_plastic_z(float) None.
Set the plastic moment capacity in Z in the pile.
- set_normal_cohesion(float) None.
Set the normal coupling spring cohesive strength of the pile element.
- set_normal_friction(float) None.
Set the normal coupling spring friction angle of the pile element.
- set_normal_gap(bool) None.
Set the normal coupling spring gap-use flag. True denotes gap is on, and False value denotes gap is off.
- set_normal_stiffness(float) None.
Set the normal coupling spring stiffness of the pile element.
- set_perimeter(float) None.
Set the exposed perimeter of the pile element.
- set_poisson(float) None.
Set the Poisson’s ratio of the pile element.
- set_rockbolt(bool) None.
Set a boolean flag of the rockbolt. True denotes the rockbolt flag is on, and False denotes the rockbolt flag is off.
- set_shear_cohesion(float) None.
Set the shear coupling spring cohesive strength of the pile element.
- set_shear_flag(bool) None.
Set the shear direction incremental confining stress flag. True denotes the flag is on, False denotes the flag is off.
- set_shear_friction(float) None.
Set the shear coupling spring friction angle of the pile element.
- set_shear_stiffness(float) None.
Set the shear coupling spring stiffness of the pile element.
- set_slide(bool) None.
Set a boolean flag of slide. True denotes the slide flag is on, and False denotes the slide flag is off.
- set_slide_tol() float.
Set the large-strain sliding tolerance of the pile element.
- set_strain_failure(float) None.
Set the tensile failure strain (non-dimensional) of the pile element.
- set_table_cohesion(str) None.
Set the shear direction cohesion strength table name for the pile element.
- set_table_factor(str) None.
Set the shear direction friction table name for the pile element.
- set_table_friction(str) None.
Set the shear direction incremental confining stress factor table name for the pile element.
- set_thermal_expansion(float) None.
Set the thermal-expansion coefficient for the structural element.
- set_young(float) None.
Set the Youngs modulus of the pile element.
- shear_cohesion() float.
Get the shear coupling spring cohesive strength of the pile element.
- shear_dir() (vec3, vec3).
Get the global direction in which the pile element is being loaded by the coupling shear spring at each end.
- shear_disp() (vec3, vec3).
Get the displacement in coupling shear spring at each end of the pile element. Sign convention for shear spring is positive/negative with respect to the average axial direction of pile.
- shear_flag() bool.
Get the shear direction incremental confining stress flag. True denotes the flag is on, False denotes the flag is off.
- shear_friction() float.
Get the shear coupling spring friction angle of the pile element.
- shear_state() None.
Get the yield state of the coupling shear spring at each end of the pile element. Return a values of 0, 1 and 2 denote never yielded, now yielding, or yielded in the past, respectively.
- shear_stiffness() float.
Get the shear coupling spring stiffness of the pile element.
- shear_stress() (float, float).
Get the stress in coupling shear spring at each end of the pile element. Sign convention for shear spring is positive/negative with respect to the average axial direction of pile.
- slide() bool.
Get a boolean flag of slide. True denotes the slide flag is on, and False denotes the slide flag is off.
- slide_tol() float.
Get the large-strain sliding tolerance of the pile element.
- strain_failure() float.
Get the tensile failure strain (non-dimensional) of the pile element.
- stress_confining() (float, float).
Get the confining stress at each end of the pile element. (Negative value is compression.) Stress acts in a plane perpendicular to the pile axis; confining stress is the average of the principal values in this plane.
- table_cohesion() str.
Get the shear direction cohesion strength table name for the pile element.
- table_factor() str.
Get the shear direction friction table name for the pile element.
- table_friction() str.
Get the shear direction incremental confining stress factor table name for the pile element.
- thermal_expansion() float.
Get the thermal-expansion coefficient for the structural element.
- valid() bool.
Returns True if this Pile is live.
- volume() float.
Get the volume of the pile element.
- ydir() vec3.
Get the y-axis of the pile element local system.
- young() float.
Get the Youngs modulus of the pile element.
Was this helpful? ... | Itasca Software © 2024, Itasca | Updated: Aug 13, 2024 |