# BasicObjects
# Bar
Kind: global class
# new Bar(no, material_no, layer_no, comment, params)
Creates RSECTION Bar
Param | Type | Description |
---|---|---|
no | Number | Number of Bar, can be undefined |
material_no | Number | Material number |
layer_no | Number | Layer number |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# bar.GetNo() ⇒
Kind: instance method of Bar
Returns: Bar's number
# bar.GetBar() ⇒
Kind: instance method of Bar
Returns: Bar object
# bar.MultiUniform(no, material_no, layer_no, distance_between_i_and_j_type, diameter, offset, number_of_bars, comment, params)
Creates Multi uniform Bar
Kind: instance method of Bar
Param | Type | Description |
---|---|---|
no | Number | Number of Bar, can be undefined |
material_no | Number | Material's number |
layer_no | Number | Number of layer |
distance_between_i_and_j_type | String | Distance between i and j reference type, can be undefined ("REFERENCE_TYPE_L" as default) |
diameter | Number | Bar diameter, can be undefined (12 mm as default) |
offset | Number | Offset, can be undefined (0 by default) |
number_of_bars | Number | Number of Bars, can be undefined (2 as default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# bar.MultiVariable(no, material_no, layer_no, distance_between_i_and_j_type, diameter, offset, number_of_bars, axial_distance_si, axial_distance_sn, axial_distance_sj, comment, params)
Creates Multi variable Bar
Kind: instance method of Bar
Param | Type | Description |
---|---|---|
no | Number | Number of Bar, can be undefined |
material_no | Number | Material's number |
layer_no | Number | Number of layer |
distance_between_i_and_j_type | String | Distance between i and j reference type, can be undefined ("REFERENCE_TYPE_L" as default) |
diameter | Number | Bar diameter, can be undefined (12 mm as default) |
offset | Number | Offset, can be undefined (0 by default) |
number_of_bars | Number | Number of Bars, can be undefined (2 as default) |
axial_distance_si | Number | Axial distance of bars, can be undefined (empty by default) |
axial_distance_sn | Number | Axial distance of bars, can be undefined (100 mm by default) |
axial_distance_sj | Number | Axial distance of bars, can be undefined (50 mm by default) |
comment | Number | Comment, can be undefined |
params | Number | Comment, can be undefined |
# bar.SingleBetweenTwoPoints(no, material_no, layer_no, distance_between_i_and_j_type, diameter, offset, distance_from_type, distance, relative, comment, params)
Creates Single between two points Bar
Kind: instance method of Bar
Param | Type | Description |
---|---|---|
no | Number | Number of Bar, can be undefined |
material_no | Number | Material's number |
layer_no | Number | Number of layer |
distance_between_i_and_j_type | String | Distance between i and j reference type, can be undefined ("REFERENCE_TYPE_L" as default) |
diameter | Number | Bar diameter, can be undefined (12 mm as default) |
offset | Number | Offset, can be undefined (0 by default) |
distance_from_type | Number | Type of distance from - "DISTANCE_FROM_START"or "DISTANCE_FROM_END" |
distance | Number | Distance between point k and Xj-k |
relative | Boolean | Distance Xi-k or Xj-k are specified as relative or absolute, can be undefined (true as default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# bar.SinglePoint(no, material_no, layer_no, diameter, offset_y, offset_z, comment, params)
Creates Single point Bar
Kind: instance method of Bar
Param | Type | Description |
---|---|---|
no | Number | Number of Bar, can be undefined |
material_no | Number | Material's number |
layer_no | Number | Number of layer |
diameter | Number | Bar diameter, can be undefined (12 mm as default) |
offset_y | Number | Offset Y, can be undefined (0 as default) |
offset_z | Number | Offset Z, can be undefined (0 as default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# Line
Kind: global class
# new Line(no, nodes, comment, params)
Creates line
Returns: Created line
Param | Type | Description |
---|---|---|
no | Number | Index of line, can be undefined |
nodes | Array | List of Node indexes |
comment | String | Comment, can be undefined |
params | Object | Line's parameters, can be undefined |
# line.GetNo() ⇒
Function for getting id of line
Kind: instance method of Line
Returns: Returns line no
# line.GetLine() ⇒
Function for getting line object
Kind: instance method of Line
Returns: returns line object
# line.Polyline(no, nodes, comment, params)
Creates polyline
Kind: instance method of Line
Param | Type | Description |
---|---|---|
no | Number | Index of line, can be undefined |
nodes | Array | List of Node indexes |
comment | String | Comment, can be undefined |
params | Object | Line's parameters, can be undefined |
Example
// returns polyline
var line = new line();
line.Polyline(1, [1,2]);
# line.Arc(no, nodes, control_point, arc_parameters, center_of_arc, alpha_adjustement_target, comment, params)
Creates arc line
Kind: instance method of Line
Param | Type | Description |
---|---|---|
no | Number | Index of line, can be undefined |
nodes | Array | List of Node indexes |
control_point | Array | Control point of arc |
arc_parameters | Array | Arc's parameters, can be undefined (only one of three parameter can be set, when arc parameter is set, other parameters (control point) will be recalculated) |
center_of_arc | Array | Center of arc, can be undefined (when center of is set, control point will be recalculated) |
alpha_adjustement_target | Number | Subsequent adjustment of α by displacing node at: 1 - Beginning of arc 2 - Arc control point 3 - End of arc |
comment | String | Comment, can be undefined |
params | Object | Line's parameters, can be undefined |
# line.Circle(no, center_of_circle, circle_radius, normal_point, comment, params)
Creates circle line
Kind: instance method of Line
Param | Type | Description |
---|---|---|
no | Number | Index of line, can be undefined |
center_of_circle | Array | Center point of circle |
circle_radius | Number | Radius of circle, can be undefined |
normal_point | Array | Point of normal ti circle plane, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Line's parameters, can be undefined |
# line.EllipticalArc(no, control_point_1, control_point_2, perimeter_point, elliptical_arc_alpha, elliptical_arc_beta, comment, params)
Creates elliptical arc line
Kind: instance method of Line
Param | Type | Description |
---|---|---|
no | Number | Index of line, can be undefined |
control_point_1 | Array | First control point |
control_point_2 | Array | Second control point |
perimeter_point | Array | Third control point - perimeter |
elliptical_arc_alpha | Number | Arc angle α, can be undefined |
elliptical_arc_beta | Number | Arc angle β, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Line's parameters, can be undefined |
# line.Ellipse(no, nodes, control_point, comment, params)
Creates ellipse line
Kind: instance method of Line
Param | Type | Description |
---|---|---|
no | Number | Index of line, can be undefined |
nodes | Array | Nodes of ellipse |
control_point | Array | Control point |
comment | String | Comment, can be undefined |
params | Object | Line's parameters, can be undefined |
# line.Parabola(no, nodes, control_point, parabola_alpha, comment, params)
Creates parabola line
Kind: instance method of Line
Param | Type | Description |
---|---|---|
no | Number | Index of line, can be undefined |
nodes | Array | Nodes of parabola |
control_point | Array | Control point |
parabola_alpha | Number | Parabola's parameter α |
comment | String | Comment, can be undefined |
params | Object | Line's parameters, can be undefined |
# line.Spline(no, nodes, comment, params)
Creates spline
Kind: instance method of Line
Param | Type | Description |
---|---|---|
no | Number | Index of line, can be undefined |
nodes | Array | Nodes of spline |
comment | String | Comment, can be undefined |
params | Object | Line's parameters, can be undefined |
# line.NURBS(no, nodes, control_points_by_components, nurbs_order, comment, params)
Creates NURBS line
Kind: instance method of Line
Param | Type | Description |
---|---|---|
no | Number | Index of line, can be undefined |
nodes | Array | Nodes of NURBS |
control_points_by_components | Array | Control points |
nurbs_order | Number | Nurbs order, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Line's parameters, can be undefined |
# line.RectangularPolygon(no, center_point, length, width, plane, comment, params) ⇒
Create rectangular polygon
Kind: instance method of Line
Returns: Created rectangular polygon
Param | Type | Description |
---|---|---|
no | int | Number of the line, can be undefined |
center_point | array | Center point by format |
length | number | Length |
width | number | Width |
plane | string | Plane XY, XZ or YZ, can be undefined |
comment | string | Comment for the line, can be undefined |
params | Object | Parameters of the line, can be undefined |
# line.nPolygon(no, control_point, no_edges, radius, rotation_plane, rotation_angle, join, comment, params) ⇒
Creates nPolygon
Kind: instance method of Line
Returns: Created nPolygon
Param | Type | Description |
---|---|---|
no | int | Number of the line, can be undefined |
control_point | array | Control point by format [x, y, z] |
no_edges | number | Number of edges |
radius | number | Radius |
rotation_plane | string | Rotation plane (x-y, x-z), can be undefined (x-y by default) |
rotation_angle | number | Rotation angle |
join | string | Join in one "true" or in separate lines "false" |
comment | string | Comment for the line, can be undefined |
params | Object | Parameters of the line, can be undefined |
# line.Rotation(rotation_values, rotation_type)
Sets line rotation
Kind: instance method of Line
Param | Type | Description |
---|---|---|
rotation_values | Number | Rotation values depends on rotation type: 1 - [β] 2 - [help_node_index, rotation_plane ("x-y" |
rotation_type | Number | Line rotation via: Angle (1), Help node (2), Inside (non-straight line) (3) |
# line.NodesOnLine(values)
Sets nodes on line
Kind: instance method of Line
Param | Type | Description |
---|---|---|
values | Array | Nodes on line values in format [[node_1, reference_1, from_start_1, from_end1_1] ... [node_n, reference_n, from_start_n, from_end_1]] |
# line.Supports(line_support)
Sets line supports
Kind: instance method of Line
Param | Type | Description |
---|---|---|
line_support | Number | Line supports object id |
# line.MeshRefinement(line_mesh_refinement)
Sets line mesh refinement
Kind: instance method of Line
Param | Type | Description |
---|---|---|
line_mesh_refinement | Array | Line mesh refinement object id |
# line.WeldedJoints(values)
Sets line welded joints
Kind: instance method of Line
Param | Type | Description |
---|---|---|
values | Array | Line welded joints values, [[weld1, surface1,1, surface2,1, surface3,1] ... [weldn, surface1n, surface2n, surface3n]] |
# LineSet
Kind: global class
# new LineSet(no, lines, comment, params)
Returns: lineSet
Param | Type | Description |
---|---|---|
no | int | Number of Line Set |
lines | array | List of the number of the lines |
comment | string | Comment for the Line Set |
params | dictionary | Parameters of the Line Set |
# lineSet.ContinuousLines(no, lines, comment, params)
Create Continuous Lines lineSet type
Kind: instance method of LineSet
Param | Type | Description |
---|---|---|
no | int | Number of Line Set |
lines | array | List of the number of the lines |
comment | string | Comment for the Line Set |
params | dictionary | Parameters of the Line Set |
# lineSet.GroupOfLines(no, lines, comment, params)
Create Group of Lines
Kind: instance method of LineSet
Param | Type | Description |
---|---|---|
no | int | Number of Line Set |
lines | array | List of the number of the lines |
comment | string | Comment for the Line Set |
params | dictionary | Parameters of the Line Set |
# Material
Kind: global class
# new Material(no, name, basic_material, comment, params)
Create Material
Param | Type | Description |
---|---|---|
no | Number | Number of Material, can be undefined |
name | String | Name of Material, can be undefined |
basic_material | String | Basic material type, can be undefined (false as default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# material.BasicProperties(modulus_of_elasticity, shear_modulus, definition_type, poisson_ratio, specific_weight, mass_density, thermal_coefficient) ⇒
Sets base material properties
Kind: instance method of Material
Returns: Modified material
Param | Type | Description |
---|---|---|
modulus_of_elasticity | Number | Modulus of elasticity, can be undefined (value specified by default) |
shear_modulus | Number | Shear modulus, can be undefined (value specified by default) |
definition_type | Number | Definition type, can be undefined (value specified by default) |
poisson_ratio | Number | Poisson's ration, can be undefined (value specified by default) |
specific_weight | Number | Specific weight, can be undefined (value specified by default) |
mass_density | Number | Mass density, can be undefined (value specified by default) |
thermal_coefficient | Number | Coefficient of thermal expansion, can be undefined (value specified by default) |
# Member
Kind: global class
# new Member(no, nodes_or_line, comment, params)
Creates member
Returns: Created member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.GetNo() ⇒
Kind: instance method of Member
Returns: Member's number
# member.GetMember() ⇒
Kind: instance method of Member
Returns: Member object
# member.Beam(no, nodes_or_line, section_start, comment, params) ⇒
Creates beam member
Kind: instance method of Member
Returns: Created member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
section_start | Number | Section start. Section end is same as section start by default. To set section end specify distribution type. |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.Rigid(no, nodes_or_line, comment, params) ⇒
Creates rigid member
Kind: instance method of Member
Returns: Created member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.Truss(no, nodes_or_line, section_start, comment, params) ⇒
Creates truss member
Kind: instance method of Member
Returns: Created member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
section_start | Number | Section start. Section end is same as section start by default. To set section end specify distribution type. |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.TrussOnlyN(no, nodes_or_line, section_start, comment, params) ⇒
Creates truss (only N) member
Kind: instance method of Member
Returns: Created member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
section_start | Number | Section start. Section end is same as section start by default. To set section end specify distribution type. |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.Tension(no, nodes_or_line, section_start, comment, params) ⇒
Creates tension member
Kind: instance method of Member
Returns: Created member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
section_start | Number | Section start. Section end is same as section start by default. To set section end specify distribution type. |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.Compression(no, nodes_or_line, section_start, comment, params) ⇒
Creates compression member
Kind: instance method of Member
Returns: Created member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
section_start | Number | Section start. Section end is same as section start by default. To set section end specify distribution type. |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.Buckling(no, nodes_or_line, section_start, comment, params) ⇒
Creates buckling member
Kind: instance method of Member
Returns: Created member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
section_start | Number | Section start. Section end is same as section start by default. To set section end specify distribution type. |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.Cable(no, nodes_or_line, section_start, comment, params) ⇒
Creates cable member
Kind: instance method of Member
Returns: Created member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
section_start | Number | Section start. Section end is same as section start by default. To set section end specify distribution type. |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.SurfaceModel(no, nodes_or_line, section_start, material_no, comment, params) ⇒
Creates surface model member
Kind: instance method of Member
Returns: Created member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
section_start | Number | Section start. Section end is same as section start by default. To set section end specify distribution type. |
material_no | Number | Material number |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.ResultBeam(no, nodes_or_line, section_start, result_beam_integrate_stresses_and_forces, result_beam_parameters, included_objects, excluded_objects, comment, params) ⇒
Create result beam member
Kind: instance method of Member
Returns: Created member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
section_start | Number | Section start. Section end is same as section start by default. To set section end specify distribution type. |
result_beam_integrate_stresses_and_forces | String | Stresses and forces type, can be undefined: INTEGRATE_WITHIN_CUBOID_QUADRATIC INTEGRATE_WITHIN_CUBOID_GENERAL INTEGRATE_WITHIN_CYLINDER INTEGRATE_FROM_LISTED_OBJECT |
result_beam_parameters | Array | Result beam parameters, can be undefined 1 - [Yz] 2 - [Y+, Y-, Z+, Z-] 3 - [R] 4 - undefined |
included_objects | Array | Included surfaces, members and solids, can be undefined ([true, [1, 2], true]: true = all objects, array of indexes = only specified objects) |
excluded_objects | Array | Excluded surfaces, members and solids, can be undefined ([undefined, [1, 2], undefined]: array of indexes = only specified objects) |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.DefinableStiffness(no, nodes_or_line, definable_stiffness, comment, params) ⇒
Create definable stiffness member
Kind: instance method of Member
Returns: Created definable stiffness member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
definable_stiffness | Number | Definable stiffness |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.CouplingRigidRigid(no, nodes_or_line, comment, params) ⇒
Create coupling rigid-rigid member
Kind: instance method of Member
Returns: Created coupling rigid-rigid member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.CouplingRigidHinge(no, nodes_or_line, comment, params) ⇒
Create coupling rigid-hinge member
Kind: instance method of Member
Returns: Created coupling rigid-hinge member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.CouplingHingeRigid(no, nodes_or_line, comment, params) ⇒
Create coupling hinge-rigid member
Kind: instance method of Member
Returns: Created coupling hinge-rigid member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.CouplingHingeHinge(no, nodes_or_line, comment, params) ⇒
Create coupling hinge-hinge member
Kind: instance method of Member
Returns: Created coupling hinge-hinge member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# member.Rib(nodes_or_line, no, section_start, rib_alignment, surface_assignment_autodetect, align_axes, flange_dimensions, surfaces, comment, params) ⇒
Kind: instance method of Member
Returns: object Rib
Param | Type | Description |
---|---|---|
nodes_or_line | Array/Number | List of node indexes or number of line |
no | Number | Index of member, can be undefined |
section_start | Number | Section start. Section end is same as section start by default. To set section end specify distribution type. |
rib_alignment | String | Alignment of rib - "ALIGNMENT_ON_Z_SIDE_NEGATIVE","ALIGNMENT_CENTRIC","ALIGNMENT_ON_Z_SIDE_POSITIVE","ALIGNMENT_USER_DEFINED_VIA_MEMBER_ECCENTRICITY" |
surface_assignment_autodetect | Boolean | |
align_axes | Boolean | |
flange_dimensions | Array | two dimensional array each row could have form [end_ordinate,reference_length_definition_type,reference_length_width,width_minus_y_maximal,width_plus_y_maximal,reference_length,width_minus_y_integrative,width_plus_y_integrative] |
surfaces | Array | |
comment | String | |
params | Object |
# member.NodesOnMember(values)
Sets nodes on member
Kind: instance method of Member
Param | Type | Description |
---|---|---|
values | Array | Nodes on member values in format [[node_1, reference_1, from_start_1, from_end1_1] ... [node_n, reference_n, from_start_n, from_end_1]] |
# member.Hinges(member_start_hinge, member_end_hinge)
Sets member start and/or member end hinges
Kind: instance method of Member
Param | Type | Description |
---|---|---|
member_start_hinge | Number | Member hinge object id at member start, can be undefined |
member_end_hinge | Number | Member hinge object id at member end, can be undefined |
# member.Eccentricities(member_start_eccentricity, member_end_eccentricity)
Sets member start and/or member end eccentricities
Kind: instance method of Member
Param | Type | Description |
---|---|---|
member_start_eccentricity | Number | Member eccentricity object id at member start, can be undefined |
member_end_eccentricity | Number | Member eccentricity object id at member end, can be undefined |
# member.Supports(member_support)
Sets member supports
Kind: instance method of Member
Param | Type | Description |
---|---|---|
member_support | Number | Member supports object id |
# member.Nonlinearity(member_nonlinearity)
Sets member nonlinearity
Kind: instance method of Member
Param | Type | Description |
---|---|---|
member_nonlinearity | Number | Member nonlinearity object id |
# member.ResultIntermediatePoints(member_result_intermediate_point)
Kind: instance method of Member
Param | Type | Description |
---|---|---|
member_result_intermediate_point | Number | member result intermediate point object id |
# member.EndModifications(member_start, member_end)
Sets member start and/or member end extensions
Kind: instance method of Member
Param | Type | Description |
---|---|---|
member_start | Array | Member start values, can be undefined ([Δi, αi,y, αi,z]) |
member_end | Array | Member end values, can be undefined ([Δj, αj,y, αj,z]) |
# member.SectionDistributionUniform()
Sets uniform section distribution
Kind: instance method of Member
# member.SectionDistributionLinear(section_start, section_end, section_alignment)
Sets linear distribution
Kind: instance method of Member
Param | Type | Description |
---|---|---|
section_start | Number | Number of section at start of member |
section_end | Number | Number of section at end of member |
section_alignment | String | section_alignment Section alignment (Top, Centric, Bottom), can be undefined (centric as default) |
# member.SectionDistributionTaperedAtBothSides(section_start, section_internal, section_end, reference_type, section_distance_from_start, section_distance_from_end, section_alignment)
Sets tapered at both sides distribution
Kind: instance method of Member
Param | Type | Description |
---|---|---|
section_start | Number | Number of section at start of member |
section_internal | Number | Number of section at internal point of member (between start and end) |
section_end | Number | Number of section at end of member |
reference_type | String | Reference type (L, XY, XZ), can be undefined |
section_distance_from_start | Array | Member distance ([distance, is_relative]), can be undefined |
section_distance_from_end | Array | Member distance ([distance, is_relative]), can be undefined |
section_alignment | String | Section alignment (Top, Centric, Bottom), can be undefined (top as default) |
# member.SectionDistributionTaperedAtStart(section_start, section_end, reference_type, section_distance_from_start, section_alignment)
Sets tapered at start distribution
Kind: instance method of Member
Param | Type | Description |
---|---|---|
section_start | Number | Number of section at start of member |
section_end | Number | Number of section at end of member |
reference_type | String | Reference type (L, XY, XZ), can be undefined |
section_distance_from_start | Array | Member distance ([distance, is_relative]), can be undefined |
section_alignment | String | Section alignment (Top, Centric, Bottom), can be undefined (top as default) |
# member.SectionDistributionTaperedAtEnd(section_start, section_end, reference_type, section_distance_from_end, section_alignment)
Sets tapered at end distribution
Kind: instance method of Member
Param | Type | Description |
---|---|---|
section_start | Number | Number of section at start of member |
section_end | Number | Number of section at end of member |
reference_type | String | Reference type (L, XY, XZ), can be undefined |
section_distance_from_end | Array | Member distance ([distance, is_relative]), can be undefined |
section_alignment | String | Section alignment (Top, Centric, Bottom), can be undefined (top as default) |
# member.SectionDistributionSaddle(section_start, section_internal, section_end, reference_type, section_distance_from_start, section_alignment)
Sets saddle distribution
Kind: instance method of Member
Param | Type | Description |
---|---|---|
section_start | Number | Number of section at start of member |
section_internal | Number | Number of section at internal point of member (between start and end) |
section_end | Number | Number of section at end of member |
reference_type | String | Reference type (L, XY, XZ), can be undefined |
section_distance_from_start | Array | Member distance ([distance, is_relative]), can be undefined |
section_alignment | String | Section alignment (Top, Centric, Bottom), can be undefined (top as default) |
# member.SectionDistributionOffsetAtBothSides(section_start, section_internal, section_end, reference_type, section_offset_from_start, section_offset_from_end, section_alignment)
Sets offset at both sides distribution
Kind: instance method of Member
Param | Type | Description |
---|---|---|
section_start | Number | Number of section at start of member |
section_internal | Number | Number of section at internal point of member (between start and end) |
section_end | Number | Number of section at end of member |
reference_type | String | Reference type (L, XY, XZ), can be undefined |
section_offset_from_start | Array | Member offset ([distance, is_relative]), can be undefined |
section_offset_from_end | Array | Member offset ([distance, is_relative]), can be undefined |
section_alignment | String | Section alignment (Top, Centric, Bottom), can be undefined (top as default) |
# member.SectionDistributionOffsetAtStart(section_start, section_end, reference_type, section_offset_from_start, section_alignment)
Sets offset at start distribution
Kind: instance method of Member
Param | Type | Description |
---|---|---|
section_start | Number | Number of section at start of member |
section_end | Number | Number of section at end of member |
reference_type | String | Reference type (L, XY, XZ), can be undefined |
section_offset_from_start | Array | Member offset ([distance, is_relative]), can be undefined |
section_alignment | String | Section alignment (Top, Centric, Bottom), can be undefined (top as default) |
# member.SectionDistributionOffsetAtEnd(reference_type, section_offset_from_end, section_alignment)
Sets offset at end distribution
Kind: instance method of Member
Param | Type | Description |
---|---|---|
reference_type | String | Reference type (L, XY, XZ), can be undefined |
section_offset_from_end | Array | Member offset ([distance, is_relative]), can be undefined |
section_alignment | String | Section alignment (Top, Centric, Bottom), can be undefined (top as default) |
# member.GetNo() ⇒
Kind: instance method of Member
Returns: Number of Member
# member.GetMember() ⇒
Kind: instance method of Member
Returns: Member object
# member.SetSteelDesignProperties(enabled)
Enable / disable Design properties for member (Steel design add-on)
Kind: instance method of Member
Param | Type | Description |
---|---|---|
enabled | Boolean | Enable / disable Design properties, can be undefined (true as default) |
# member.SetSteelDesignPropertiesViaParentMemberSet(design_properties_via_parent_member_set)
Sets Via parent member set
Kind: instance method of Member
Param | Type | Description |
---|---|---|
design_properties_via_parent_member_set | Boolean | Via parent member set, can be undefined (true as default) |
# member.SetSteelDesignTypes(steel_effective_lengths_no, steel_boundary_conditions_no, steel_member_local_section_reduction_no)
Sets Steel design types (Steel design add-on)
Kind: instance method of Member
Param | Type | Description |
---|---|---|
steel_effective_lengths_no | Number | Effective length number, can be undefined |
steel_boundary_conditions_no | Number | Boundary condition number, can be undefined |
steel_member_local_section_reduction_no | Number | Member local section reduction number, can be undefined |
# member.SetSteeleDesignConfigurations(member_steel_design_uls_configuration_no, member_steel_design_sls_configuration_no, member_steel_design_fr_configuration_no)
Sets Steel design configurations (Steel design add-on)
Kind: instance method of Member
Param | Type | Description |
---|---|---|
member_steel_design_uls_configuration_no | Number | Ultimate configuration number, can be undefined |
member_steel_design_sls_configuration_no | Number | Serviceability configuration number, can be undefined |
member_steel_design_fr_configuration_no | Number | Fire resistance configuration number, can be undefined |
# member.SetDesignSupport(design_support_on_member_start, design_support_on_member_end)
Sets Design supports
Kind: instance method of Member
Param | Type | Description |
---|---|---|
design_support_on_member_start | Number | Design support at member start, can be undefined |
design_support_on_member_end | Number | Design support at member end, can be undefined |
# member.SetDeflectionAnalysis(deflection_check_direction, deflection_check_displacement_reference, active_z, length_z, precamber_z, active_y, length_y, precamber_y)
Sets Deflection analysis
Kind: instance method of Member
Param | Type | Description |
---|---|---|
deflection_check_direction | String | Check direction (LOCAL_AXIS_Z, LOCAL_AXIS_Y, LOCAL_AXIS_Z_AND_Y, RESULTING_AXIS), can be undefined (LOCAL_AXIS_Z_AND_Y as default) |
deflection_check_displacement_reference | String | Displacement reference (DEFORMED_SEGMENT_ENDS, DEFORMED_UNDEFORMED_SYSTEM), can be undefined (DEFORMED_SEGMENT_ENDS as default) |
active_z | Boolean | Segment in z-axis - active, can be undefined (true as default) |
length_z | Number | Segment in z-axis - length, can be undefined (member length as default) |
precamber_z | Number | Segment in z-axis - precamber, can be undefined (0.0 as default) |
active_y | Boolean | Segment in y-axis - active, can be undefined (true as default) |
length_y | Number | Segment in y-axis - length, can be undefined (member length as default) |
precamber_y | Number | Segment in y-axis - precamber, can be undefined (0.0 as default) |
# MemberSet
Kind: global class
# new MemberSet(no, members, comment, params)
Create Member Set
Returns: memberSet
Param | Type | Description |
---|---|---|
no | int | Number of Member Set |
members | array | List of the number of the members |
comment | string | Comment for the Member Set |
params | dictionary | Parameters of the Member Set |
# memberSet.GetNo() ⇒
Kind: instance method of MemberSet
Returns: Number of member set
# memberSet.GetMemberSet() ⇒
Kind: instance method of MemberSet
Returns: Member set object
# memberSet.SetSteelDesignProperties(enabled)
Enable / disable Design properties for member set (Steel design add-on)
Kind: instance method of MemberSet
Param | Type | Description |
---|---|---|
enabled | Boolean | Enable / disable Design properties, can be undefined (true as default) |
# memberSet.SetSteelDesignTypes(steel_effective_lengths_no, steel_boundary_conditions_no, steel_member_local_section_reduction_no)
Sets Steel design types
Kind: instance method of MemberSet
Param | Type | Description |
---|---|---|
steel_effective_lengths_no | Number | Effective length number, can be undefined |
steel_boundary_conditions_no | Number | Boundary condition number, can be undefined |
steel_member_local_section_reduction_no | Number | Member local section reduction number, can be undefined |
# memberSet.SetSteeleDesignConfigurations(member_steel_design_uls_configuration_no, member_steel_design_sls_configuration_no, member_steel_design_fr_configuration_no)
Sets Steel design configurations (Steel design add-on)
Kind: instance method of MemberSet
Param | Type | Description |
---|---|---|
member_steel_design_uls_configuration_no | Number | Ultimate configuration number, can be undefined |
member_steel_design_sls_configuration_no | Number | Serviceability configuration number, can be undefined |
member_steel_design_fr_configuration_no | Number | Fire resistance configuration number, can be undefined |
# memberSet.ContinuousMembers(no, members, comment, params)
Create Continuous Member memberSet type
Kind: instance method of MemberSet
Param | Type | Description |
---|---|---|
no | int | Number of Member Set |
members | array | List of the number of the members |
comment | string | Comment for the Member Set |
params | dictionary | Parameters of the Member Set |
# memberSet.GroupOfMembers(no, members, comment, params)
Create Group of Member memberSet type
Kind: instance method of MemberSet
Param | Type | Description |
---|---|---|
no | int | Number of Member Set |
members | array | List of the number of the members |
comment | string | Comment for the Member Set |
params | dictionary | Parameters of the Member Set |
# memberSet.SetDesignSupport(design_support_on_member_set_start, design_support_on_member_set_end)
Sets Design supports
Kind: instance method of MemberSet
Param | Type | Description |
---|---|---|
design_support_on_member_set_start | Number | Design support at member start, can be undefined |
design_support_on_member_set_end | Number | Design support at member end, can be undefined |
# memberSet.SetDesignSupportAtInternalNodes()
Sets Design supports at internal nodes (Function takes arguments as design properties numbers)
Kind: instance method of MemberSet
# memberSet.SetDeflectionAnalysis(deflection_check_direction, deflection_check_displacement_reference, segments_in_z_axis, active_y, length_y, precamber_y)
Sets Deflection analysis
Kind: instance method of MemberSet
Param | Type | Description |
---|---|---|
deflection_check_direction | String | Check direction (LOCAL_AXIS_Z, LOCAL_AXIS_Y, LOCAL_AXIS_Z_AND_Y, RESULTING_AXIS), can be undefined (LOCAL_AXIS_Z_AND_Y as default) |
deflection_check_displacement_reference | String | Displacement reference (DEFORMED_SEGMENT_ENDS, DEFORMED_UNDEFORMED_SYSTEM), can be undefined (DEFORMED_SEGMENT_ENDS as default) |
segments_in_z_axis | Array | Segments in z-axis ([[active_1, length_1, precamber_1], ... [active_n, length_n, precamber_n]]), can be undefined |
active_y | Boolean | Segment in y-axis - active, can be undefined (true as default) |
length_y | Number | Segment in y-axis - length, can be undefined (member length as default) |
precamber_y | Number | Segment in y-axis - precamber, can be undefined (0.0 as default) |
# Node
Kind: global class
# new Node(no, coordinate_X, coordinate_Y, coordinate_Z, comment, params)
Create Node
Returns: node
Param | Type | Description |
---|---|---|
no | int | Number of Node |
coordinate_X | number | Coordinate X |
coordinate_Y | number | Coordinate Y |
coordinate_Z | number | Coordinate Z |
comment | string | Comment for the Node |
params | dictionary | Parameters of the Node |
# node.Standard(no, coordinates, coordinate_system_type, comment, params)
Create Standard node
Kind: instance method of Node
Param | Type | Description |
---|---|---|
no | int | Number of Node |
coordinates | array | Coordinate of node in format [x, y, z] |
coordinate_system_type | string | Type of Coordinate System |
comment | string | Comment for the Node |
params | dictionary | Parameters of the Node |
# node.BetweenTwoNodes(no, start_node_no, end_node_no, node_reference, parameters, offset_y, offset_z, comment, params)
Create Node between two nodes
Kind: instance method of Node
Param | Type | Description |
---|---|---|
no | int | Number of Node |
start_node_no | int | Number of start node |
end_node_no | int | Number of end node |
node_reference | string | Node Reference |
parameters | array | List of parameters of node |
offset_y | number | Offset in Y direction |
offset_z | number | Offset in Z direction |
comment | string | Comment for the Node |
params | dictionary | Parameters of the Node |
# node.BetweenTwoPoints(no, start_point, end_point, node_reference, parameters, offset_y, offset_z, comment, params)
Create Node between two points
Kind: instance method of Node
Param | Type | Description |
---|---|---|
no | int | Number of Node |
start_point | array | Coordinate of start point in format [x, y, z] |
end_point | array | Coordinate of end point in format [x, y, z] |
node_reference | string | Node Reference |
parameters | array | List of parameters of node |
offset_y | number | Offset in Y direction |
offset_z | number | Offset in Z direction |
comment | string | Comment for the Node |
params | dictionary | Parameters of the Node |
# node.OnLine(no, line_number, node_reference, parameters, comment, params)
Create Node On Line
Kind: instance method of Node
Param | Type | Description |
---|---|---|
no | int | Number of the Node |
line_number | int | Number of the Line |
node_reference | string | Node Reference |
parameters | array | List of parameters of node |
comment | string | Comment for the Node |
params | dictionary | Parameters of the Node |
# node.OnMember(no, member_number, node_reference, parameters, comment, params)
Create Node on Member
Kind: instance method of Node
Param | Type | Description |
---|---|---|
no | int | Number of the Node |
member_number | int | Number of member |
node_reference | string | Node Reference |
parameters | array | List of parameters of node |
comment | string | Comment for the Node |
params | dictionary | Parameters of the Node |
# Opening
Kind: global class
# new Opening(no, boundary_lines, comment, params)
Create Opening
Returns: opening
Param | Type | Description |
---|---|---|
no | int | Number of Opening |
boundary_lines | array | Boundary lines of the Opening |
comment | string | Comment for the Opening |
params | dictionary | Parameters of the Opening |
# Dimension
Kind: global class
# new Dimension(no, comment, params)
Create RSection Dimensions
Returns: Dimension
Param | Type | Description |
---|---|---|
no | int | Number of Dimension |
comment | string | Comment for the Dimension |
params | dictionary | Parameters of the Dimension |
# ControlPoint
Kind: global class
# new ControlPoint(no, comment, params)
Create RSection Control Point
Returns: control point
Param | Type | Description |
---|---|---|
no | int | Number of Control Point |
comment | string | Comment for the Control Point |
params | dictionary | Parameters of the Control Point |
# RSectionElement
Kind: global class
# new RSectionElement(no, type, comment, params)
Create RSection Element
Returns: Element
Param | Type | Description |
---|---|---|
no | Number | Number of Element, can be undefined |
type | String | Type of Element |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionElement.SingleLine(no, boundary_lines, thickness, shear_thickness, comment, params) ⇒
Creates single line Element
Kind: instance method of RSectionElement
Returns: Element
Param | Type | Description |
---|---|---|
no | Number | Number of Element, can be undefined |
boundary_lines | Array | Boundary lines |
thickness | Number | Thickness, can be undefined (10 mm by default) |
shear_thickness | Number | Shear thickness, can be undefined (not specified by default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionElement.Arc(no, points_of_arc, control_point, thickness, shear_thickness, arc_parameters, arc_center, alpha_adjustment_target, comment, params) ⇒
Creates RSection arc Element
Kind: instance method of RSectionElement
Returns: Element
Param | Type | Description |
---|---|---|
no | Number | Number of Element, can be undefined |
points_of_arc | Array | Points numbers of arc Element |
control_point | Array | Coordinates of control point |
thickness | Number | Thickness, can be undefined (10 mm by default) |
shear_thickness | Number | Shear thickness, can be undefined (not specified by default) |
arc_parameters | Array | Arc parameters, can be undefined |
arc_center | Array | Coordinates of arc center, can be undefined |
alpha_adjustment_target | String | Subsequent adjustment of alpha by displacing point at, can be undefined (Beginning of arc by default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionElement.Circle(no, circle_center, circle_radius, thickness, shear_thickness, comment, params) ⇒
Creates RSection circle Element
Kind: instance method of RSectionElement
Returns: Element
Param | Type | Description |
---|---|---|
no | Number | Number of Element, can be undefined |
circle_center | Array | Coordinates of circle center |
circle_radius | Number | Circle radius |
thickness | Number | Thickness, can be undefined (10 mm by default) |
shear_thickness | Number | Shear thickness, can be undefined (not specified by default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionElement.Ellipse(no, first_point, second_point, control_point, thickness, shear_thickness, comment, params) ⇒
Creates RSection ellipse Element
Kind: instance method of RSectionElement
Returns: Element
Param | Type | Description |
---|---|---|
no | Number | Number of Element, can be undefined |
first_point | Number | Number of first point |
second_point | Number | Number of second point |
control_point | Array | Control point coordinates |
thickness | Number | Thickness, can be undefined (10 mm by default) |
shear_thickness | Number | Shear thickness, can be undefined (not specified by default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionElement.Parabola(no, points_of_parabola, control_point, thickness, shear_thickness, parabola_alpha, comment, params) ⇒
Creates RSection parabola Element
Kind: instance method of RSectionElement
Returns: Element
Param | Type | Description |
---|---|---|
no | Number | Number of Element, can be undefined |
points_of_parabola | Array | Points numbers of parabola |
control_point | Array | Control point |
thickness | Number | Thickness, can be undefined (10 mm by default) |
shear_thickness | Number | Shear thickness, can be undefined (not specified by default) |
parabola_alpha | Number | Angle of the parabola, can be undefined (0 as default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionElement.NURBS(no, control_points, nurbs_order, nurbs_knots, thickness, shear_thickness, comment, params) ⇒
Creates RSection NURBS Element
Kind: instance method of RSectionElement
Returns: Element
Param | Type | Description |
---|---|---|
no | Number | Number of Element, can be undefined |
control_points | Array | Control points ([[y1, z1 (, weight1)], [y2, z2, weight2], ...]) |
nurbs_order | Number | Nurbs order, can be undefine (2 as default) |
nurbs_knots | Array | Nurbs knots, can be undefined |
thickness | Number | Thickness, can be undefined (10 mm by default) |
shear_thickness | Number | Shear thickness, can be undefined (not specified by default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionElement.Thickness(thickness, shear_thickness) ⇒
Sets thickness and/or shear thickness
Kind: instance method of RSectionElement
Returns: Modified Element
Param | Type | Description |
---|---|---|
thickness | Number | Thickness |
shear_thickness | Number | Effective thickness for shear transfer, can be undefined |
# RSectionLine
Kind: global class
# new RSectionLine(no, type, comment, params)
Creates RSection Line
Returns: Line
Param | Type | Description |
---|---|---|
no | Number | Number of Line, can be undefined |
type | String | Type of line |
comment | String | Comment for the Line, can be undefined |
params | Object | Parameters of the Line, can be undefined |
# rSectionLine.GetNo() ⇒
Kind: instance method of RSectionLine
Returns: Line number
# rSectionLine.GetLine() ⇒
Kind: instance method of RSectionLine
Returns: Line object
# rSectionLine.Polyline(no, definition_points, comment, params) ⇒
Creates RSection polyline
Kind: instance method of RSectionLine
Returns: Line
Param | Type | Description |
---|---|---|
no | Number | Number of Line, can be undefined |
definition_points | Array | Definition point numbers |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionLine.Arc(no, points_of_arc, control_point, arc_parameters, arc_center, alpha_adjustment_target, comment, params) ⇒
Creates RSection arc Line
Kind: instance method of RSectionLine
Returns: Line
Param | Type | Description |
---|---|---|
no | Number | Number of Line, can be undefined |
points_of_arc | Array | Points numbers of arc lLne |
control_point | Array | Coordinates of control point |
arc_parameters | Array | Arc parameters [height, radius, alpha], can be undefined |
arc_center | Array | Coordinates of arc center, can be undefined |
alpha_adjustment_target | String | Subsequent adjustment of alpha by displaycing point at, can be undefined (beginning of arc by default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionLine.Circle(no, circle_center, circle_radius, comment, params) ⇒
Creates RSection circle Line
Kind: instance method of RSectionLine
Returns: Line
Param | Type | Description |
---|---|---|
no | Number | Number of Line, can be undefined |
circle_center | Array | Coordinates of circle center [y, z] |
circle_radius | Number | Circle radius |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionLine.Ellipse(no, first_point, second_point, control_point, comment, params) ⇒
Creates RSection ellipse Line
Kind: instance method of RSectionLine
Returns: Line
Param | Type | Description |
---|---|---|
no | Number | Number of Line, can be undefined |
first_point | Number | Number of first point |
second_point | Number | Number of second point |
control_point | Array | Control point coordinates |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionLine.Parabola(no, points_of_parabola, control_point, parabola_alpha, comment, params) ⇒
Creates RSection parabola Line
Kind: instance method of RSectionLine
Returns: Line
Param | Type | Description |
---|---|---|
no | Number | Number of Line, can be undefined |
points_of_parabola | Array | Points numbers of parabola |
control_point | Array | Control point |
parabola_alpha | Number | Angle of the parabola, can be undefined (0 as default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionLine.NURBS(no, definition_points, control_points, nurbs_order, nurbs_knots, comment, params) ⇒
Creates RSection NURBS
Kind: instance method of RSectionLine
Returns: Line
Param | Type | Description |
---|---|---|
no | Number | Number of Line, can be undefined |
definition_points | Array | Definition points |
control_points | Array | Control points [[y1, z1 (, weight1)], [y2, z2, weight2], ...] |
nurbs_order | Number | Nurbs order, can be undefine (2 as default) |
nurbs_knots | Array | Nurbs knots, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionLine.PointsOnLine(points_on_line)
Sets points on line
Kind: instance method of RSectionLine
Param | Type | Description |
---|---|---|
points_on_line | Array | [[distance1, from_start1, reference1, point_no1], [distance2, from_start2, reference2, point_no2], ...] from_start = true => node distance from start, otherwise distance from end reference - "L" by default point_no - empty by default |
# RSectionOpening
Kind: global class
# new RSectionOpening(no, boundary_lines, comment, params)
Creates RSection Opening
Returns: Opening
Param | Type | Description |
---|---|---|
no | int | Number of Opening, can be undefined |
boundary_lines | Array | Boundary lines |
comment | string | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionOpening.Rectangle(no, top_left_corner, width, height, comment, params) ⇒
Creates rectangle Opening
Kind: instance method of RSectionOpening
Returns: Rectangle Opening
Param | Type | Description |
---|---|---|
no | Number | Number of Opening, can be undefined |
top_left_corner | Array | Top let corner specified with y, z coordinates |
width | Number | Width |
height | Number | Height |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionOpening.Triangle(no, first_vertex, second_vertex, third_vertex, comment, params) ⇒
Creates triangle Opening
Kind: instance method of RSectionOpening
Returns: Triangle Opening
Param | Type | Description |
---|---|---|
no | Number | Number of Opening, can be undefined |
first_vertex | Array | First point specified with y, z coordinates |
second_vertex | Array | Second point specified with y, z coordinates |
third_vertex | Array | Third point specified with y, z coordinates |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionOpening.Circle(no, center_vertex, radius, comment, params) ⇒
Creates circle Opening
Kind: instance method of RSectionOpening
Returns: Circle Part
Param | Type | Description |
---|---|---|
no | Number | Number of Opening, can be undefined |
center_vertex | Array | Circle center point |
radius | Number | Circle radius |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionOpening.Polygon(no, vertex_points, comment, params) ⇒
Creates polygon Opening
Kind: instance method of RSectionOpening
Returns: Polygon Opening
Param | Type | Description |
---|---|---|
no | Number | Number of Opening, can be undefined |
vertex_points | Array | Vertex points specified with y, z coordinates |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# RSectionPart
Kind: global class
# new RSectionPart(no, comment, params)
Creates RSection Part
Returns: Part
Param | Type | Description |
---|---|---|
no | int | Number of Part, can be undefined |
comment | string | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionPart.Rectangle(no, top_left_corner, width, height, material, comment, params) ⇒
Creates rectangle Part
Kind: instance method of RSectionPart
Returns: Rectangle Part
Param | Type | Description |
---|---|---|
no | Number | Number of Part, can be undefined |
top_left_corner | Array | Top let corner specified with y, z coordinates |
width | Number | Width |
height | Number | Height |
material | Object | Material |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionPart.Triangle(no, first_vertex, second_vertex, third_vertex, material, comment, params) ⇒
Creates triangle Part
Kind: instance method of RSectionPart
Returns: Triangle Part
Param | Type | Description |
---|---|---|
no | Number | Number of Part, can be undefined |
first_vertex | Array | First point specified with y, z coordinates |
second_vertex | Array | Second point specified with y, z coordinates |
third_vertex | Array | Third point specified with y, z coordinates |
material | Object | Material |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionPart.Circle(no, center_vertex, radius, material, comment, params) ⇒
Creates circle Part
Kind: instance method of RSectionPart
Returns: Circle Part
Param | Type | Description |
---|---|---|
no | Number | Number of Part, can be undefined |
center_vertex | Array | Circle center point |
radius | Number | Circle radius |
material | Object | Material |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionPart.Polygon(no, vertex_points, material, comment, params) ⇒
Creates polygon Part
Kind: instance method of RSectionPart
Returns: Polygon Part
Param | Type | Description |
---|---|---|
no | Number | Number of Part, can be undefined |
vertex_points | Array | Vertex points specified with y, z coordinates |
material | Object | Material |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionPart.WithBoundaryLines(no, boundary_lines, material, comment, params) ⇒
Creates Part with boundary line
Kind: instance method of RSectionPart
Returns: Part
Param | Type | Description |
---|---|---|
no | Number | Number of Part, can be undefined |
boundary_lines | Array | Boundary lines |
material | Object | Material |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionPart.IntegratedObjects(enable, automatic_object_detection, integrated_openings) ⇒
Integrates objects to Part
Kind: instance method of RSectionPart
Returns: Modified Part
Param | Type | Description |
---|---|---|
enable | Boolean | Objects are integrated, can be undefined (true as default) |
automatic_object_detection | Boolean | Objects are integrated automatically, can be undefined (true as default) |
integrated_openings | Array | Integrated openings |
# rSectionPart.No() ⇒
Returns number of Part
Kind: instance method of RSectionPart
Returns: Number of Part
# RSectionPoint
Kind: global class
# new RSectionPoint(no, coordinate_y, coordinate_z, comment, params)
Creates RSection Point
Returns: Point
Param | Type | Description |
---|---|---|
no | Number | Number of Point, can be undefined |
coordinate_y | Number | Coordinate Y |
coordinate_z | Number | Coordinate Z |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionPoint.GetNo() ⇒
Kind: instance method of RSectionPoint
Returns: Point number
# rSectionPoint.GetPoint() ⇒
Kind: instance method of RSectionPoint
Returns: Point object
# rSectionPoint.y()
Returns y coordinate
Kind: instance method of RSectionPoint
# rSectionPoint.z()
Returns z coordinate
Kind: instance method of RSectionPoint
# rSectionPoint.Standard(no, coordinate_y, coordinate_z, reference_point, comment, params) ⇒
Creates standard RSection Point
Kind: instance method of RSectionPoint
Returns: Point
Param | Type | Description |
---|---|---|
no | Number | Number of Point, can be undefined |
coordinate_y | Number | Coordinate Y |
coordinate_z | Number | Coordinate Z |
reference_point | Number | Reference point number, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionPoint.BetweenTwoLocations(no, start_location, end_location, distance_from_start, distance_from_end, distance_from_start_relative, reference_type, offset_in_local_direction, comment, params) ⇒
Creates Between two locations RSection Point
Kind: instance method of RSectionPoint
Returns: Point
Param | Type | Description |
---|---|---|
no | Number | Number of Point, can be undefined |
start_location | Array | Coordinates for start location [y, z] |
end_location | Array | Coordinates for end location [y, z] |
distance_from_start | Number | Distance from start |
distance_from_end | Number | Distance from end |
distance_from_start_relative | Boolean | Distance from start point, can be undefined (True as default) |
reference_type | String | Reference type, distance of start and end location along the length, in Y or Z coordination, can be undefined ("L" by default) |
offset_in_local_direction | Number | Offset in local direction, can be undefined (0 as default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionPoint.BetweenTwoPoints(no, start_point, end_point, distance_from_start, distance_from_end, distance_from_start_relative, reference_type, offset_in_local_direction, comment, params) ⇒
Creates Between two points RSection Point
Kind: instance method of RSectionPoint
Returns: Point
Param | Type | Description |
---|---|---|
no | Number | Number of Point, can be undefined |
start_point | Object | Number of start point |
end_point | Object | Number of end point |
distance_from_start | Number | Distance from start |
distance_from_end | Number | Distance from end |
distance_from_start_relative | Boolean | Distance from start point, can be undefined (True asy default) |
reference_type | String | Reference type, distance of start and end location along the length, in Y or Z coordination, can be undefined ("L" by default) |
offset_in_local_direction | Number | Offset in local direction, can be undefined (0 as default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionPoint.OnLine(no, line, distance_from_start, distance_from_end, distance_from_start_relative, reference_type, comment, params) ⇒
Creates On lines RSection Point
Kind: instance method of RSectionPoint
Returns: Point
Param | Type | Description |
---|---|---|
no | Number | Number of Point, can be undefined |
line | Number | Line number |
distance_from_start | Number | Distance from start |
distance_from_end | Number | Distance from end |
distance_from_start_relative | Boolean | Distance from start point, can be undefined (True as default) |
reference_type | String | Reference type, can be undefined ("L" by default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# Stiffener
Kind: global class
# new Stiffener(no, comment, params)
Create RSection Stiffener
Returns: Stiffener
Param | Type | Description |
---|---|---|
no | int | Number of Stiffener |
comment | string | Comment for the Stiffener |
params | dictionary | Parameters of the Stiffener |
# RSectionStressPoint
Kind: global class
# new RSectionStressPoint(no, comment, params)
Create RSection Stress Points
Returns: Stress point
Param | Type | Description |
---|---|---|
no | Number | Number of Stress point, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionStressPoint.Standard(no, part_no, reference_stress_point_no, non_global_coordinates, global_coordinations, element_no, comment, params) ⇒
Creates Standard Stress point
Kind: instance method of RSectionStressPoint
Returns: Standard Stress point
Param | Type | Description |
---|---|---|
no | Number | Number of Stress point, can be undefined |
part_no | Number | Part number |
reference_stress_point_no | Number | Reference Stress point number, can be undefined |
non_global_coordinates | Array | Coordinates, can be undefined |
global_coordinations | Array | Global coordinates, can be undefined |
element_no | Number | Element number, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionStressPoint.OnLine(no, line_no, distance_points, reference_type, part_no, element_no, comment, params) ⇒
Creates Stress point on line
Kind: instance method of RSectionStressPoint
Returns: Stress point on line
Param | Type | Description |
---|---|---|
no | Number | Number of Stress point, can be undefined |
line_no | Number | Line number |
distance_points | Array | Distance between point and start and end points, [from_start, from_end, relative], from_start or from_end can be undefined (but at least one distance must be specified), relative can be undefined (true as default) |
reference_type | String | Reference type, distance of start and end location along the length, in Y or Z coordination, can be undefined ("L" by default) |
part_no | Number | Part number, van be undefined |
element_no | Number | Element number, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# rSectionStressPoint.OnElement(no, element_no, distance_points, reference_type, element_side, comment, params) ⇒
Creates stress point on element
Kind: instance method of RSectionStressPoint
Returns: Modified Stress point
Param | Type | Description |
---|---|---|
no | Number | Number of Stress point, can be undefined |
element_no | Number | Element number |
distance_points | Array | Distance between point and start and end points, [from_start, from_end, relative], from_start or from_end can be undefined (but at least one distance must be specified), relative can be undefined (true as default) |
reference_type | String | Reference type, distance of start and end location along the length, in Y or Z coordination, can be undefined ("L" by default) |
element_side | String | Element side, can be undefined ("MIDDLE" as default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# Subpanel
Kind: global class
# new Subpanel(no, comment, params)
Create RSection Subpanel
Returns: Subpanel
Param | Type | Description |
---|---|---|
no | int | Number of Subpanel |
comment | string | Comment for the Subpanel |
params | dictionary | Parameters of the Subpanel |
# Section
Kind: global class
# new Section(no, section_name, material_no, comment, params)
Create Section
Returns: Section
Param | Type | Description |
---|---|---|
no | Number | Number of the Section, can be undefined |
section_name | String | Name of the Section, can be undefined (IPE 300 by default) |
material_no | Number | Number of the material |
comment | String | Comment |
params | Object | Parameters |
# section.GetNo() ⇒
Kind: instance method of Section
Returns: Number of Section
# section.SectionType(section_type) ⇒
Sets section type
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
section_type | String | Section type |
# section.ManufacturingType(manufacturing_type) ⇒
Sets manufacturing type
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
manufacturing_type | String | Manufacturing type |
# section.SectionProperties(area_shear_y, area_shear_z, warping, width_temperature_load, depth_temperature_load) ⇒
Sets Section properties
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
area_shear_y | Number | Shear sectional areas, can be undefined |
area_shear_z | Number | Shear sectional areas, can be undefined |
warping | Number | Warping, van be undefined |
width_temperature_load | Number | Width (for non-uniform temperature loads), can be undefined |
depth_temperature_load | Number | Depth (for non-uniform temperature loads), can be undefined |
# section.DeactivateShearStiffness(deactivated) ⇒
Deactivates shear stiffness
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
deactivated | Boolean | Shear stiffness deactivation/activation, can be undefined (true as default) |
# section.Rotation(rotation_angle) ⇒
Sets Section rotation
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
rotation_angle | Number | Rotation angle |
# section.ThinWalledModel(thin_walled_model) ⇒
Sets thin-walled model
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
thin_walled_model | Boolean | Thin-walled model enabling/disabling, can be undefined (true as default) |
# section.UsNotation(us_spelling_of_properties) ⇒
Sets US notation for section properties
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
us_spelling_of_properties | Boolean | US notation enabling/disabling, can be undefined (true as default) |
# section.StressSmoothing(stress_smoothing_to_avoid_singularities) ⇒
Sets stress smoothing to avoid singularities
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
stress_smoothing_to_avoid_singularities | Boolean | Stress smoothing enabling/disabling, can be undefined (true as default) |
# section.DeactivateWarpingStiffness(deactivated) ⇒
Deactivates warping stiffness
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
deactivated | Boolean | Warping stiffness deactivation/activation, can be undefined (true as default). Torsional Warping add-on must be active. |
# section.CostEstimation(cost_estimation) ⇒
Sets cost estimation
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
cost_estimation | Boolean | Cost estimation apply from material enabling/disabling, can be undefined (true as default). Optimization & Costs / CO2 Emission Estimation add-on must be active. |
# section.CostEstimationValues(member_weight, member_volume, member_surface, member_length) ⇒
Sets Cost estimation values
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
member_weight | Number | Member weight, can be undefined. Optimization & Costs / CO2 Emission Estimation add-on must be active. |
member_volume | Number | Member volume, can be undefined. Optimization & Costs / CO2 Emission Estimation add-on must be active. |
member_surface | Number | Member surface, can be undefined. Optimization & Costs / CO2 Emission Estimation add-on must be active. |
member_length | Number | Member length, can be undefined. Optimization & Costs / CO2 Emission Estimation add-on must be active. |
# section.EmissionEstimation(emission_estimation) ⇒
Sets estimation of CO2 emissions
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
emission_estimation | Boolean | Estimation of CO2 emissions enabling/disabling, can be undefined (true as default). Optimization & Costs / CO2 Emission Estimation add-on must be active. |
# section.EmissionEstimationValues(member_weight, member_volume, member_surface, member_length) ⇒
Sets Emission estimation values
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
member_weight | Number | Member weight, can be undefined. Optimization & Costs / CO2 Emission Estimation add-on must be active. |
member_volume | Number | Member volume, can be undefined. Optimization & Costs / CO2 Emission Estimation add-on must be active. |
member_surface | Number | Member surface, can be undefined. Optimization & Costs / CO2 Emission Estimation add-on must be active. |
member_length | Number | Member length, can be undefined. Optimization & Costs / CO2 Emission Estimation add-on must be active. |
# section.Optimization(optimization) ⇒
Sets optimization
Kind: instance method of Section
Returns: Modified Section
Param | Type | Description |
---|---|---|
optimization | Boolean | Optimization enabling/disabling, can be undefined (true as default). Optimization & Costs / CO2 Emission Estimation add-on must be active. |
# Solid
Kind: global class
# new Solid(no, boundary_surfaces, material, comment, params)
Create Solid
Returns: Solid
Param | Type | Description |
---|---|---|
no | int | Number of Solid |
boundary_surfaces | array | List of boundary surfaces |
material | int | Number of material |
comment | string | Comment for the Solid |
params | dictionary | Parameters of the Solid |
# solid.Standard(no, boundary_surfaces, material, comment, params)
Create Standard Solid
Kind: instance method of Solid
Param | Type | Description |
---|---|---|
no | int | Number of Solid |
boundary_surfaces | array | List of boundary surfaces |
material | int | Number of material |
comment | string | Comment for the Solid |
params | dictionary | Parameters of the Solid |
# solid.Gas(no, boundary_surfaces, material, gasssolid_no, comment, params)
Create Gas
Kind: instance method of Solid
Param | Type | Description |
---|---|---|
no | int | Number of Solid |
boundary_surfaces | array | List of boundary surfaces |
material | int | Number of material |
gasssolid_no | int | Gass solid index |
comment | string | Comment for the Solid |
params | dictionary | Parameters of the Solid |
# solid.Contact(no, boundary_surfaces, material, contact_solid_no, first_contact_surface, comment, params)
Create Contact solid
Kind: instance method of Solid
Param | Type | Description |
---|---|---|
no | int | Number of Solid |
boundary_surfaces | array | List of boundary surfaces |
material | int | Number of material |
contact_solid_no | int | Contact solid index |
first_contact_surface | int | Number of first contact surface |
comment | string | Comment for the Solid |
params | dictionary | Parameters of the Solid |
# SolidSet
Kind: global class
# new SolidSet(no, solids_no, solid_set_type, comment, params)
Create Solid Set
Returns: Solid Set
Param | Type | Description |
---|---|---|
no | int | Number of Solid Set |
solids_no | array | List of solids |
solid_set_type | string | Type of the Solid Set |
comment | string | Comment for the Solid Set |
params | dictionary | Parameters of the Solid Set |
# solidSet.ContinuousSolids(no, solids_no, comment, params)
Create Continuous Solids solidSet type
Kind: instance method of SolidSet
Param | Type | Description |
---|---|---|
no | int | Number of Solid Set |
solids_no | array | List of solids |
comment | string | Comment for the Solid Set |
params | dictionary | Parameters of the Solid Set |
# solidSet.GroupOfSolids(no, solids_no, comment, params)
Create Group of Solids
Kind: instance method of SolidSet
Param | Type | Description |
---|---|---|
no | int | Number of Solid Set |
solids_no | array | List of solids |
comment | string | Comment for the Solid Set |
params | dictionary | Parameters of the Solid Set |
# Stirrup
Kind: global class
# new Stirrup(no, cover_points_no, material_no, diameter, diameter_of_curvature, mandrel_diameter_factor, comment, params)
Creates RSECTION Stirrup
Param | Type | Description |
---|---|---|
no | Number | Number of Stirrup, can be undefined |
cover_points_no | Array | Cover points numbers |
material_no | Number | Material's number |
diameter | Number | Diameter, can be undefined (8 mm by default) |
diameter_of_curvature | Number | Diameter of curvature, can be undefined (32 mm by default) |
mandrel_diameter_factor | Number | Mandrel diameter factor, can be undefined (4.00 by default) |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# stirrup.GetNo() ⇒
Kind: instance method of Stirrup
Returns: Number of Stirrup
# stirrup.GetStirrup() ⇒
Kind: instance method of Stirrup
Returns: Stirrup object
# Surface
Kind: global class
# new Surface(no, boundary_lines, thickness, comment, params)
Creates surface
Returns: Created surface
Param | Type | Description |
---|---|---|
no | Number | Index of surface, can be undefined |
boundary_lines | Array | List of boundary lines indexes |
thickness | Number | Thickness index, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Surface's parameters, can be undefined |
# surface.GetSurface() ⇒
Kind: instance method of Surface
Returns: Surface object
# surface.GetNo() ⇒
Kind: instance method of Surface
Returns: Surface number
# surface.Standard(no, boundary_lines, thickness, comment, params) ⇒
Creates standard surface
Kind: instance method of Surface
Returns: Created surface
Param | Type | Description |
---|---|---|
no | Number | Index of surface, can be undefined |
boundary_lines | Array | List of boundary lines indexes |
thickness | Number | Thickness index |
comment | String | Comment, can be undefined |
params | Object | Surface's parameters, can be undefined |
# surface.WithoutThickness(no, boundary_lines, comment, params) ⇒
Creates without thickness surface
Kind: instance method of Surface
Returns: Created surface
Param | Type | Description |
---|---|---|
no | Number | Index of surface, can be undefined |
boundary_lines | Array | List of boundary lines indexes |
comment | String | Comment, can be undefined |
params | Object | Surface's parameters, can be undefined |
# surface.Rigid(no, boundary_lines, comment, params) ⇒
Creates rigid surface
Kind: instance method of Surface
Returns: Created surface
Param | Type | Description |
---|---|---|
no | Number | Index of surface, can be undefined |
boundary_lines | Array | List of boundary lines indexes |
comment | String | Comment, can be undefined |
params | Object | Surface's parameters, can be undefined |
# surface.Membrane(no, boundary_lines, thickness, comment, params) ⇒
Creates membrane surface
Kind: instance method of Surface
Returns: Created surface
Param | Type | Description |
---|---|---|
no | Number | Index of surface, can be undefined |
boundary_lines | Array | List of boundary lines indexes |
thickness | Number | Thickness index |
comment | String | Comment, can be undefined |
params | Object | Surface's parameters, can be undefined |
# surface.WithoutMembraneTension(no, boundary_lines, thickness, comment, params) ⇒
Creates without membrane tension surface
Kind: instance method of Surface
Returns: Created surface
Param | Type | Description |
---|---|---|
no | Number | Index of surface, can be undefined |
boundary_lines | Array | List of boundary lines indexes |
thickness | Number | Thickness index |
comment | String | Comment, can be undefined |
params | Object | Surface's parameters, can be undefined |
# surface.LoadTransfer(no, boundary_lines, load_transfer_direction, load_distribution, comment, params) ⇒
Creates load transfer surface
Kind: instance method of Surface
Returns: Created surface
Param | Type | Description |
---|---|---|
no | Number | Index of surface, can be undefined |
boundary_lines | Array | List of boundary lines indexes |
load_transfer_direction | String | Load transfer direction, can be undefined (DIRECTION_IN_X as default) |
load_distribution | String | Load distribution, can be undefined (UNIFORM as default) |
comment | String | Comment, can be undefined |
params | Object | Surface's parameters, can be undefined |
# surface.RemoveInfluenceFrom(excluded_members_no, excluded_parallel_to_members, excluded_lines, excluded_parallel_to_lines, excluded_nodes)
Removes influence from members, lines and nodes
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
excluded_members_no | Array | Remove influence from members, can be undefined |
excluded_parallel_to_members | Array | Remove influence from parallel to members, can be undefined |
excluded_lines | Array | Remove influence from lines, can be undefined |
excluded_parallel_to_lines | Array | Remove influence from parallel to lines, can be undefined |
excluded_nodes | Array | Remove influence from nodes, can be undefined |
# surface.SurfaceWeight(surface_weight)
Sets Load transfer surface's weight
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
surface_weight | Number | Surface weight |
# surface.ConsiderMemberEccentricity(consider_member_eccentricity)
Sets Load transfer surface's consider member eccentricity
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
consider_member_eccentricity | Boolean | Consider member eccentricity enabled/disabled, can be undefined (true as default) |
# surface.ConsiderSectionDistribution(consider_section_distribution)
Sets Load transfer surface's consider section distribution
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
consider_section_distribution | Boolean | Consider section distribution enabled/disabled, can be undefined (true as default) |
# surface.AdvancedDistribution(stripe_width, sampling_factor, enabled)
Sets load transfer surface's advance distribution
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
stripe_width | Number | Strip width, can be undefined (0.01 as default) |
sampling_factor | Number | Sampling factor, can be set only with varying load distribution, can be undefined (0.02 as default) |
enabled | Boolean | Advance distribution enabled/disabled, can be undefined (true as default) |
# surface.NeglectEquilibriumOfMoments(neglect_equilibrium_of_moments)
Sets load transfer surface's neglect equilibrium of moments
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
neglect_equilibrium_of_moments | Boolean | Neglect equilibrium of moments enabled/disabled, can be undefined (true as default) |
# surface.SurfaceType(stiffness_type, material, thickness)
Sets surface type with material and thickness
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
stiffness_type | String | Stiffness type |
material | Object | Material, can be undefined |
thickness | Object | Thickness, can be undefined |
# surface.Plane()
Sets plane geometry type of surface
Kind: instance method of Surface
# surface.Quadrangle(no, boundary_lines, stiffness_type, thickness, boundary_line, corner_node_1, corner_node_2, corner_node_3, corner_node_4, comment, params)
Sets quadrangle geometry type of surface
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
no | Number | Index of surface, can be undefined |
boundary_lines | Array | List of boundary lines indexes |
stiffness_type | String | Stiffness type |
thickness | Number | Thickness index, can be undefined |
boundary_line | Number | Index of boundary line |
corner_node_1 | Number | Quadrangle corner 1, can be undefined |
corner_node_2 | Number | Quadrangle corner 2, can be undefined |
corner_node_3 | Number | Quadrangle corner 3, can be undefined |
corner_node_4 | Number | Quadrangle corner 4, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Surface's parameters, can be undefined |
# surface.NURBS()
Sets NURBS geometry type of surface
Kind: instance method of Surface
# surface.Rotated(no, boundary_lines, thickness, boundary_line, angle_of_rotation, rotation_axis_p, rotation_axis_r, comment, params)
Sets rotated geometry type of surface
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
no | Number | Index of surface, can be undefined |
boundary_lines | Array | List of boundary lines indexes |
thickness | Number | Thickness index, can be undefined |
boundary_line | Number | Index of boundary line |
angle_of_rotation | Number | Angle of rotation, can be undefined |
rotation_axis_p | Array | Rotation axis, point P ([X, Y, Z]). Can be undefined. |
rotation_axis_r | Array | Rotation axis, point R ([X, Y, Z]). Can be undefined. |
comment | String | Comment, can be undefined |
params | Object | Surface's parameters, can be undefined |
# surface.Pipe(center_line, radius)
Sets pipe geometry type of surface
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
center_line | Number | Index of center lineHeight |
radius | Number | Radius |
# surface.Hinges(hinges_values)
Sets surface hinges
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
hinges_values | Array | Line hinges values ([[line_no1, line_hinge_no1] ... [line_non, line_hinge_non]]) |
# surface.Support(support)
Sets surface support
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
support | Number | Index of surface support |
# surface.Eccentricity(eccentricity)
Sets surface eccentricity
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
eccentricity | Number | Index of surface eccentricity |
# surface.MeshRefinement(mesh_refinement, meshing_type)
Sets surface mesh refinement
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
mesh_refinement | Number | Index of surface mesh refinement |
meshing_type | Number | Meshing type, can be undefined (According to global settings by default) 1 - According to global settings 2 - Mapped 3 - Free |
# surface.SpecificAxes(input_axes, result_axes)
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
input_axes | Array | Input axes values [category, [values], reverse_local_z_axis], can be undefined 1 - Angular rotation category, values: [α, [X, Y, Z], [X2, Y2, Z2]], first and second point can be undefined 2 - Axis parallel to lines category, values: [[line1_no, line2_no ... linen_no], axis (Axis x |
result_axes | Array | Result axes values [category], can be undefined (Identical to input axes by default) 1 - Identical to input axes category, by default |
# surface.GridForResults(grid_type, number_of_grid_points, grid_adapt_automatically, grid_distances, grid_rotation, grid_origin)
Sets surface's grid for results values
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
grid_type | Number | Grid type (1 - Cartesian, 2 - Polar) |
number_of_grid_points | Array | Number of grid points in (-) and (+), can be undefined Grid type cartesian: [nx+, nx-, ny+, ny-] Grid type polar: [nr+] |
grid_adapt_automatically | Boolean | Adapt automatically, can be undefined (true by default) |
grid_distances | Array | Grid distances ([b, h]), can be undefined |
grid_rotation | Array | Grid rotation ([α, β]), can be undefined |
grid_origin | Array | Grid origin ([X, Y, Z]), can be undefined |
# surface.IntegratedObjects(auto_detection_of_integrated_objects, integrated_nodes, integrated_lines, integrated_openings)
Sets integrated objects to surface
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
auto_detection_of_integrated_objects | Boolean | Integrated objects are detected automatically, can be undefined (true by default) |
integrated_nodes | Array | List of integrated nodes indexes, can be undefined |
integrated_lines | Array | List of integrated lines indexes, can be undefined |
integrated_openings | Array | List of integrated openings indexes, can be undefined; |
# surface.ConcreteDesignProperties(enabled)
Enable / disable Design properties for surface (Concrete design add-on)
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
enabled | Boolean | Enable / disable Design properties, can be undefined (true as default) |
# surface.SetConcreteDesignPropertiesViaParentSurfaceSet(design_properties_via_parent_surface_set)
Sets Via parent surface set
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
design_properties_via_parent_surface_set | Boolean | Via parent surface set, can be undefined (true as default) |
# surface.SetUserDefinedConcreteCover(concrete_cover_top, concrete_cover_bottom, is_user_defined_concrete_cover_enabled)
Sets User-defined concrete cover
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
concrete_cover_top | Number | Concrete cover top, can be undefined (is not set, 30 mm as default). For EN must be is_user_defined_concrete_cover_enabled set true |
concrete_cover_bottom | Number | Concrete cover bottom, can be undefined (is not set, 30 mm as default). For EN must be is_user_defined_concrete_cover_enabled set true |
is_user_defined_concrete_cover_enabled | Boolean | Enable/disable user-defined values, can be undefined (true as default). Has meaning only for EN standard. |
# surface.SetConcreteCoverAccToEn1992()
Sets Concrete Cover Acc. to EN 1992 | CEN | 2014-11
Kind: instance method of Surface
# surface.SetAssignments(surface_concrete_design_uls_configuration, surface_concrete_design_sls_configuration)
Sets Assignments
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
surface_concrete_design_uls_configuration | Number | Ultimate configuration, can be undefined (empty by default) |
surface_concrete_design_sls_configuration | Number | Serviceability configuration, can be undefined (empty by default) |
# surface.SetConcreteDesignReinforcementDirections(reinforcement_direction_top, reinforcement_direction_bottom)
Sets Reinforcement directions
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
reinforcement_direction_top | Number | Reinforcement direction number for top surface side |
reinforcement_direction_bottom | Number | Reinforcement direction number for bottom surface side |
# surface.SetConcreteDesignConcreteDurability(concrete_durability_top, concrete_durability_bottom)
Sets Concrete durabilities
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
concrete_durability_top | Number | Concrete durability number for top surface side |
concrete_durability_bottom | Number | Concrete durability number for bottom surface side |
# surface.SetConcreteDesignSurfaceReinforcement(surface_reinforcement_nos)
Sets Surface reinforcements
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
surface_reinforcement_nos | Array | Array of surface reinforcements numbers |
# surface.SetDeflectionAnalysis(deflection_check_surface_type, deflection_check_displacement_reference, deflection_check_reference_length_z_definition_type, deflection_check_reference_length_z)
Sets Deflection analysis
Kind: instance method of Surface
Param | Type | Description |
---|---|---|
deflection_check_surface_type | String | Surface type (DOUBLE_SUPPORTED, CANTILEVER), can be undefined (is not set, DOUBLE_SUPPORTED as default) |
deflection_check_displacement_reference | String | Displacement reference (DEFORMED_USER_DEFINED_REFERENCE_PLANE, PARALLEL_SURFACE, UNDEFORMED_SYSTEM), can be undefined (is not set, UNDEFORMED_SYSTEM as default) |
deflection_check_reference_length_z_definition_type | String | Definition type (MANUALLY, BY_MAXIMUM_BOUNDARY_LINE, BY_MINIMUM_BOUNDARY_LINE), can be undefined (is not set, BY_MAXIMUM_BOUNDARY_LINE as default) |
deflection_check_reference_length_z | Number | Reference length, can be undefined |
# SurfaceSet
Kind: global class
# new SurfaceSet(no, surfaces, surface_set_type, comment, params)
Create Surface Set
Returns: surfaceSet
Param | Type | Description |
---|---|---|
no | int | Number of Surface Set |
surfaces | array | List of surfaces |
surface_set_type | string | Surface Set type |
comment | string | Comment for the Surface Set |
params | dictionary | Parameters of the Surface Set |
# surfaceSet.GetSurfaceSet() ⇒
Kind: instance method of SurfaceSet
Returns: Surface set object
# surfaceSet.GetNo() ⇒
Kind: instance method of SurfaceSet
Returns: Surface set number
# surfaceSet.ContinuousSurfaces(no, surfaces, comment, params)
Create Continuous Surfaces surfaceSet type
Kind: instance method of SurfaceSet
Param | Type | Description |
---|---|---|
no | int | Number of Surface Set |
surfaces | array | List of surfaces |
comment | string | Comment for the Surface Set |
params | dictionary | Parameters of the Surface Set |
# surfaceSet.GroupOfSurfaces(no, surfaces, comment, params)
Create Group of Surfaces
Kind: instance method of SurfaceSet
Param | Type | Description |
---|---|---|
no | int | Number of Surface Set |
surfaces | array | List of surfaces |
comment | string | Comment for the Surface Set |
params | dictionary | Parameters of the Surface Set |
# Thickness
Kind: global class
# new Thickness(no, name, material, uniform_thickness_d, comment, params)
Create Thickness
Returns: Thickness
Param | Type | Description |
---|---|---|
no | int | Number of Thickness |
name | string | Name of the Thickness |
material | int | Number of material |
uniform_thickness_d | number | Uniform thickness in meters. |
comment | string | Comment for the Thickness |
params | dictionary | Parameters of the Thickness |
# thickness.GetThickness() ⇒
Kind: instance method of Thickness
Returns: Thickness object
# thickness.GetNo() ⇒
Kind: instance method of Thickness
Returns: Thickness number
# thickness.Uniform(no, name, material, thickness, comment, params)
Create Uniform thickness
Kind: instance method of Thickness
Param | Type | Description |
---|---|---|
no | int | Number of Thickness |
name | string | Name of the Thickness |
material | int | Number of material |
thickness | number | Properties of thickness in format [thickness] |
comment | string | Comment for the Thickness |
params | dictionary | Parameters of the Thickness |
# thickness.Variable_3Nodes(no, name, material, thicknessProperties, comment, params)
Create Variable - 3 Nodes thickness
Kind: instance method of Thickness
Param | Type | Description |
---|---|---|
no | int | Number of Thickness |
name | string | Name of the Thickness |
material | int | Number of material |
thicknessProperties | array | Properties of thickness [thickness_1,node_1,thickness_2,node_2,thickness_3,node_3] |
comment | string | Comment for the Thickness |
params | dictionary | Parameters of the Thickness |
# thickness.Variable_2NodesAndDirection(no, name, material, thicknessProperties, comment, params)
Create Variable - 2 Nodes and Direction thickness
Kind: instance method of Thickness
Param | Type | Description |
---|---|---|
no | int | Number of Thickness |
name | string | Name of the Thickness |
material | int | Number of material |
thicknessProperties | array | Properties of thickness [thickness_1,node_1,thickness_2,node_2,direction] |
comment | string | Comment for the Thickness |
params | dictionary | Parameters of the Thickness |
# thickness.Variable_4SurfaceCorners(no, name, material, thicknessProperties, comment, params)
Create Variable - 4 Surface Corners thickness
Kind: instance method of Thickness
Param | Type | Description |
---|---|---|
no | int | Number of Thickness |
name | string | Name of the Thickness |
material | int | Number of material |
thicknessProperties | array | Properties of thickness [thickness_1,node_1,thickness_2,node_2,thickness_3,node_3,thickness_4,node_4] |
comment | string | Comment for the Thickness |
params | dictionary | Parameters of the Thickness |
# thickness.Variable_Circle(no, name, material, thicknessProperties, comment, params)
Create Variable - Circle thickness
Kind: instance method of Thickness
Param | Type | Description |
---|---|---|
no | int | Number of Thickness |
name | string | Name of the Thickness |
material | int | Number of material |
thicknessProperties | array | Properties of thickness [thickness_circle_center,thickness_circle_line] |
comment | string | Comment for the Thickness |
params | dictionary | Parameters of the Thickness |
# thickness.Layers(no, name, layers, comment, params)
Create Layers thickness
Kind: instance method of Thickness
Param | Type | Description |
---|---|---|
no | int | Number of Thickness |
name | string | Name of the Thickness |
layers | array | List of layers [[material,thickness,angle,comment],] |
comment | string | Comment for the Thickness |
params | dictionary | Parameters of the Thickness |
# thickness.ShapeOrthotropy(no, name, layers, orthotropy_type, rotation_beta, consideration_of_self_weight, parameters, comment, params)
Create Shape Orthotropy thickness
Kind: instance method of Thickness
Param | Type | Description |
---|---|---|
no | int | Number of Thickness |
name | string | Name of the Thickness |
layers | array | List of layers |
orthotropy_type | string | Orthotropy Type |
rotation_beta | number | Rotation about Z-axis of surface (Degree) |
consideration_of_self_weight | string | Self-Weight definition |
parameters | array | Parameters of Shame Orthotropy |
comment | string | Comment for the Thickness |
params | dictionary | Parameters of the Thickness |
# thickness.StiffnessMatrix(no, name, rotation_beta, consideration_of_self_weight, coefficient_of_thermal_expansion, stiffness_matrix, comment, params)
Create Stiffness Matrix thickness
Kind: instance method of Thickness
Param | Type | Description |
---|---|---|
no | int | Number of Thickness |
name | string | Name of the Thickness |
rotation_beta | number | Rotation about Z-axis of surface (Degree) |
consideration_of_self_weight | string | Self-Weight definition |
coefficient_of_thermal_expansion | array | Coefficient of thermal expansion |
stiffness_matrix | array | Stiffness Matrix [[D11,D12,D13,D22,D23,D33],....] |
comment | string | Comment for the Thickness |
params | dictionary | Parameters of the Thickness |
# Layer(no, name, comment, params)
Creates Layer
Kind: global function
Param | Type | Description |
---|---|---|
no | Number | Layer number, can be undefined |
name | String | Name, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# layer.GetNo()
Returns layer number
Kind: instance method of Layer
# layer.GetLayer()
Returns Layer object
Kind: instance method of Layer
# getRotationPlane(rotation_plane) ⇒
Returns rotation plane from string representation (private)
Kind: global function
Returns: Rotation plane
Param | Type | Description |
---|---|---|
rotation_plane | String | Rotation plane (x-y, x-z) |
# createBaseLine(no, nodes, comment, params) ⇒
Creates line (private)
Kind: global function
Returns: Created line
Param | Type | Description |
---|---|---|
no | Number | Index of line, can be undefined |
nodes | Array | List of Node indexes |
comment | String | Comment, can be undefined |
params | Object | Line's parameters, can be undefined |
# setDistributionAtStart()
Support function for section distributions (private), more info can be find there
# setDistributionAtEnd()
Support function for section distributions (private), more info can be find there
# setResultBeamObjects(member, param1_to_set, param2_to_set, value) ⇒
Sets result beam objects
Kind: global function
Returns: Modified member
Param | Type | Description |
---|---|---|
member | Object | Member to be set |
param1_to_set | String | Name of parameter for include/exclude "all" objects |
param2_to_set | String | Name of parameter for include/exclude object's indexes |
value | Boolean/Array | Value can be specified in two formats, as boolean or array with numbers |
# createBaseMember(no, nodes_or_line, type, section_start, comment, params) ⇒
Creates member (private)
Kind: global function
Returns: Created member
Param | Type | Description |
---|---|---|
no | Number | Index of member, can be undefined |
nodes_or_line | Array/Number | List of node indexes or number of line |
type | String | Type of member, can be undefined |
section_start | Number | Section start, can be undefined. Section end is same as section start by default. To set section end specify distribution type. |
comment | String | Comment, can be undefined |
params | Object | Member's parameters, can be undefined |
# createBaseRSectionElement(no, type, comment, params) ⇒
Create base RSection Element
Kind: global function
Returns: Element
Param | Type | Description |
---|---|---|
no | Number | Number of Element, can be undefined |
type | String | Type of Element |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# createBaseRSectionLine(no, type, comment, params) ⇒
Creates RSection base Line
Kind: global function
Returns: Line
Param | Type | Description |
---|---|---|
no | Number | Number of Line, can be undefined |
type | String | Type of Line |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# createBaseOpening(no, boundary_lines, comment, params) ⇒
Kind: global function
Returns: Opening
Param | Type | Description |
---|---|---|
no | int | Number of Opening, can be undefined |
boundary_lines | Array | Boundary lines |
comment | string | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# createBaseRSectionPart(no, comment, params) ⇒
Creates base RSection Part
Kind: global function
Returns: Part
Param | Type | Description |
---|---|---|
no | int | Number of Part, can be undefined |
comment | string | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# createBasePoint(no, coordinate_y, coordinate_z, comment, params) ⇒
Creates base RSection Point (private)
Kind: global function
Returns: Point
Param | Type | Description |
---|---|---|
no | Number | Number of Point, can be undefined |
coordinate_y | Number | Coordinate Y |
coordinate_z | Number | Coordinate Z |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# createBaseStressPoint(no, comment, params) ⇒
Create RSection Stress Points
Kind: global function
Returns: Stress point
Param | Type | Description |
---|---|---|
no | Number | Number of Stress point, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Parameters, can be undefined |
# createSurfaceWithType(no, boundary_lines, stiffness_type, thickness, comment, params) ⇒
Creates surface (private)
Kind: global function
Returns: Created surface
Param | Type | Description |
---|---|---|
no | Number | Index of surface, can be undefined |
boundary_lines | Array | List of boundary lines indexes |
stiffness_type | String | Stiffness type |
thickness | Number | Thickness index, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Surface's parameters, can be undefined |