Skip to content

Latest commit

 

History

History
348 lines (258 loc) · 14.8 KB

File metadata and controls

348 lines (258 loc) · 14.8 KB
title Surface

Surface

Classes

Surface

Functions

createSurfaceWithType(no, boundary_lines, stiffness_type, thickness, comment, params)

Creates surface (private)

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, values, 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
values Array Load transfer's parameters, can be undefined [load_transfer_direction, surface_weight, consider_member_eccentricity, consider_section_distribution excluded_members, excluded_parallel_to_members, excluded_lines, excluded_parallel_to_lines, loaded_lines, loaded_members]
comment String Comment, can be undefined
params Object Surface's parameters, can be undefined

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_distancies, 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_distancies Array Grid distancies ([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;

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