# TypesForMembers

# MemberDefinableStiffness

Kind: global class

# new MemberDefinableStiffness(no, member_list, comment, params)

Creates member definable stiffness

Returns: Object - Created member definable stiffness

Param Type Description
no Number Index of member definable stiffness, can be undefined
member_list Array Assigned members, can be undefined
comment String Comment, can be undefined
params Object Member definable stiffness parameters, can be undefined

# memberDefinableStiffness.TorsionalAndBendingStiffness(torsional_stiffness, bending_stiffness_y, bending_stiffness_z)

Sets torsional and bending stiffness parameters

Kind: instance method of MemberDefinableStiffness

Param Type Description
torsional_stiffness Number Torsional stiffness
bending_stiffness_y Number Bending stiffness Y
bending_stiffness_z Number Bending stiffness Z

# memberDefinableStiffness.AxialAndShearStiffness(axial_stiffness, shear_stiffness_y, shear_stiffness_z)

Sets axial and shear stiffness parameters

Kind: instance method of MemberDefinableStiffness

Param Type Description
axial_stiffness Number Axial stiffness
shear_stiffness_y Number Shear stiffness Y
shear_stiffness_z Number Shear stiffness Z

# memberDefinableStiffness.SelfWeightAndSectionArea(specific_weight, section_area)

Sets self weight stiffness parameters

Kind: instance method of MemberDefinableStiffness

Param Type Description
specific_weight Number Specific weight
section_area Number Section area

# memberDefinableStiffness.MainAxesRotation(rotation)

Sets main axes rotation parameter

Kind: instance method of MemberDefinableStiffness

Param Type Description
rotation Number Rotation

# memberDefinableStiffness.ThermalExpansionCoefficient(thermal_expansion, width, height)

Sets coefficient of thermal expansion stiffness parameters

Kind: instance method of MemberDefinableStiffness

Param Type Description
thermal_expansion Number Thermal expansion
width Number Width
height Number Height

# MemberEccentricity

Kind: global class

# new MemberEccentricity(no, members_start_list, members_end_list, comment, params)

Creates member eccentricity

Returns: Object - Created member eccentricity

Param Type Description
no Number Index of member eccentricity, can be undefined
members_start_list Array Members start, can be undefined
members_end_list Array Members end, can be undefined
comment String Comment, can be undefined
params Object Member eccentricity parameters, can be undefined

# memberEccentricity.RelativeToSection(no, members_start_list, members_end_list, alignment, comment, params) ⇒ Object

Creates member eccentricity relative to section

Kind: instance method of MemberEccentricity
Returns: Object - Created member eccentricity

Param Type Description
no Number Index of member eccentricity, can be undefined
members_start_list Array Member start
members_end_list Array Member end
alignment String Alignment, for more info look at private function setRelativeValues
comment String Comment, can be undefined
params Object Member eccentricity parameters, can be undefined

# memberEccentricity.Absolute(no, members_start_list, members_end_list, offset_x, offset_y, offset_z, coordinate_system, comment, params) ⇒ Object

Creates absolute member eccentricity

Kind: instance method of MemberEccentricity
Returns: Object - Created member eccentricity

Param Type Description
no Number Index of member eccentricity, can be undefined
members_start_list Array Members start
members_end_list Array Members end
offset_x Number Eccentricity in X
offset_y Number Eccentricity in Y
offset_z Number Eccentricity in Z
coordinate_system Number Coordinate system, can be undefined. Default value is "Local xyz".
comment String Comment, can be undefined
params Object Member eccentricity parameters, can be undefined

# memberEccentricity.RelativeAndAbsolute(no, members_start_list, members_end_list, offset_x, offset_y, offset_z, coordinate_system, alignment, comment, params) ⇒ Object

Creates absolute member eccentricity

Kind: instance method of MemberEccentricity
Returns: Object - Created member eccentricity

Param Type Description
no Number Index of member eccentricity, can be undefined
members_start_list Array Members start
members_end_list Array Members end
offset_x Number Eccentricity in X
offset_y Number Eccentricity in Y
offset_z Number Eccentricity in Z
coordinate_system Number Coordinate system, can be undefined. Default value is "Local xyz".
alignment String Alignment, for more info look at private function setRelativeValues
comment String Comment, can be undefined
params Object Member eccentricity parameters, can be undefined

# memberEccentricity.AxialOffset(active)

Sets axial offset from adjoining member

Kind: instance method of MemberEccentricity

Param Type Description
active Boolean True if undefined

# memberEccentricity.HingeLocationAtNode(active)

Sets hinge location at node (if applied)

Kind: instance method of MemberEccentricity

Param Type Description
active Boolean True if undefined

# memberEccentricity.TransverseOffsetMember(reference_member, reference_node, alignment)

Transverse offset from section of another member

Kind: instance method of MemberEccentricity

Param Type Description
reference_member Number Reference member
reference_node Number Reference member's node, can be undefined
alignment String Alignment, for more info look at private function setTransverseOffset

# memberEccentricity.TransverseOffsetSurface(reference_surface, alignment)

Transverse offset from section of another thickness of other surface

Kind: instance method of MemberEccentricity

Param Type Description
reference_surface Number Reference surface
alignment String Alignment, for more info look at private function setTransverseOffset

# memberEccentricity.TransverseOffsetNone()

Set off transverse offset

Kind: instance method of MemberEccentricity

# MemberHinge

Kind: global class

# new MemberHinge(no, members_start_list, members_end_list, comment, params)

Creates member hinge

Returns: Object - Created member hinge

Param Type Description
no Number Index of member hinge, can be undefined
members_start_list Array Member start, can be undefined
members_end_list Array Member end, can be undefined
comment String Comment, can be undefined
params Object Member hinge parameters, can be undefined

# memberHinge.Translational(no, members_start_list, members_end_list, axial_release_n, axial_release_vy, axial_release_vz, comment, params) ⇒ Object

Creates member hinge with specified axis release

Kind: instance method of MemberHinge
Returns: Object - Created member hinge

Param Type Description
no Number Index of member hinge, can be undefined
members_start_list Array Member start, can be undefined
members_end_list Array Member end, can be undefined
axial_release_n Array Axis release for ux, for more information look at comment in private setMainHingeValues function
axial_release_vy Array Axis release for uy, for more information look at comment in private setMainHingeValues function
axial_release_vz Array Axis release for uz, for more information look at comment in private setMainHingeValues function
comment String Comment, can be undefined
params Object Member hinge parameters, can be undefined

# memberHinge.Rotational(no, members_start_list, members_end_list, moment_release_mt, moment_release_my, moment_release_mz, comment, params) ⇒ Object

Creates member hinge with specified moment release

Kind: instance method of MemberHinge
Returns: Object - Created member hinge

Param Type Description
no Number Index of member hinge, can be undefined
members_start_list Array Member start, can be undefined
members_end_list Array Member end, can be undefined
moment_release_mt Array Moment release for φx, for more information look at comment in private setMainHingeValues function
moment_release_my Array Moment release for φy, for more information look at comment in private setMainHingeValues function
moment_release_mz Array Moment release for φz, for more information look at comment in private setMainHingeValues function
comment String Comment, can be undefined
params Object Member hinge parameters, can be undefined

# memberHinge.PartialActivityTranslationalX(negative_zone_values, positive_zone_values)

Sets negative and/or positive zone to partial activity translation x nonlinearity

Kind: instance method of MemberHinge

Param Type Description
negative_zone_values Array Negative zone values depend on type (for more information look at setPartialActivityZoneValues function)
positive_zone_values Array Positive zone values depend on type (for more information look at setPartialActivityZoneValues function)

# memberHinge.PartialActivityTranslationalY(negative_zone_values, positive_zone_values)

Sets negative and/or positive zone to partial activity translation y nonlinearity

Kind: instance method of MemberHinge

Param Type Description
negative_zone_values Array Negative zone values depend on type (for more information look at setPartialActivityZoneValues function)
positive_zone_values Array Positive zone values depend on type (for more information look at setPartialActivityZoneValues function)

# memberHinge.PartialActivityTranslationalZ(negative_zone_values, positive_zone_values)

Sets negative and/or positive zone to partial activity translation z nonlinearity

Kind: instance method of MemberHinge

Param Type Description
negative_zone_values Array Negative zone values depend on type (for more information look at setPartialActivityZoneValues function)
positive_zone_values Array Positive zone values depend on type (for more information look at setPartialActivityZoneValues function)

# memberHinge.PartialActivityRotationalX(negative_zone_values, positive_zone_values)

Sets negative and/or positive zone to partial activity rotational x nonlinearity

Kind: instance method of MemberHinge

Param Type Description
negative_zone_values Array Negative zone values depend on type (for more information look at setPartialActivityZoneValues function)
positive_zone_values Array Positive zone values depend on type (for more information look at setPartialActivityZoneValues function)

# memberHinge.PartialActivityRotationalY(negative_zone_values, positive_zone)

Sets negative and/or positive zone to partial activity rotational y nonlinearity

Kind: instance method of MemberHinge

Param Type Description
negative_zone_values Array Negative zone values depend on type (for more information look at setPartialActivityZoneValues function)
positive_zone Array Positive zone values depend on type (for more information look at setPartialActivityZoneValues function)

# memberHinge.PartialActivityRotationalZ(negative_zone_values, positive_zone_values)

Sets negative and/or positive zone to partial activity rotational z nonlinearity

Kind: instance method of MemberHinge

Param Type Description
negative_zone_values Array Negative zone values depend on type (for more information look at setPartialActivityZoneValues function)
positive_zone_values Array Positive zone values depend on type (for more information look at setPartialActivityZoneValues function)

# memberHinge.DiagramTranslationalX(diagram_values)

Sets translational diagram values for ux

Kind: instance method of MemberHinge

Param Type Description
diagram_values Array [[ux1, N1, Cux1], [ux2, N2, Cux2] ... [uxn, Nn, Cuxn]]

# memberHinge.DiagramTranslationalY(diagram_values)

Sets translational diagram values for uy

Kind: instance method of MemberHinge

Param Type Description
diagram_values Array [[uy1, N1, Cuy1], [uy2, N2, Cuy2] ... [uyn, Nn, Cuyn]]

# memberHinge.DiagramTranslationalZ(diagram_values)

Sets translational diagram values for uz

Kind: instance method of MemberHinge

Param Type Description
diagram_values Array [[uz1, N1, Cuz1], [uz2, N2, Cuz2] ... [uzn, Nn, Cuzn]]

# memberHinge.DiagramRotationalX(diagram_values)

Sets rotational diagram values for φx

Kind: instance method of MemberHinge

Param Type Description
diagram_values Array [[φx1, N1, Cφx1], [φx2, N2, Cφx2] ... [φxn, Nn, Cφxn]]

# memberHinge.DiagramRotationalY(diagram_values)

Sets rotational diagram values for φy

Kind: instance method of MemberHinge

Param Type Description
diagram_values Array [[φy1, N1, Cφy1], [φy2, N2, Cφy2] ... [φyn, Nn, Cφyn]]

# memberHinge.DiagramRotationalZ(diagram_values)

Sets rotational diagram values for φz

Kind: instance method of MemberHinge

Param Type Description
diagram_values Array [[φz1, N1, Cφz1], [φz2, N2, Cφz2] ... [φzn, Nn, Cφzn]]

# memberHinge.FrictionVyTranslationalX(friction_coefficient_x, spring_constant_x)

Sets translational friction Vy values for ux

Kind: instance method of MemberHinge

Param Type Description
friction_coefficient_x Number Friction coefficient X
spring_constant_x Number Spring constant X

# memberHinge.FrictionVzTranslationalX(friction_coefficient_x, spring_constant_x)

Sets translational friction Vz values for ux

Kind: instance method of MemberHinge

Param Type Description
friction_coefficient_x Number Friction coefficient X
spring_constant_x Number Spring constant X

# memberHinge.FrictionVyVzTranslationalX(friction_coefficient_x, spring_constant_x)

Sets translational friction VyVz values for ux

Kind: instance method of MemberHinge

Param Type Description
friction_coefficient_x Number Friction coefficient X
spring_constant_x Number Spring constant X

# memberHinge.FrictionVyPlusVzTranslationalX(friction_coefficient_xy, friction_coefficient_xz, spring_constant_x)

Sets translational friction Vy+Vz values for ux

Kind: instance method of MemberHinge

Param Type Description
friction_coefficient_xy Number Friction coefficient XY
friction_coefficient_xz Number Friction coefficient XZ
spring_constant_x Number Spring constant X

# memberHinge.FrictionNTranslationalY(friction_coefficient_y, spring_constant_y)

Sets translational friction N values for uy

Kind: instance method of MemberHinge

Param Type Description
friction_coefficient_y Number Friction coefficient Y
spring_constant_y Number Spring constant Y

# memberHinge.FrictionVzTranslationalY(friction_coefficient_y, spring_constant_y)

Sets translational friction Vz values for uy

Kind: instance method of MemberHinge

Param Type Description
friction_coefficient_y Number Friction coefficient Y
spring_constant_y Number Spring constant Y

# memberHinge.FrictionNVzTranslationalY(friction_coefficient_y, spring_constant_y)

Sets translational friction NVz values for uy

Kind: instance method of MemberHinge

Param Type Description
friction_coefficient_y Number Friction coefficient Y
spring_constant_y Number Spring constant Y

# memberHinge.FrictionNPlusVzTranslationalY(friction_coefficient_yx, friction_coefficient_yz, spring_constant_y)

Sets translational friction N+Vz values for uy

Kind: instance method of MemberHinge

Param Type Description
friction_coefficient_yx Number Friction coefficient YX
friction_coefficient_yz Number Friction coefficient YZ
spring_constant_y Number Spring constant Y

# memberHinge.FrictionNTranslationalZ(friction_coefficient_z, spring_constant_z)

Sets translational friction N values for uz

Kind: instance method of MemberHinge

Param Type Description
friction_coefficient_z Number Friction coefficient Z
spring_constant_z Number Spring constant Z

# memberHinge.FrictionVyTranslationalZ(friction_coefficient_z, spring_constant_z)

Sets translational friction Vy values for uz

Kind: instance method of MemberHinge

Param Type Description
friction_coefficient_z Number Friction coefficient Z
spring_constant_z Number Spring constant Z

# memberHinge.FrictionNVyTranslationalZ(friction_coefficient_z, spring_constant_z)

Sets translational friction NVy values for uz

Kind: instance method of MemberHinge

Param Type Description
friction_coefficient_z Number Friction coefficient Z
spring_constant_z Number Spring constant Z

# memberHinge.FrictionNPlusVyTranslationalZ(friction_coefficient_zx, friction_coefficient_zy, spring_constant_z)

Sets translational friction N+Vy values for uz

Kind: instance method of MemberHinge

Param Type Description
friction_coefficient_zx Number Friction coefficient ZX
friction_coefficient_zy Number Friction coefficient ZY
spring_constant_z Number Spring constant Z

# MemberNonlinearity

Kind: global class

# new MemberNonlinearity(no, comment, params)

Creates member nonlinearity

Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# memberNonlinearity.FailureIfTension(no, members, comment, params) ⇒ Object

Creates member failure if tension nonlinearity

Kind: instance method of MemberNonlinearity
Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
members Array Assigned members
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# memberNonlinearity.FailureIfCompression(no, members, comment, params) ⇒ Object

Creates member failure if compression nonlinearity

Kind: instance method of MemberNonlinearity
Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
members Array Assigned members
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# memberNonlinearity.FailureIfTensionWithSlippage(no, members, slippage, comment, params) ⇒ Object

Creates member failure if tension with slippage nonlinearity

Kind: instance method of MemberNonlinearity
Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
members Array Assigned members
slippage Number Slippage
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# memberNonlinearity.FailureIfCompressionWithSlippage(no, members, slippage, comment, params) ⇒ Object

Creates member failure if compression with slippage nonlinearity

Kind: instance method of MemberNonlinearity
Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
members Array Assigned members
slippage Number Slippage
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# memberNonlinearity.Slippage(no, members, slippage, comment, params) ⇒ Object

Creates member slippage nonlinearity

Kind: instance method of MemberNonlinearity
Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
members Array Assigned members
slippage Number Slippage
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# memberNonlinearity.FailureUnderTension(no, members, tension_force, comment, params) ⇒ Object

Creates member tearing under tension nonlinearity

Kind: instance method of MemberNonlinearity
Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
members Array Assigned members
tension_force Number Tension force
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# memberNonlinearity.YieldingUnderTension(no, members, tension_force, comment, params) ⇒ Object

Creates member yielding under tension nonlinearity

Kind: instance method of MemberNonlinearity
Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
members Array Assigned members
tension_force Number Tension force
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# memberNonlinearity.FailureUnderCompression(no, members, compression_force, comment, params) ⇒ Object

Creates member tearing under compression nonlinearity

Kind: instance method of MemberNonlinearity
Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
members Array Assigned members
compression_force Number Compression force
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# memberNonlinearity.YieldingUnderCompression(no, members, compression_force, comment, params) ⇒ Object

Creates member yielding under compression nonlinearity

Kind: instance method of MemberNonlinearity
Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
members Array Assigned members
compression_force Number Compression force
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# memberNonlinearity.Failure(no, members, compression_force, tension_force, comment, params) ⇒ Object

Creates member tearing nonlinearity

Kind: instance method of MemberNonlinearity
Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
members Array Assigned members
compression_force Number Compression force
tension_force Number Tension force
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# memberNonlinearity.Yielding(no, members, compression_force, tension_force, comment, params) ⇒ Object

Creates member yielding nonlinearity

Kind: instance method of MemberNonlinearity
Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
members Array Assigned members
compression_force Number Compression force
tension_force Number Tension force
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# MemberResultIntermediatePoint

Kind: global class

# new MemberResultIntermediatePoint(no, members, comment, params)

Creates member result intermediate point

Returns: Object - Created member result intermediate point

Param Type Description
no Number Index of member definable stiffness, can be undefined
members Array Assigned members, can be undefined
comment String Comment, can be undefined
params Object Member result intermediate point parameters, can be undefined

# memberResultIntermediatePoint.UniformDistances(divisions_count, notes)

Sets number of points

Kind: instance method of MemberResultIntermediatePoint

Param Type Description
divisions_count Number Number of division ordinates
notes Array Notes to each point, can be undefined

# memberResultIntermediatePoint.DivisionOrdinates(division_ordinates, notes, absolute, clear_ordinates)

Sets division ordinates

Kind: instance method of MemberResultIntermediatePoint

Param Type Description
division_ordinates Array Division ordinates
notes Array Division ordinates notes, can be undefined
absolute Boolean Distances are absolute or relative can be undefined (default value is absolute)
clear_ordinates Boolean Clears default ordinates, can be undefined (default value is true)

# MemberStiffnessModification

Kind: global class

# new MemberStiffnessModification(no, structure_modifications, comment, params)

Creates member stiffness modification

Returns: Object - Created member stiffness modification

Param Type Description
no Number Index of member stiffness modification, can be undefined
structure_modifications Array Assigned structure modifications, can be undefined
comment String Comment, can be undefined
params Object Member stiffness modification parameters, can be undefined

# memberStiffnessModification.TotalStiffnessFactor(total_stiffness)

Sets total stiffness factor

Kind: instance method of MemberStiffnessModification

Param Type Description
total_stiffness Number Total stiffness

# memberStiffnessModification.PartialStiffnessFactors(axial_stiffness, bending_stiffness_y, bending_stiffness_z, shear_stiffness_y, shear_stiffness_z, torsional_stiffness, weight)

Sets partial stiffness factors

Kind: instance method of MemberStiffnessModification

Param Type Description
axial_stiffness Number Axial stiffness, can be undefined
bending_stiffness_y Number Bending stiffness Y, can be undefined
bending_stiffness_z Number Bending stiffness Z, can be undefined
shear_stiffness_y Number Shear stiffness Y, can be undefined
shear_stiffness_z Number Shear stiffness Z, can be undefined
torsional_stiffness Number Torsional stiffness, can be undefined
weight Number Weight, can be undefined

# memberStiffnessModification.ConcreteStructuresAci(component_type)

Sets concrete structure ACI

Kind: instance method of MemberStiffnessModification

Param Type Description
component_type Number Component type: COLUMNS, BEAMS. Can be undefined

# memberStiffnessModification.ConcreteStructuresCsa(component_type)

Sets concrete structure CSA

Kind: instance method of MemberStiffnessModification

Param Type Description
component_type Number Component type: COLUMNS, BEAMS. Can be undefined

# memberStiffnessModification.SteelStructuresAisc(determine_tau_b, design_method)

Sets steel structures AISC

Kind: instance method of MemberStiffnessModification

Param Type Description
determine_tau_b Number Determine τb: Iterative (1), Set to 1 (2). Can be undefined.
design_method Number Design method: LRFD (1), ASD (2). Can be undefined. If determine τb has "Set to 1" value, must be undefined.

# memberStiffnessModification.SteelStructuresCSA(determine_tau_b, axial_stiffness, bending_stiffness_y, bending_stiffness_z, shear_stiffness_y, shear_stiffness_z, torsional_stiffness)

, Sets steel structures CSA

Kind: instance method of MemberStiffnessModification

Param Type Description
determine_tau_b Number Determine τb: Iterative (1), Set to 1 (2). Can be undefined.
axial_stiffness Number Axial stiffness multiplier factor, can be undefined. If defined, apply τb is set to true.
bending_stiffness_y Number Bending stiffness multiplier factors Z, can be undefined. If defined, apply τb is set to true.
bending_stiffness_z Number Bending stiffness multiplier factors Y, can be undefined. If defined, apply τb is set to true.
shear_stiffness_y Number Shear stiffness Y, can be undefined. If defined, apply τb is set to true.
shear_stiffness_z Number Shear stiffness Z, can be undefined. If defined, apply τb is set to true.
torsional_stiffness Number Torsional stiffness, can be undefined. If defined, apply τb is set to true.

# setTransverseOffset(memberEccentricity, reference_type, reference, reference_node_index, alignment_type)

Sets transverse offset (private)

Kind: global function

Param Type Description
memberEccentricity Object Member eccentricity to be set
reference_type String Reference type ("None", "Member", "Surface")
reference Number object index Reference member or surface index
reference_node_index Number Reference member node index, in case of surface is undefined
alignment_type String For member offset: LEFT_TOP, CENTER_TOP, RIGHT_TOP, LEFT_CENTER, CENTER_CENTER, RIGHT_CENTER, LEFT_BOTTOM, CENTER_BOTTOM, RIGHT_BOTTOM. For surface offset: CENTER_TOP, CENTER_CENTER, CENTER_BOTTOM.

# createMemberEccentricity(no, members_start_list, members_end_list, comment, params) ⇒ Object

Creates member eccentricity

Kind: global function
Returns: Object - Created member eccentricity

Param Type Description
no Number Index of member eccentricity, can be undefined
members_start_list Array Members start, can be undefined
members_end_list Array Members end, can be undefined
comment String Comment, can be undefined
params Object Member eccentricity parameters, can be undefined

# setRelativeValues(member_eccentricity, alignment_type)

Sets member eccentricity for relative to section type (private)

Kind: global function

Param Type Description
member_eccentricity Object Member eccentricity to be set
alignment_type String Alignment: LEFT_TOP, CENTER_TOP, RIGHT_TOP, LEFT_CENTER, CENTER_CENTER, RIGHT_CENTER, LEFT_BOTTOM, CENTER_BOTTOM, RIGHT_BOTTOM.

# getAlignmentParts(alignment) ⇒ Array

Creates horizontal and vertical strings of alignment (private)

Kind: global function
Returns: Array - Horizontal and vertical strings of alignment

Param Type Description
alignment String Alignment string

# setAbsoluteValues(memberEccentricity, offset_x, offset_y, offset_z, coordinate_system)

Sets member eccentricity for absolute type (private)

Kind: global function

Param Type Description
memberEccentricity Object Member eccentricity to be set
offset_x Number Eccentricity in X
offset_y Number Eccentricity in Y
offset_z Number Eccentricity in Z
coordinate_system Number Coordinate system, can be undefined. Default value is "Local xyz".

# setPartialActivityZoneValues(member_hinge, zone_values, param_type_name, param_slippage_name, param_displacement_name, param_force_name)

Sets values for partial activity zone (private)

Kind: global function

Param Type Description
member_hinge Object Member hinge to which values has to be set
zone_values Array Negative / positive zone values - "Complete": [0] - "Fixed from release displacement": [1, u(x
param_type_name String Parameter name for partial activity zone name
param_slippage_name String Parameter name for partial activity slippage name
param_displacement_name String Parameter name for partial activity displacement name
param_force_name String Parameter name for partial activity force name

# setMainHingeValues(member_hinge, values, property_1, property_2) ⇒

Sets values to member hinge (private)

Kind: global function
Returns: Returns modified member hinge

Param Type Description
member_hinge Object Member hinge
values Array Values to be set, [Translational/Rotational, Spring constant, Nonlinearity] - Values can be in two formats: [bool, float, string] - if bool is true (translation is enabled), then can be specified next two values (spring constant and nonlinearity) [bool, string] - if bool is false (translation is disabled), then can be specified only next one value (nonlinearity) Nonlinearity: can be string name or index: None (0), Fixed if negative (1), Fixed if positive (2), Failure all if negative (3), Failure all if positive (4), Partial activity (5), Diagram (6), Stiffness diagram (7), Friction direction 1 (8), Friction direction 2 (9), Friction direction 1 2 (10), Friction direction 1 + 2 (11)
property_1 String Spring constant string name
property_2 String Nonlinearity string name

# createMemberHinge(no, members_start_list, members_end_list, comment, params) ⇒ Object

Creates member hinge (private)

Kind: global function
Returns: Object - Created member hinge

Param Type Description
no Number Index of member hinge, van be undefined
members_start_list Array Member start, can be undefined
members_end_list Array Member end, can be undefined
comment String Comment, can be undefined
params Object Member hinge parameters, can be undefined

# setParameters(member_nonlinearity, parameters, param_1_name, param_2_name)

Sets parameters to member nonlinearity (private)

Kind: global function

Param Type Description
member_nonlinearity Object Member nonlinearity to be setParameters
parameters Array Nonlinearity parameters
param_1_name String Name of first parameter
param_2_name String Name of first parameter, can be undefined

# createNonlinearity(no, member_list, comment, params) ⇒ Object

Creates member nonlinearity

Kind: global function
Returns: Object - Created member nonlinearity

Param Type Description
no Number Index of member nonlinearity, can be undefined
member_list Array Assigned members
comment String Comment, can be undefined
params Object Member nonlinearity parameters, can be undefined

# MemberOpening(no, members_no, member_sets_no, comment, params)

Creates Member Opening

Kind: global function

Param Type Description
no Number Index of member opening, can be undefined
members_no Array Index list of assigned members, can be undefined (only in case list of member_sets_no is defined)
member_sets_no Array Index list of assigned member sets, can be undefined (only in case list of members_no is defined)
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# memberOpening.GetMemberOpening() ⇒

Kind: instance method of MemberOpening
Returns: Member Opening object

# memberOpening.GetNo() ⇒

Kind: instance method of MemberOpening
Returns: Member Opening index

# memberOpening.AddTypeAndLocation(reduction_type, position, note)

Adds component row

Kind: instance method of MemberOpening

Param Type Description
reduction_type String Reduction type (CIRCLE_OPENING, RECTANGULAR_OPENING, HEXAGONAL_OPENING)
position Number Position of opening, can be undefined (1.0 as default)
note String Note, can be undefined

# memberOpening.SetRectangleDimension(component_row, width, height)

Sets rectangle dimensions

Kind: instance method of MemberOpening

Param Type Description
component_row Number Component row for which dimension is set
width Number Width, can be undefined (100 mm as default)
height Number Height, can be undefined (100 mm as default)

# memberOpening.SetCircleDimension(component_row, diameter)

Sets circle dimension

Kind: instance method of MemberOpening

Param Type Description
component_row Number Component row for which dimension is set
diameter Number Diameter, can be undefined (50 mm as default)

# memberOpening.SetHexagonalDimension(component_row, width, height, width_center)

Sets hexagonal dimensions

Kind: instance method of MemberOpening

Param Type Description
component_row Number Component row for which dimension is set
width Number Width, can be undefined (250 mm as default)
height Number Height, can be undefined (50 mm as default)
width_center Number Center width, can be undefined (50 mm as default)

# memberOpening.SetPosition(component_row, z_axis_reference, distance)

Sets position

Kind: instance method of MemberOpening

Param Type Description
component_row Number Component row for which dimension is set
z_axis_reference Number Z-axis reference (TOP, CENTER, BOTTOM), can be undefined (CENTER as default)
distance Number Distance, can be undefined (0 mm as default)

# memberOpening.SetMultipleDefinition(component_row, multiple_number, multiple_offset_definition_type, multiple_offset)

Sets multiple definition

Kind: instance method of MemberOpening

Param Type Description
component_row Number Component row for which dimension is set
multiple_number Number Number, can be undefined (2 as default)
multiple_offset_definition_type String Offset definition type (ABSOLUTE, RELATIVE), can be undefined (ABSOLUTE as default)
multiple_offset Number Offset, can be undefined (0 m as default)

# DistancesAreAbsolute(memberResultIntermediatePoint, absolute)

Sets division ordinates as absolute (private)

Kind: global function

Param Type Description
memberResultIntermediatePoint Object Member result intermediate point to be set
absolute Boolean Division ordinates are absolute, can be undefined (default value is true)

# MemberRotationalRestraint(no, member_supports_no, restraint_type, comment, params)

Creates Member Rotational Restraint

Kind: global function

Param Type Description
no Number Index of Member Rotational Restraint, can be undefined
member_supports_no Array List of assigned member supports indexes, can be undefined
restraint_type String Rotational restraint type (CONTINUOUS, DISCRETE, MANUALLY)
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# memberRotationalRestraint.GetNo() ⇒

Kind: instance method of MemberRotationalRestraint
Returns: member rotational restraint index

# memberRotationalRestraint.GetMemberRotationalRestraint() ⇒

Kind: instance method of MemberRotationalRestraint
Returns: Member Rotational Restraint object

# memberRotationalRestraint.Continuous(no, member_supports_no, material_name, sheeting_name, position_of_sheeting, continuous_beam_effect, section_deformation_cdb, beam_spacing, comment, params)

Creates Continuous Member Rotational Restraint

Kind: instance method of MemberRotationalRestraint

Param Type Description
no Number Index of Member Rotational Restraint, can be undefined
member_supports_no Array List of assigned member supports indexes, can be undefined
material_name String Sheeting material name
sheeting_name String Sheeting name
position_of_sheeting String Position of sheeting (POSITIVE, NEGATIVE), can be undefined (POSITIVE as default)
continuous_beam_effect String Continuous beam effect, can be undefined (END_PANEL as default)
section_deformation_cdb Boolean Section deformation CD,B, can be undefined (true as default)
beam_spacing Number Beam spacing, can be undefined (3 m as default)
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# memberRotationalRestraint.Discrete(no, member_supports_no, material_name, section_name, rotational_stiffness, continuous_beam_effect, section_deformation_cdb, beam_spacing, comment, params)

Creates Discrete Member Rotational Restraint

Kind: instance method of MemberRotationalRestraint

Param Type Description
no Number Index of Member Rotational Restraint, can be undefined
member_supports_no Array List of assigned member supports indexes, can be undefined
material_name String Section material name
section_name String Section name
rotational_stiffness String Rotational stiffness CD,A, can be undefined (INFINITELY as default)
continuous_beam_effect String Continuous beam effect, can be undefined (END_PANEL as default)
section_deformation_cdb Boolean Section deformation CD,B, can be undefined (true as default)
beam_spacing Number Beam spacing, can be undefined (3 m as default)
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# memberRotationalRestraint.Manually(no, total_rotational_spring_stiffness, member_supports_no, comment, params)

Creates Manually Member Rotational Restraint

Kind: instance method of MemberRotationalRestraint

Param Type Description
no Number Index of Member Rotational Restraint, can be undefined
total_rotational_spring_stiffness Number Total rotational spring stiffness
member_supports_no Array List of assigned member supports indexes, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# memberRotationalRestraint.SetContinuousParameters(modulus_of_elasticity, sheeting_thickness, sheeting_moment_of_inertia, sheeting_distance_of_ribs, width_of_section_flange, spring_stiffness)

Sets parameters for Continuous Member Rotational Restraint

Kind: instance method of MemberRotationalRestraint

Param Type Description
modulus_of_elasticity Number Modulus of elasticity, can be undefined (default value taken from selected sheeting material)
sheeting_thickness Number Sheeting thickness, can be undefined (default value taken from selected section)
sheeting_moment_of_inertia Number Sheeting moment of inertia, can be undefined (default value taken from selected section)
sheeting_distance_of_ribs Number Sheeting distance of ribs, can be undefined (default value taken from selected section)
width_of_section_flange Number Width of sheeting flange, can be undefined (default value taken from selected section)
spring_stiffness Number Spring stiffness, can be undefined (different depending on loading as default)

# memberRotationalRestraint.SetDiscreteParameters(modulus_of_elasticity, section_moment_of_inertia, purlin_spacing, rotational_stiffness_value)

Sets parameters for Discrete Member Rotational Restraint

Kind: instance method of MemberRotationalRestraint

Param Type Description
modulus_of_elasticity Number Modulus of elasticity, can be undefined (default value taken from selected sheeting material)
section_moment_of_inertia Number Section moment of inertia, can be undefined (default value taken from selected section)
purlin_spacing Number Purling spacing
rotational_stiffness_value Number Rotational stiffness, can be undefined (only if rotational stiffness is INFINITELY)

# MemberShearPanel(no, definition_type, member_supports_no, comment, params)

Creates Member Shear Panel

Kind: global function

Param Type Description
no Number Index of Member Shear Panel, can be undefined
definition_type String Definition type (TRAPEZOIDAL_SHEETING, BRACING, TRAPEZOIDAL_SHEETING_AND_BRACING, DEFINE_S_PROV), can be undefined (TRAPEZOIDAL_SHEETING as default)
member_supports_no Array List of assigned member supports indexes, can be undefined
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# memberShearPanel.AssignMemberSupports(member_supports_no)

Assign member supports

Kind: instance method of MemberShearPanel

Param Type Description
member_supports_no Array List of assigned member supports indexes

# memberShearPanel.TrapezoidalSheeting(no, member_supports_no, position_on_section, trapezoidal_sheeting_name, fastening_arrangement, comment, params)

Creates Trapezoidal sheeting Member Shear Panel

Kind: instance method of MemberShearPanel

Param Type Description
no Number Index of Member Shear Panel, can be undefined
member_supports_no Array List of assigned member supports indexes, can be undefined
position_on_section String Position on section (UPPER_FLANGE, CENTROID, LOWER_FLANGE, DEFINE), can be undefined (UPPER_FLANGE as default)
trapezoidal_sheeting_name String Trapezoidal sheeting name
fastening_arrangement String Fastening arrangement (EVERY_RIB, EVERY_SECOND_RIB), can be undefined (EVERY_RIB as default)
comment String Comment, can be undefined
params Object Additional parameters, can be undefined

# memberShearPanel.Bracing(no, member_supports_no, position_on_section, diagonals_section_name, posts_section_name, comment, params)

Creates Bracing Member Shear Panel

Kind: instance method of MemberShearPanel

Param Type Description
no Number Index of Member Shear Panel, can be undefined
member_supports_no Array List of assigned member supports indexes, can be undefined
position_on_section String Position on section (UPPER_FLANGE, CENTROID, LOWER_FLANGE, DEFINE), can be undefined (UPPER_FLANGE as default)
diagonals_section_name String Diagonal section name
posts_section_name String Posts section name
comment String Comment, can be undefined
params Object Additional parameters

# memberShearPanel.TrapezoidalSheetingAndBracing(no, member_supports_no, position_on_section, trapezoidal_sheeting_name, fastening_arrangement, diagonals_section_name, posts_section_name, comment, params)

Creates Trapezoidal Sheeting and Bracing Member Shear Panel

Kind: instance method of MemberShearPanel

Param Type Description
no Number Index of Member Shear Panel, can be undefined
member_supports_no Array List of assigned member supports indexes, can be undefined
position_on_section String Position on section (UPPER_FLANGE, CENTROID, LOWER_FLANGE, DEFINE), can be undefined (UPPER_FLANGE as default)
trapezoidal_sheeting_name String Trapezoidal sheeting name
fastening_arrangement String Fastening arrangement (EVERY_RIB, EVERY_SECOND_RIB), can be undefined (EVERY_RIB as default)
diagonals_section_name String Diagonals section name
posts_section_name String Posts section name
comment String Comment, can be undefined
params Object Additional parameters

# memberShearPanel.DefineSProv(no, member_supports_no, position_on_section, comment, params)

Creates Define S-prov Member Shear Panel

Kind: instance method of MemberShearPanel

Param Type Description
no Number Index of Member Shear Panel, can be undefined
member_supports_no Array List of assigned member supports indexes, can be undefined
position_on_section String Position on section (UPPER_FLANGE, CENTROID, LOWER_FLANGE, DEFINE), can be undefined (UPPER_FLANGE as default)
comment String Comment, can be undefined
params Object Additional parameters

# memberShearPanel.SetTrapezoidalSheetingParameters(shear_panel_length, girder_length, beam_spacing, shear_panel_coefficient_k1, shear_panel_coefficient_k2)

Sets parameters for Trapezoidal Sheeting Member Shear Panel

Kind: instance method of MemberShearPanel

Param Type Description
shear_panel_length Number Shear panel length
girder_length Number Girder length, can be undefined (define length automatically as default)
beam_spacing Number Beam spacing
shear_panel_coefficient_k1 Number Shear panel coefficient K1, can be undefined
shear_panel_coefficient_k2 Number Shear panel coefficient K2, can be undefined

# memberShearPanel.SetBracingParameters(shear_panel_length, girder_length, beam_spacing, post_spacing, number_of_bracings, diagonals_section_area, posts_section_area)

Sets parameters for Bracing Member Shear Panel

Kind: instance method of MemberShearPanel

Param Type Description
shear_panel_length Number Shear panel length
girder_length Number Girder length, can be undefined (define length automatically as default)
beam_spacing Number Beam spacing
post_spacing Number Posts spacing
number_of_bracings Number Number of bracings, can be undefined (1 as default)
diagonals_section_area Number Diagonals section area, can be undefined
posts_section_area Number Posts section area, can be undefined

# memberShearPanel.TrapezoidalSheetingAndBracingParameters(shear_panel_length, girder_length, beam_spacing, shear_panel_coefficient_k1, shear_panel_coefficient_k2, post_spacing, number_of_bracings, diagonals_section_area, posts_section_area)

Sets parameters for Trapezoidal Sheeting and Bracing Member Shear Panel

Kind: instance method of MemberShearPanel

Param Type Description
shear_panel_length Number Shear panel length
girder_length Number Girder length, can be undefined (define length automatically as default)
beam_spacing Number Beam spacing
shear_panel_coefficient_k1 Number Shear panel coefficient K1, can be undefined
shear_panel_coefficient_k2 Number Shear panel coefficient K2, can be undefined
post_spacing Number Posts spacing
number_of_bracings Number Number of bracings, can be undefined (1 as default)
diagonals_section_area Number Diagonals section area, can be undefined
posts_section_area Number Posts section area, can be undefined

# memberShearPanel.DefineSProvParameters(shear_panel_stiffness, girder_length)

Sets parameters Define S-prov Member Shear Panel

Kind: instance method of MemberShearPanel

Param Type Description
shear_panel_stiffness Number Shear panel stiffness
girder_length Number Girder length, can be undefined (define length automatically as default)