# Loads

# FreeCircularLoad

Kind: global class

# new FreeCircularLoad(no, load_case, surfaces, comment, params)

Creates free circular load

Returns: Object - Created free circular load

Param Type Description
no Number Index of free circular load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freeCircularLoad.Uniform(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free circular uniform load

Kind: instance method of FreeCircularLoad
Returns: Object - Created free circular uniform load

Param Type Description
no Number Index of free circular uniform load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freeCircularLoad.Linear(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free circular linear load

Kind: instance method of FreeCircularLoad
Returns: Object - Created free linear uniform load

Param Type Description
no Number Index of free circular linear load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# FreeConcentratedLoad

Kind: global class

# new FreeConcentratedLoad(no, load_case, surfaces, comment, params)

Creates free concentrated load

Returns: Object - Created free concentrated load

Param Type Description
no Number Index of free concentrated load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freeConcentratedLoad.Force(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free concentrated force load

Kind: instance method of FreeConcentratedLoad
Returns: Object - Created free concentrated force load

Param Type Description
no Number Index of free concentrated force load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freeConcentratedLoad.Moment(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free concentrated moment load

Kind: instance method of FreeConcentratedLoad
Returns: Object - Created free concentrated moment load

Param Type Description
no Number Index of free concentrated moment load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# FreeLineLoad

Kind: global class

# new FreeLineLoad(no, load_case, surfaces, comment, params)

Creates free line load

Returns: Object - Created free line load

Param Type Description
no Number Index of free line load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freeLineLoad.Uniform(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free line uniform load

Kind: instance method of FreeLineLoad
Returns: Object - Created free line uniform load

Param Type Description
no Number Index of free line uniform load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freeLineLoad.Linear(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free line linear load

Kind: instance method of FreeLineLoad
Returns: Object - Created free line linear load

Param Type Description
no Number Index of free line linear load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# FreePolygonLoad

Kind: global class

# new FreePolygonLoad(no, load_case, surfaces, comment, params)

Creates free polygon load

Returns: Object - Created free polygon load

Param Type Description
no Number Index of free polygon load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freePolygonLoad.Uniform(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free polygon uniform load

Kind: instance method of FreePolygonLoad
Returns: Object - Created free polygon uniform load

Param Type Description
no Number Index of free polygon uniform load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freePolygonLoad.Linear(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free polygon linear load

Kind: instance method of FreePolygonLoad
Returns: Object - Created free polygon linear load

Param Type Description
no Number Index of free polygon linear load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freePolygonLoad.LinearX(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free polygon linear in X load

Kind: instance method of FreePolygonLoad
Returns: Object - Created free polygon linear in X load

Param Type Description
no Number Index of free polygon linear in X load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freePolygonLoad.LinearY(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free polygon linear in Y load

Kind: instance method of FreePolygonLoad
Returns: Object - Created free polygon linear in Y load

Param Type Description
no Number Index of free polygon linear in Y load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# FreeRectangularLoad

Kind: global class

# new FreeRectangularLoad(no, load_case, surfaces, comment, params)

Creates free rectangular load

Returns: Object - Created free rectangular load

Param Type Description
no Number Index of free rectangular load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freeRectangularLoad.Uniform(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free rectangular uniform load

Kind: instance method of FreeRectangularLoad
Returns: Object - Created free rectangular uniform load

Param Type Description
no Number Index of free rectangular uniform load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freeRectangularLoad.LinearX(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free rectangular linear in X load

Kind: instance method of FreeRectangularLoad
Returns: Object - Created free rectangular linear in X load

Param Type Description
no Number Index of free rectangular linear in X load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freeRectangularLoad.LinearY(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free rectangular linear in Y load

Kind: instance method of FreeRectangularLoad
Returns: Object - Created free rectangular linear in Y load

Param Type Description
no Number Index of free rectangular linear in Y load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freeRectangularLoad.VaryingZ(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free rectangular varying in Z load

Kind: instance method of FreeRectangularLoad
Returns: Object - Created free rectangular varying in Z load

Param Type Description
no Number Index of free rectangular varying in Z load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freeRectangularLoad.VaryingPerimeter(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free rectangular varying along perimeter load

Kind: instance method of FreeRectangularLoad
Returns: Object - Created free rectangular varying along perimeter load

Param Type Description
no Number Index of free rectangular varying along perimeter load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# freeRectangularLoad.VaryingZAndPerimeter(no, load_case, surfaces, load_values, load_projection, load_direction, load_acting_region_from, load_acting_region_to, comment, params) ⇒ Object

Creates free rectangular varying in Z and along perimeter load

Kind: instance method of FreeRectangularLoad
Returns: Object - Created free rectangular varying in Z and along perimeter load

Param Type Description
no Number Index of free rectangular varying in Z and along perimeter load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# ImposedLineDeformation

Kind: global class

# new ImposedLineDeformation(no, load_case, lines, comment, params)

Creates imposed line deformation

Returns: Object - Created imposed line deformation

Param Type Description
no Number Index of imposed line deformation, can be undefined
load_case Object Load case
lines Array List of lines indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# imposedLineDeformation.Set(no, load_case, lines, displacement_line_start_x, displacement_line_start_y, displacement_line_start_z, displacement_line_end_x, displacement_line_end_y, displacement_line_end_z, rotation_line_start, rotation_line_end, comment, params) ⇒ Object

Creates imposed line deformation

Kind: instance method of ImposedLineDeformation
Returns: Object - Created imposed nodal deformation

Param Type Description
no Number Index of imposed line deformation, can be undefined
load_case Object Load case
lines Array List of lines indexes
displacement_line_start_x Number Imposed displacement at line start ux,i
displacement_line_start_y Number Imposed displacement at line start uy,i, can be undefined
displacement_line_start_z Number Imposed displacement at line start uz,i, can be undefined
displacement_line_end_x Number Imposed displacement at line end ux,j, can be undefined
displacement_line_end_y Number Imposed displacement at line end uy,i, can be undefined
displacement_line_end_z Number Imposed displacement at line end uz,i, can be undefined
rotation_line_start Number Imposed rotation at line start ϕx,i, can be undefined
rotation_line_end Number Imposed rotation at line end ϕx,j, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# ImposedNodalDeformation

Kind: global class

# new ImposedNodalDeformation(no, load_case, nodes, comment, params)

Creates imposed nodal deformation

Returns: Object - Created imposed nodal deformation

Param Type Description
no Number Index of imposed nodal deformation, can be undefined
load_case Object Load case
nodes Array List of nodes indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# imposedNodalDeformation.Set(no, load_case, nodes, imposed_displacement_x, imposed_displacement_y, imposed_displacement_z, imposed_rotation_x, imposed_rotation_y, imposed_rotation_z, comment, params) ⇒ Object

Creates imposed nodal deformation

Kind: instance method of ImposedNodalDeformation
Returns: Object - Created imposed nodal deformation

Param Type Description
no Number Index of imposed nodal deformation, can be undefined
load_case Object Load case
nodes Array List of nodes indexes
imposed_displacement_x Number Imposed displacement uX'
imposed_displacement_y Number Imposed displacement uY', can be undefined
imposed_displacement_z Number Imposed displacement uZ', can be undefined
imposed_rotation_x Number Imposed rotation ϕX', can be undefined
imposed_rotation_y Number Imposed rotation ϕY', can be undefined
imposed_rotation_z Number Imposed rotation ϕZ', can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# LineLoad

Kind: global class

# new LineLoad(no, load_case, lines, comment, params)

Creates line load

Returns: Object - Created line load

Param Type Description
no Number Index of line load, can be undefined
load_case Object Load case
lines Array List of line indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# lineLoad.Force(no, load_case, lines, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates line force load

Kind: instance method of LineLoad
Returns: Object - Created line force load

Param Type Description
no Number Index of line load, can be undefined
load_case Object Load case
lines Array List of lines
load_distribution String Load distribution
load_values Array Load values depend on load distribution (for more information look at setLineLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# lineLoad.Moment(no, load_case, lines, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates line moment load

Kind: instance method of LineLoad
Returns: Object - Created line moment load

Param Type Description
no Number Index of line load, can be undefined
load_case Object Load case
lines Array List of lines
load_distribution String Load distribution
load_values Array Load values depend on load distribution (for more information look at setLineLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# lineLoad.Mass(no, load_case, lines, load_value, comment, params) ⇒ Object

Creates line mass load

Kind: instance method of LineLoad
Returns: Object - Created line mass load

Param Type Description
no Number Index of line load, can be undefined
load_case Object Load case
lines Array List of lines
load_value Number Uniform load value
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# lineLoad.ReferenceToListOfLines(value)

Sets option for reference to list of lines

Kind: instance method of LineLoad

Param Type Description
value Boolean When undefined, true as default

# lineLoad.ReferDistanceLineEnd(value)

Sets option for refer distance to the line end

Kind: instance method of LineLoad

Param Type Description
value Boolean When undefined, true as default

# lineLoad.LoadOverLine(value)

Sets option for load over total length of line (only for trapezoidal load distribution)

Kind: instance method of LineLoad

Param Type Description
value Boolean When undefined, true as default

# lineLoad.IndividualMassComponents(MX, MY, MZ)

Sets individual mass components (only for mass load)

Kind: instance method of LineLoad

Param Type Description
MX Number Mass in X coordination, can be undefined
MY Number Mass in Y coordination, can be undefined
MZ Number Mass in Z coordination, can be undefined

# LineSetLoad

Kind: global class

# new LineSetLoad(no, load_case, line_sets, comment, params)

Creates line set load

Returns: Object - Created line set load

Param Type Description
no Number Index of line set load, can be undefined
load_case Object Load case
line_sets Array List of line sets indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# lineSetLoad.Force(no, load_case, line_sets, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates line set force load

Kind: instance method of LineSetLoad
Returns: Object - Created line set force load

Param Type Description
no Number Index of line set load, can be undefined
load_case Object Load case
line_sets Array List of line sets
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setLineLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# lineSetLoad.Moment(no, load_case, line_sets, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates line set moment load

Kind: instance method of LineSetLoad
Returns: Object - Created line set moment load

Param Type Description
no Number Index of line set load, can be undefined
load_case Object Load case
line_sets Array List of line sets
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setLineLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# lineSetLoad.Mass(no, load_case, line_sets, load_value, comment, params) ⇒ Object

Creates line set mass load

Kind: instance method of LineSetLoad
Returns: Object - Created line set mass load

Param Type Description
no Number Index of line set load, can be undefined
load_case Object Load case
line_sets Array List of line sets
load_value Number Uniform parameter value
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# lineSetLoad.ReferDistanceLineSetEnd(value)

Sets option for refer distance to the end of line set

Kind: instance method of LineSetLoad

Param Type Description
value Boolean When undefined, true as default

# lineSetLoad.LoadOverLineSet(value)

Sets option for load over total length of line set (only for trapezoidal load distribution)

Kind: instance method of LineSetLoad

Param Type Description
value Boolean When undefined, true as default

# lineSetLoad.IndividualMassComponents(MX, MY, MZ)

Sets individual mass components (only for mass load)

Kind: instance method of LineSetLoad

Param Type Description
MX Number Mass in X coordination, can be undefined
MY Number Mass in Y coordination, can be undefined
MZ Number Mass in Z coordination, can be undefined

# MemberLoad

Kind: global class

# new MemberLoad(no, load_case, members, comment, params)

Creates member load

Returns: Object - Created member load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.Force(no, load_case, members, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member force load

Kind: instance method of MemberLoad
Returns: Object - Created member force load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.Moment(no, load_case, members, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member moment load

Kind: instance method of MemberLoad
Returns: Object - Created member moment load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.Mass(no, load_case, members, load_value, comment, params) ⇒ Object

Creates member mass load

Kind: instance method of MemberLoad
Returns: Object - Created member mass load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_value Number Uniform load parameter
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.Temperature(no, load_case, members, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member temperature load

Kind: instance method of MemberLoad
Returns: Object - Created member temperature load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.TemperatureChange(no, load_case, members, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member temperature change load

Kind: instance method of MemberLoad
Returns: Object - Created member temperature change load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.AxialStrain(no, load_case, members, load_distribution, load_values, comment, params) ⇒ Object

Creates member axial strain load

Kind: instance method of MemberLoad
Returns: Object - Created member axial strain load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.AxialDisplacement(no, load_case, members, load_value, comment, params) ⇒ Object

Creates member axial displacement load

Kind: instance method of MemberLoad
Returns: Object - Created member axial displacement load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_value Number Uniform load parameter
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.Precamber(no, load_case, members, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member precamber load

Kind: instance method of MemberLoad
Returns: Object - Created member precamber load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.InitialPrestress(no, load_case, members, load_value, comment, params) ⇒ Object

Creates member initial prestress load

Kind: instance method of MemberLoad
Returns: Object - Created member initial prestress load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_value Number Uniform load parameter
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.Displacement(no, load_case, members, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member displacement load

Kind: instance method of MemberLoad
Returns: Object - Created member displacement load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.Rotation(no, load_case, members, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member rotation load

Kind: instance method of MemberLoad
Returns: Object - Created member rotation load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.PipeContentFull(no, load_case, members, load_value, load_direction, comment, params) ⇒ Object

Creates member content full load

Kind: instance method of MemberLoad
Returns: Object - Created member pipe content full load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_value Number Uniform load parameter
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.PipeContentPartial(no, load_case, members, load_values, load_direction, comment, params) ⇒ Object

Creates member pipe content partial load

Kind: instance method of MemberLoad
Returns: Object - Created member pipe content partial load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_values Array Load parameters for Uniform distribution
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.PipeInternalPressure(no, load_case, members, load_value, comment, params) ⇒ Object

Creates member pipe internal pressure load

Kind: instance method of MemberLoad
Returns: Object - Created member pipe internal pressure load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_value Number Uniform load parameter
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.RotaryMotion(no, load_case, members, load_values, comment, params) ⇒ Object

Creates member rotary motion load

Kind: instance method of MemberLoad
Returns: Object - Created member rotary motion load

Param Type Description
no Number Index of member load, can be undefined
load_case Object Load case
members Array List of member indexes
load_values Number Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberLoad.ReferenceToListOfMembers(value)

Sets option for reference to list of members

Kind: instance method of MemberLoad

Param Type Description
value Boolean When undefined, true as default

# memberLoad.ReferDistanceMemberEnd(value)

Sets option for refer distance to the member end

Kind: instance method of MemberLoad

Param Type Description
value Boolean When undefined, true as default

# memberLoad.LoadOverMember(value)

Sets option for load over total length of member (only for trapezoidal load distribution)

Kind: instance method of MemberLoad

Param Type Description
value Boolean When undefined, true as default

# memberLoad.Eccentricity(reference_to, offset_member_start_ey, offset_member_start_ez, offset_member_end_ey, offset_member_end_ez)

Sets eccentricity (only force load)

Kind: instance method of MemberLoad

Param Type Description
reference_to String Eccentricity is refereed to what ("LEFT_TOP", "CENTER_TOP", "RIGHT_TOP", "LEFT_CENTER", "CENTER_CENTER", "RIGHT_CENTER", "LEFT_BOTTOM", "CENTER_BOTTOM", "RIGHT_BOTTOM", "CENTER_OF_GRAVITY", "SHEAR_CENTER")
offset_member_start_ey Number Offset at member start, can be undefined
offset_member_start_ez Number Offset at member start, can be undefined
offset_member_end_ey Number Offset at member end, can be undefined
offset_member_end_ez Number Offset at member end, can be undefined

# memberLoad.IndividualMassComponents(MX, MY, MZ)

Sets individual mass components (only for mass load)

Kind: instance method of MemberLoad

Param Type Description
MX Number Mass in X coordination, can be undefined
MY Number Mass in Y coordination, can be undefined
MZ Number Mass in Z coordination, can be undefined

# MemberSetLoad

Kind: global class

# new MemberSetLoad(no, load_case, member_sets, comment, params)

Creates member set load

Returns: Object - Created member set load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member sets indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.Force(no, load_case, member_sets, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member set force load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set force load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member sets indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.Moment(no, load_case, member_sets, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member set moment load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set moment load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member sets indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.Mass(no, load_case, member_sets, load_value, comment, params) ⇒ Object

Creates member set mass load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set mass load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member sets indexes
load_value Number Uniform load parameter
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.Temperature(no, load_case, member_sets, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member set temperature load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set temperature load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.TemperatureChange(no, load_case, member_sets, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member set temperature change load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set temperature change load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member set indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.AxialStrain(no, load_case, member_sets, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member set axial strain load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set axial strain load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member set indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.AxialDisplacement(no, load_case, member_sets, load_value, comment, params) ⇒ Object

Creates member set axial displacement load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set axial displacement load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member sets indexes
load_value Number Uniform load parameter
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.Precamber(no, load_case, member_sets, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member set precamber load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set precamber load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member sets indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.InitialPrestress(no, load_case, member_sets, load_value, comment, params) ⇒ Object

Creates member set initial prestress load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set initial prestress load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member set indexes
load_value Number Uniform load parameter
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.Displacement(no, load_case, member_sets, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member set displacement load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set displacement load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member set indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.Rotation(no, load_case, member_sets, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates member set rotation load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set rotation load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member set indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.PipeContentFull(no, load_case, member_sets, load_value, load_direction, comment, params) ⇒ Object

Creates member set content full load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set pipe content full load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member sets indexes
load_value Number Uniform load parameter
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.PipeContentPartial(no, load_case, member_sets, load_values, load_direction, comment, params) ⇒ Object

Creates member set pipe content partial load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set pipe content partial load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member set indexes
load_values Array Load parameters for Uniform distribution
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.PipeInternalPressure(no, load_case, member_sets, load_value, comment, params) ⇒ Object

Creates member set pipe internal pressure load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set pipe internal pressure load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member set indexes
load_value Number Uniform load parameter
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.RotaryMotion(no, load_case, member_sets, load_values, comment, params) ⇒ Object

Creates member set rotary motion load

Kind: instance method of MemberSetLoad
Returns: Object - Created member set rotary motion load

Param Type Description
no Number Index of member set load, can be undefined
load_case Object Load case
member_sets Array List of member set indexes
load_values Number Load parameters depend on load distribution (for more information look at setMemberLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# memberSetLoad.ReferDistanceMemberSetEnd(value)

Sets option for refer distance to the member set end

Kind: instance method of MemberSetLoad

Param Type Description
value Boolean When undefined, true as default

# memberSetLoad.LoadOverMember(value)

Sets option for load over total length of member set (only for trapezoidal load distribution)

Kind: instance method of MemberSetLoad

Param Type Description
value Boolean When undefined, true as default

# memberSetLoad.Eccentricity(reference_to, offset_member_start_ey, offset_member_start_ez, offset_member_end_ey, offset_member_end_ez)

Sets eccentricity (only force load)

Kind: instance method of MemberSetLoad

Param Type Description
reference_to String Eccentricity is refereed to what ("left_top", "center_top", "right_top", "left_center", "center_center", "right_center", "left_bottom", "center_bottom", "right_bottom", "center_of_gravity", "shear_center")
offset_member_start_ey Number Offset at member start, can be undefined
offset_member_start_ez Number Offset at member start, can be undefined
offset_member_end_ey Number Offset at member end, can be undefined
offset_member_end_ez Number Offset at member end, can be undefined

# memberSetLoad.IndividualMassComponents(MX, MY, MZ)

Sets individual mass components (only for mass load)

Kind: instance method of MemberSetLoad

Param Type Description
MX Number Mass in X coordination, can be undefined
MY Number Mass in Y coordination, can be undefined
MZ Number Mass in Z coordination, can be undefined

# NodalLoad

Kind: global class

# new NodalLoad(no, load_case, nodes, comment, params)

Creates nodal load

Returns: Object - Created nodal load

Param Type Description
no Number Index of nodal load, can be undefined
load_case Object Load case
nodes Array List of node indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# nodalLoad.Force(no, load_case, nodes, force, load_direction, comment, params) ⇒ Object

Creates nodal force load

Kind: instance method of NodalLoad
Returns: Object - Created nodal force load

Param Type Description
no Number Index of nodal load, can be undefined
load_case Object Load case
nodes Array List of node indexes
force Number Load force value
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# nodalLoad.Moment(no, load_case, nodes, moment, load_direction, comment, params) ⇒ Object

Creates nodal moment load

Kind: instance method of NodalLoad
Returns: Object - Created nodal moment load

Param Type Description
no Number Index of nodal load, can be undefined
load_case Object Load case
nodes Array List of node indexes
moment Number Load moment value
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# nodalLoad.Components(no, load_case, nodes, forces, moments, comment, params) ⇒ Object

Creates nodal moment load

Kind: instance method of NodalLoad
Returns: Object - Create nodal components load

Param Type Description
no Number Index of nodal load, can be undefined
load_case Object Load case
nodes Array List of node indexes
forces Array List of forces [FX, FX, FY]
moments Array List of moments [MX, MY, MZ]
comment String Comment, van be undefined
params Object Load parameters, can be undefined

# nodalLoad.Mass(no, load_case, nodes, mass, comment, params) ⇒ Object

Creates nodal moment load

Kind: instance method of NodalLoad
Returns: Object - Create nodal mass load

Param Type Description
no Number Index of nodal load, can be undefined
load_case Object Load case
nodes Array List of node indexes
mass Number Load mass value
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# nodalLoad.SpecificDirection(type, values)

Adds specific direction to load

Kind: instance method of NodalLoad

Param Type Description
type Number Specific direction type, can be one of: - 1 (Rotated view 3 angles) - 2 (Directed to node) - 3 (Parallel to two nodes) - 4 (Parallel to CS of line) - 4 (Parallel to CS of line) - 5 (Parallel to CS of member)
values Array List of values for specified direction: - [αX',αY',αZ',sequence] (for 1), example: [0.1,0.2,0.1,"X'Y'Z'"], sequence can be empty by default - [node_index] (for 2) - [node1_index, node2_index] (for 3) - [line_no] (for 4) - [member_no] (for 5)

# nodalLoad.ForceEccentricity(eccentricity_x, eccentricity_y, eccentricity_z)

Adds eccentricity to load

Kind: instance method of NodalLoad

Param Type Description
eccentricity_x Number Eccentricity eX
eccentricity_y Number Eccentricity eY
eccentricity_z Number Eccentricity eZ

# nodalLoad.ShiftedDisplay(offset, distance)

Adds shifted display to load

Kind: instance method of NodalLoad

Param Type Description
offset Array Offset [ΔX,ΔY,ΔZ], example [0.1,0.2,0]
distance Number Distance Δ

# nodalLoad.IndividualMassComponents(mass, distance)

Adds individual mass components to load

Kind: instance method of NodalLoad

Param Type Description
mass Array mass [MX,MY,MZ], example [0.1,0.2,0]
distance Number mass_moment_of_inertia [IX,IY,IZ], example [0.1,0.2,0] -

# OpeningLoad

Kind: global class

# new OpeningLoad(no, load_case, openings, comment, params)

Creates solid load

Returns: Object - Created opening load

Param Type Description
no Number Index of opening load, can be undefined
load_case Object Load case
openings Array List of opening indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# openingLoad.Force(no, load_case, openings, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates opening force load

Kind: instance method of OpeningLoad
Returns: Object - Created opening force load

Param Type Description
no Number Index of opening load, can be undefined
load_case Object Load case
openings Array List of openings indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# openingLoad.SmoothConcentratedLoad(value,)

Set smooth concentrated load

Kind: instance method of OpeningLoad

Param Type Description
value, Boolean can be undefined (false)

# SolidLoad

Kind: global class

# new SolidLoad(no, load_case, solids, comment, params)

Creates solid load

Returns: Object - Created solid load

Param Type Description
no Number Index of solid load, can be undefined
load_case Object Load case
solids Array List of solid indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# solidLoad.Force(no, load_case, solids, load_value, load_direction, comment, params) ⇒ Object

Creates solid force load

Kind: instance method of SolidLoad
Returns: Object - Created solid force load

Param Type Description
no Number Index of solid load, can be undefined
load_case Object Load case
solids Array List of solid indexes
load_value Array Uniform load parameter
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# solidLoad.Temperature(no, load_case, solids, load_distribution, load_values, comment, params) ⇒ Object

Creates solid temperature load

Kind: instance method of SolidLoad
Returns: Object - Created solid temperature load

Param Type Description
no Number Index of solid load, can be undefined
load_case Object Load case
solids Array List of solid indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setSolidLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# solidLoad.Strain(no, load_case, solids, load_distribution, load_values, comment, params) ⇒ Object

Creates solid strain load

Kind: instance method of SolidLoad
Returns: Object - Created solid strain load

Param Type Description
no Number Index of solid load, can be undefined
load_case Object Load case
solids Array List of solid indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setSolidLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# solidLoad.Buoyancy(no, load_case, solids, load_value, load_direction, comment, params) ⇒ Object

Creates solid buoyancy load

Kind: instance method of SolidLoad
Returns: Object - Created solid buoyancy load

Param Type Description
no Number Index of solid load, can be undefined
load_case Object Load case
solids Array List of solid indexes
load_value Array Uniform load parameter
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# solidLoad.RotaryMotion(no, load_case, solids, load_values, comment, params) ⇒ Object

Creates solid rotary motion load

Kind: instance method of SolidLoad
Returns: Object - Created solid rotary motion load

Param Type Description
no Number Index of solid load, can be undefined
load_case Object Load case
solids Array List of solid indexes
load_values Array Load parameters depend on load distribution (for more information look at setSolidLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# solidLoad.AirDensity(altitude)

Determine air density at specified altitude

Kind: instance method of SolidLoad

Param Type Description
altitude Number Altitude value, if undefined, determine air density at specified altitude will be set false

# SolidSetLoad

Kind: global class

# new SolidSetLoad(no, load_case, solid_sets, comment, params)

Creates solid set load

Returns: Object - Created solid set load

Param Type Description
no Number Index of solid set load, can be undefined
load_case Object Load case
solid_sets Array List of solid set indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# solidSetLoad.Force(no, load_case, solid_sets, load_value, load_direction, comment, params) ⇒ Object

Creates solid set force load

Kind: instance method of SolidSetLoad
Returns: Object - Created solid set force load

Param Type Description
no Number Index of solid set load, can be undefined
load_case Object Load case
solid_sets Array List of solid set indexes
load_value Array Uniform load parameter
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# solidSetLoad.Temperature(no, load_case, solid_sets, load_distribution, load_values, comment, params) ⇒ Object

Creates solid set temperature load

Kind: instance method of SolidSetLoad
Returns: Object - Created solid set temperature load

Param Type Description
no Number Index of solid set load, can be undefined
load_case Object Load case
solid_sets Array List of solid set indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setSolidLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# solidSetLoad.Strain(no, load_case, solid_sets, load_distribution, load_values, comment, params) ⇒ Object

Creates solid set strain load

Kind: instance method of SolidSetLoad
Returns: Object - Created solid set strain load

Param Type Description
no Number Index of solid set load, can be undefined
load_case Object Load case
solid_sets Array List of solid set indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setSolidLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# solidSetLoad.Buoyancy(no, load_case, solid_sets, load_value, load_direction, comment, params) ⇒ Object

Creates solid set buoyancy load

Kind: instance method of SolidSetLoad
Returns: Object - Created solid set buoyancy load

Param Type Description
no Number Index of solid set load, can be undefined
load_case Object Load case
solid_sets Array List of solid set indexes
load_value Array Uniform load parameter
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# solidSetLoad.RotaryMotion(no, load_case, solid_sets, load_values, comment, params) ⇒ Object

Creates solid set rotary motion load

Kind: instance method of SolidSetLoad
Returns: Object - Created solid set rotary motion load

Param Type Description
no Number Index of solid set load, can be undefined
load_case Object Load case
solid_sets Array List of solid set indexes
load_values Array Load parameters depend on load distribution (for more information look at setSolidLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# solidSetLoad.AirDensity(altitude)

Determine air density at specified altitude

Kind: instance method of SolidSetLoad

Param Type Description
altitude Number Altitude value, if undefined, determine air density at specified altitude will be set false

# SurfaceLoad

Kind: global class

# new SurfaceLoad(no, load_case, surfaces, comment, params)

Creates surface load

Returns: Object - Created surface load

Param Type Description
no Number Index of surface load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceLoad.Force(no, load_case, surfaces, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates surface force load

Kind: instance method of SurfaceLoad
Returns: Object - Created surface force load

Param Type Description
no Number Index of surface load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setSurfaceLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceLoad.Temperature(no, load_case, surfaces, load_distribution, load_values, comment, params) ⇒ Object

Creates surface temperature load

Kind: instance method of SurfaceLoad
Returns: Object - Created surface temperature load

Param Type Description
no Number Index of surface load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setSurfaceLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceLoad.AxialStrain(no, load_case, surfaces, load_distribution, load_values, comment, params) ⇒ Object

Creates surface axial strain load

Kind: instance method of SurfaceLoad
Returns: Object - Created surface axial strain load

Param Type Description
no Number Index of surface load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setSurfaceLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceLoad.Precamber(no, load_case, surfaces, load_value, comment, params) ⇒ Object

Creates surface precamber load

Kind: instance method of SurfaceLoad
Returns: Object - Created surface precamber load

Param Type Description
no Number Index of surface load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_value Array Uniform load parameter
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceLoad.RotaryMotion(no, load_case, surfaces, load_values, comment, params) ⇒ Object

Creates surface rotary motion load

Kind: instance method of SurfaceLoad
Returns: Object - Created surface rotary motion load

Param Type Description
no Number Index of surface load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_values Array Load parameters depend on load distribution (for more information look at setSurfaceLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceLoad.Mass(no, load_case, surfaces, load_value, comment, params) ⇒ Object

Creates surface mass load

Kind: instance method of SurfaceLoad
Returns: Object - Created surface mass load

Param Type Description
no Number Index of surface load, can be undefined
load_case Object Load case
surfaces Array List of surface indexes
load_value Array Uniform load parameter
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceLoad.IndividualMassComponents(MX, MY, MZ)

Sets individual mass components (only for mass load)

Kind: instance method of SurfaceLoad

Param Type Description
MX Number Mass in X coordination, can be undefined
MY Number Mass in Y coordination, can be undefined
MZ Number Mass in Z coordination, can be undefined

# SurfaceSetLoad

Kind: global class

# new SurfaceSetLoad(no, load_case, line_sets, comment, params)

Creates line set load

Returns: Object - Created line set load

Param Type Description
no Number Index of line set load, can be undefined
load_case Object Load case
line_sets Array List of line set indexes
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceSetLoad.Force(no, load_case, surface_sets, load_distribution, load_values, load_direction, comment, params) ⇒ Object

Creates surface set force load

Kind: instance method of SurfaceSetLoad
Returns: Object - Created surface set force load

Param Type Description
no Number Index of surface set load, can be undefined
load_case Object Load case
surface_sets Array List of surface set indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setSurfaceLoadDistribution function)
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceSetLoad.Temperature(no, load_case, surface_sets, load_distribution, load_values, comment, params) ⇒ Object

Creates surface set temperature load

Kind: instance method of SurfaceSetLoad
Returns: Object - Created surface set temperature load

Param Type Description
no Number Index of surface set load, can be undefined
load_case Object Load case
surface_sets Array List of surface set indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setSurfaceLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceSetLoad.AxialStrain(no, load_case, surface_sets, load_distribution, load_values, comment, params) ⇒ Object

Creates surface set axial strain load

Kind: instance method of SurfaceSetLoad
Returns: Object - Created surface set axial strain load

Param Type Description
no Number Index of surface set load, can be undefined
load_case Object Load case
surface_sets Array List of surface set indexes
load_distribution String Load distribution
load_values Array Load parameters depend on load distribution (for more information look at setSurfaceLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceSetLoad.Precamber(no, load_case, surface_sets, load_value, comment, params) ⇒ Object

Creates surface set precamber load

Kind: instance method of SurfaceSetLoad
Returns: Object - Created surface set precamber load

Param Type Description
no Number Index of surface set load, can be undefined
load_case Object Load case
surface_sets Array List of surface set indexes
load_value Array Uniform load parameter
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceSetLoad.RotaryMotion(no, load_case, surface_sets, load_values, comment, params) ⇒ Object

Creates surface set rotary motion load

Kind: instance method of SurfaceSetLoad
Returns: Object - Created surface set rotary motion load

Param Type Description
no Number Index of surface set load, can be undefined
load_case Object Load case
surface_sets Array List of surface set indexes
load_values Array Load parameters depend on load distribution (for more information look at setSurfaceLoadDistribution function)
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceSetLoad.Mass(no, load_case, surface_sets, load_value, comment, params) ⇒ Object

Creates surface set mass load

Kind: instance method of SurfaceSetLoad
Returns: Object - Created surface set mass load

Param Type Description
no Number Index of surface set load, can be undefined
load_case Object Load case
surface_sets Array List of surface set indexes
load_value Array Uniform load parameter
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# surfaceSetLoad.IndividualMassComponents(MX, MY, MZ)

Sets individual mass components (only for mass load)

Kind: instance method of SurfaceSetLoad

Param Type Description
MX Number Mass in X coordination, can be undefined
MY Number Mass in Y coordination, can be undefined
MZ Number Mass in Z coordination, can be undefined

# createBaseLoad(load_type, no, load_case, index_list, comment, params) ⇒ Object

Creates load based on its type

Kind: global function
Returns: Object - Created load

Param Type Description
load_type Number Load type
no Number Index of load, can be undefined
load_case Object Load case
index_list Array List of assigned objects (indexes), can be empty
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# createSimplyValueLoad(load_type, no, load_case, nodes, force, moment, mass, load_direction, comment, params) ⇒ Object

Creates load with one only value (force, mass and so on)

Kind: global function
Returns: Object - Created load

Param Type Description
load_type Number Load type
no Number Index of nodal load, can be undefined
load_case Object Load case
nodes Array List of node indexes, can be undefined
force Number Load force value, can be undefined
moment Number Load moment value, can be undefined
mass Number Load mass value, can be undefined
load_direction String Load direction, can be undefined
comment String Comment, can be undefined
params Object Load parameters, can be undefined

# showLoadAssert(load_type, load_distribution)

Shows assert (private)

Kind: global function

Param Type Description
load_type String Load type
load_distribution String Load distribution, can be undefined

# setLoadValues(arguments)

Set load parameters

Kind: global function

Param Type Description
arguments Array Arguments: arg[0] - load, arg[1] - load parameters, arg[2] - load parameters to be set

# setAxis(load, value) ⇒ Boolean

Sets axis for rotary motion load type

Kind: global function
Returns: Boolean - True if axis and orientation was successfully set

Param Type Description
load Object Load
value String Parallel axis (X, Y, Z)

# setAxisAndOrientation(load, value) ⇒ Boolean

Sets axis and orientation for rotary motion load type

Kind: global function
Returns: Boolean - True if axis and orientation was successfully set

Param Type Description
load Object Load
value String Parallel axis (+X, -X, ...)

# setLineLoadDistribution(load, load_type, load_distribution, load_values) ⇒ Object

Function assigns parameters to line / line set load depend of load type and load distribution (private)

Kind: global function
Returns: Object - Returns modified load

Param Type Description
load Object Load
load_type String Load type
load_distribution String Load distribution
load_values Array Load parameters depend on load type and load distribution - (load type / load distribution: [valid values]) - "Force" / "Uniform": [p] - "Force" / "Uniform - Total": [P] - "Force" / "Concentrated - 1": [P, A, is_a_relative] - "Force" / "Concentrated - n x": [P, n, A, B, is_a_relative, is_b_relative] - "Force" / "Concentrated - 2 x 2": [P, A, B, C, is_a_relative, is_b_relative, is_c_relative] - "Force" / "Concentrated - 2 x": [P1, A, P2, B, is_a_relative, is_b_relative] - "Force" / "Concentrated - Varying": [P1, x1, P2, x2 ... Pn, xn] - "Force" / "Trapezoidal": [p1, B, p2, A, is_b_relative, is_a_relative] - "Force" / "Tapered": [p1, p2, A, B, is_a_relative, is_b_relative] - "Force" / "Parabolic": [p1, p2, p3] - "Force" / "Varying": [p1, x1, p2, x2 ... pn, xn] - "Force" / "Varying in Z": [p1, z1, p2, z2 ... pn, zn] - "Moment" / "Uniform" (load type / load distribution): [m] - "Moment" / "Concentrated - 1": [M, A, is_a_relative] - "Moment" / "Concentrated - n x": [M, n, A, B, is_a_relative, is_b_relative] - "Moment" / "Concentrated - 2 x 2": [M, A, B, C, is_a_relative, is_b_relative, is_c_relative] - "Moment" / "Concentrated - 2 x": [M1, A, M2, B, is_a_relative, is_b_relative] - "Moment" / "Concentrated - Varying": [M1, x1, M2, x2 ... Mn, xn] - "Moment" / "Trapezoidal": [m1, B, m2, A, is_b_relative, is_a_relative] - "Moment" / "Tapered": [m1, m2, A, B, is_a_relative, is_b_relative] - "Moment" / "Parabolic": [m1, m2, m3] - "Moment" / "Varying": [m1, x1, m2, x2 ... mn, xn] - "Mass" / "Uniform": M

# setMemberLoadDistribution(load, load_type, load_distribution, load_values) ⇒ Object

Function assigns parameters to member / member set load depend of load type and load distribution (private)

Kind: global function
Returns: Object - Returns modified load

Param Type Description
load Object Load
load_type String Load type
load_distribution String Load distribution, can be undefined
load_values Array Load parameters depend on load type and load distribution - (load type / load distribution: [valid values]) - "Force" / "Uniform": [p] - "Force" / "Uniform - Total": [P] - "Force" / "Concentrated - 1": [P, A, is_a_relative] - "Force" / "Concentrated - n x": [P, n, A, B, is_a_relative, is_b_relative] - "Force" / "Concentrated - 2 x 2": [P, A, B, C, is_a_relative, is_b_relative, is_c_relative] - "Force" / "Concentrated - 2 x": [P1, A, P2, B, is_a_relative, is_b_relative] - "Force" / "Concentrated - Varying": [P1, x1, P2, x2 ... Pn, xn] - "Force" / "Trapezoidal": [p1, B, p2, A, is_b_relative, is_a_relative] - "Force" / "Tapered": [p1, p2, A, B, is_a_relative, is_b_relative] - "Force" / "Parabolic": [p1, p2, p3] - "Force" / "Varying": [p1, x1, p2, x2, ... pn, xn] - "Force" / "Varying in Z": [p1, z1, p2, z2 ... pn, zn] - "Moment" / "Uniform" (load type / load distribution): [m] - "Moment" / "Concentrated - 1": [M, A, is_a_relative] - "Moment" / "Concentrated - n x": [M, n, A, B, is_a_relative, is_b_relative] - "Moment" / "Concentrated - 2 x 2": [M, A, B, C, is_a_relative, is_b_relative, is_c_relative] - "Moment" / "Concentrated - 2 x": [M1, A, M2, B, is_a_relative, is_b_relative] - "Moment" / "Concentrated - Varying": [M1, x1, M2, x2 ... Mn, xn] - "Moment" / "Trapezoidal": [m1, B, m2, A, is_b_relative, is_a_relative] - "Moment" / "Tapered": [m1, m2, A, B, is_a_relative, is_b_relative] - "Moment" / "Parabolic": [m1, m2, m3] - "Moment" / "Varying": [m1, x1, m2, x2, ... mn, xn] - "Mass" / "Uniform": M - "Temperature" / "Uniform": [Tt, Tb] - "Temperature" / "Trapezoidal": [Tt1, B, Tb1, Tt2, Tb2, A, is_b_relative, is_a_relative] - "Temperature" / "Tapered": [Tt1, Tb1, Tt2, Tb2, A, B, is_a_relative, is_b_relative] - "Temperature" / "Parabolic": [Tt1, Tb1, Tt2, Tb2, Tt3, Tb3] - "Temperature" / "Varying": [Tt1, Tb1, x1, Tt2, Tb2, x2 ... Ttn, Tbn, xn] - "Temperature Change" / "Uniform": [Tc, ΔT] - "Temperature Change" / "Trapezoidal": [Tc1, B, ΔT1, Tc2, ΔT2, A, is_b_relative, is_a_relative] - "Temperature Change" / "Tapered": [Tc1, ΔT1, ΔT2, ΔT2, A, B, is_a_relative, is_b_relative] - "Temperature Change" / "Parabolic": [Tt1, ΔT1, Tt2, ΔT2, Tt3, ΔT3] - "Temperature Change" / "Varying": [Tc1, ΔT1, x1, Tc2, ΔT2, x2 ... Tcn, ΔTn, xn] - "Axial Strain" / "Uniform": [ε] - "Axial Strain" / "Trapezoidal": [ε1, B, ε2, A, is_b_relative, is_a_relative] - "Axial Strain" / "Tapered": [ε1, ε2, A, B, is_a_relative, is_b_relative] - "Axial Strain" / "Parabolic": [ε1, ε2, ε3] - "Axial Strain" / Varying": [ε1, x1, ε2, x2, ... εn, xn] - "Axial Displacement" / "Uniform": Δl - "Precamber" / "Uniform": [κ] - "Precamber" / "Trapezoidal": [κ1, B, κ2, A, is_b_relative, is_a_relative] - "Precamber" / "Tapered": [κ1, A, κ2, B, is_a_relative, is_a_relative] - "Precamber" / "Parabolic": [κ1, κ2, κ3] - "Precamber" / "Varying": [κ1, x1, κ2, x2, ... κn, xn] - "Initial Prestress" / "Uniform": V - "Displacement" / "Uniform": [δ] - "Displacement" / "Concentrated - 1": [Δ, A, is_a_relative] - "Displacement" / "Concentrated - n x": [Δ, n, A, B, is_a_relative, is_b_relative] - "Displacement" / "Concentrated - 2 x 2": [Δ, A, B, C, is_a_relative, is_b_relative, is_c_relative] - "Displacement" / "Concentrated - 2 x": [Δ1, Δ2, A, B, is_a_relative, is_b_relative] - "Displacement" / "Concentrated - Varying": [Δ1, x1, Δ2, x2 ... Δn, xn] - "Displacement" / "Trapezoidal": [δ1, B, δ2, A, is_b_relative, is_a_relative] - "Displacement" / "Tapered": [δ1, δ2, A, B, is_a_relative, is_b_relative] - "Displacement" / "Parabolic": [δ1, δ2, δ3] - "Displacement" / "Varying": [δ1, x1, δ2, x2, ... δn, xn] - "Rotation" / "Uniform": [φ] - "Rotation" / "Concentrated - 1": [φ, A, is_a_relative] - "Rotation" / "Concentrated - n x": [φ, n, A, B, is_a_relative, is_b_relative] - "Rotation" / "Concentrated - 2 x 2": [φ, A, B, C, is_a_relative, is_b_relative, is_c_relative] - "Rotation" / "Concentrated - 2 x": [φ1, A, φ2, B, is_a_relative, is_b_relative] - "Rotation" / "Concentrated - Varying": [φ1, x1, φ2, x2 ... φn, xn] - "Rotation" / "Trapezoidal": [φ1, B, φ2, A, is_b_relative, is_a_relative] - "Rotation" / "Tapered": [φ1, φ2, A, B, is_a_relative, is_b_relative] - "Rotation" / "Parabolic": [φ1, φ2, φ3] - "Rotation" / "Varying": [φ1, x1, φ2, x2, ... φn, xn] - "Pipe Content - Full" / "Uniform": γ - "Pipe Content - Partial" / "Uniform": [γ, d] - "Pipe Internal Pressure" / "Uniform": p - "Rotary Motion": [axis_definition, ω, α, [Node1, Node2] or XA, YA, ZA, XB, YB, ZB] (axis definition 1 === "Two points") [axis_definition, ω, α, ([Node1] or XA, YA, ZA), parallel_axis] (axis definition 2 === "Point and axis")

# setSurfaceLoadDistribution(load, load_type, load_distribution, load_values) ⇒ Object

Function assigns parameters to surface / surface set load depend of load type and load distribution (private)

Kind: global function
Returns: Object - Returns modified load

Param Type Description
load Object Load
load_type String Load type
load_distribution String Load distribution, can be undefined
load_values Array Load parameters depend on load type and load distribution - (load type / load distribution: [valid values]) - "Force" / "Uniform": [p] - "Force" / "Linear": [Node1, Node2, Node3, p1, p2, p3] - "Force: / "Linear in X": [Node1, Node2, p1, p2] - "Force" / "Linear in Y": [Node1, Node2, p1, p2] - "Force" / "Linear in Z": [Node1, Node2, p1, p2] - "Force" / "Radial": [axis_definition, p1, p2, Node1, Node2, [Node1, Node2] or XA, YA, ZA, XB, YB, ZB] (axis definition 1 === "Two points") [axis_definition, p1, p2, Node1, Node2, ([Node1] or XA, YA, ZA), parallel_axis] (axis definition 2 === "Point and axis") - "Force" / "Varying in Z": [p1, z1, p2, z2, ... pn, zn] - "Temperature" / "Uniform": [Tc, ΔT] - "Temperature" / "Linear": [Node1, Node2, Node3, Tc1, Tc2, Tc3, ΔT1, ΔT2, ΔT3] - "Temperature" / "Linear in X": [Node1, Node2, Tc1, Tc2, ΔT1, ΔT2] - "Temperature" / "Linear in Y": [Node1, Node2, Tc1, Tc2, ΔT1, ΔT2] - "Temperature" / "Linear in Z": [Node1, Node2, Tc1, Tc2, ΔT1, ΔT2] - "Temperature" / "Radial": [axis_definition, Tc1, Tc2, ΔT1, ΔT2, Node1, Node2, [Node1, Node2] or XA, YA, ZA, XB, YB, ZB] (axis definition 1 === "Two points") [axis_definition, Tc1, Tc2, ΔT1, ΔT2, Node1, Node2, ([Node1] or XA, YA, ZA), parallel_axis] (axis definition 2 === "Point and axis") - "Axial Strain" / "Uniform": [εx, εy] - "Axial Strain" / "Linear": [Node1, Node2, Node3, ε1x, ε1y, ε2x, ε2y, ε3x, ε3y] - "Axial Strain" / "Linear in X": [Node1, Node2, ε1x, ε1y, ε2x, ε2y] - "Axial Strain" / "Linear in Y": [Node1, Node2, ε1x, ε1y, ε2x, ε2y] - "Axial Strain" / "Linear in Z": [Node1, Node2, ε1x, ε1y, ε2x, ε2y] - "Precamber" / "Uniform": [κ] - "Rotary Motion": [axis_definition, p1, p2, Node1, Node2, [Node1, Node2] or XA, YA, ZA, XB, YB, ZB] (axis definition 1 === "Two points") [axis_definition, p1, p2, Node1, Node2, ([Node1] or XA, YA, ZA), parallel_axis] (axis definition 2 === "Point and axis") - "Mass" / "Uniform": [M]

# setSolidLoadDistribution(load, load_type, load_distribution, load_values) ⇒ Object

Function assigns parameters to solid / solid set load depend of load type and load distribution (private)

Kind: global function
Returns: Object - Returns modified load

Param Type Description
load Object Load
load_type String Load type
load_distribution String Load distribution, can be undefined
load_values Array Load parameters depend on load type and load distribution - (load type / load distribution: [valid values]) - "Force" / "Uniform": [p] - "Temperature" / "Uniform": [T] - "Temperature" / "Linear in X": [Node1, Node2, T1, T2] - "Temperature" / "Linear in Y": [Node1, Node2, T1, T2] - "Temperature" / "Linear in Z": [Node1, Node2, T1, T2] - "Strain" / "Uniform": [εx, εy, εz] - "Strain" / "Linear in X": [Node1, Node2, ε1x, ε1y, ε1z, ε2x, ε2y, ε2z] - "Strain" / "Linear in Y": [Node1, Node2, ε1x, ε1y, ε1z, ε2x, ε2y, ε2z] - "Strain" / "Linear in Z": [Node1, Node2, ε1x, ε1y, ε1z, ε2x, ε2y, ε2z] - "Buoyancy" / "Uniform": [p] - "Rotary Motion": [axis_definition, p1, p2, Node1, Node2, [Node1, Node2] or XA, YA, ZA, XB, YB, ZB] (axis definition 1 === "Two points") [axis_definition, p1, p2, Node1, Node2, ([Node1] or XA, YA, ZA), parallel_axis] (axis definition 2 === "Point and axis")

# setCommonFreeLoadsValues(load, load_projection, load_direction, load_acting_region_from, load_acting_region_to) ⇒ Object

Updates common parameters for free loads

Kind: global function
Returns: Object - Updated free load

Param Type Description
load Object Load
load_projection String Load projection, can be undefined
load_direction String Load direction, can be undefined
load_acting_region_from Number Start of load acting region, can be undefined
load_acting_region_to Number End of load acting region, can be undefined

# setFreeCircularLoadParameters(load, load_distribution, load_values) ⇒ Object

Set parameters to free circular load depend on load distribution

Kind: global function
Returns: Object - Returns modified load

Param Type Description
load Object Load
load_distribution String Load distribution
load_values Array Load parameters depend of load distribution - "Uniform": [p, R, CX, CY] - "Linear": [pC, R, pR, CX, CY]

# setFreeConcentratedLoadParameters(load, load_type, load_values) ⇒ Object

Set parameters to free concentrated load depend on load type

Kind: global function
Returns: Object - Returns modified load

Param Type Description
load Object Load
load_type String Load type
load_values Array Load parameters depend of load type - "Force": [p, X, Y] - "Moment": [M, X, Y]

# setFreeLineLoadParameters(load, load_distribution, load_values) ⇒ Object

Set parameters to free line load depend on load distribution

Kind: global function
Returns: Object - Returns modified load

Param Type Description
load Object Load
load_distribution String Load distribution
load_values Array Load parameters depend of load distribution - "Force": [p, X1, Y1, X2, Y2] - "Linear": [p1, p2, X1, Y1, X2, Y2]

# setFreePolygonLoadParameters(load, load_distribution, load_values) ⇒ Object

Set parameters to free polygon load depend on load distribution

Kind: global function
Returns: Object - Returns modified load

Param Type Description
load Object Load
load_distribution String Load distribution
load_values Array Load parameters depend of load distribution - "Uniform": [p, X1, Y1, X2, Y2, X3, Y3 ... Xn, Yn] - "Linear": [p1, node1, node2, node3, [X1, Y1, X2, Y2, X3, Y3 ... Xn, Yn], p2, p3] - "Linear in X": [p1, node1, node2, [X1, Y1, X2, Y2, X3, Y3 ... Xn, Yn], p2] - "Linear in Y": [p1, node1, node2, [X1, Y1, X2, Y2, X3, Y3 ... Xn, Yn], p2]

# setFreeRectangularLoadParameters(load, load_distribution, load_values) ⇒ Object

Set parameters to free rectangular load depend on load distribution

Kind: global function
Returns: Object - Returns modified load

Param Type Description
load Object Load
load_distribution String Load distribution
load_values Array Load parameters depend of load distribution - "Uniform": [location, p, X1, Y1, X2, Y2, α] for location (1) "Corner points of rectangle" - [location, p, Xc, Yc, a, b, α] for location (2) "Center and sides of rectangle" - "Linear in X": [location, p1, p2, X1, Y1, X2, Y2, α] for location (1) "Corner points of rectangle" [location, p1, p2, Xc, Yc, a, b, α] for location (2) "Center and sides of rectangle" - "Linear in Y": [location, p1, p2, X1, Y1, X2, Y2, α] for location (1) "Corner points of rectangle" [location, p1, p2, Xc, Yc, a, b, α] for location (2) "Center and sides of rectangle" - "Varying in Z": [location, p, X1, Y1, X2, Y2, [Z1, kz1, pz1, Z2, kz2, pz2, ... Zn, kzn, pzn]] for location (1) "Corner points of rectangle" [location, p, Xc, Yc, a, b, [Z1, kz1, pz1, Z2, kz2, pz2, ... Zn, kzn, pzn]] for location (2) "Center and sides of rectangle" - "Varying along Perimeter": [location, p, X1, Y1, X2, Y2, [XA, YA, ZA, XB, YB, ZB, α0, (α1, kα1, pα1, α2, kα2, pα2 ... αn, kαn, pαn)]] for location (1) "Corner points of rectangle" [location, p, Xc, Yc, a, b, [XA, YA, ZA, XB, YB, ZB, α0, (α1, kα1, pα1, α2, kα2, pα2 ... αn, kαn, pαn)]] for location (2) "Center and sides of rectangle" - "Varying in Z and Perimeter": [location, p, X1, Y1, X2, Y2, [Z1, kz1, pz1, Z2, kz2, pz2, ... Zn, kzn, pzn], [XA, YA, ZA, XB, YB, ZB, α0, (α1, kα1, pα1, α2, kα2, pα2 ... αn, kαn, pαn)] for location (1) "Corner points of rectangle" [location, p, Xc, Yc, a, b, [Z1, kz1, pz1, Z2, kz2, pz2, ... Zn, kzn, pzn], [XA, YA, ZA, XB, YB, ZB, α0, (α1, kα1, pα1, α2, kα2, pα2 ... αn, kαn, pαn)] for location (2) "Center and sides of rectangle"

# setLoadDistribution(load_type, load_distribution, load_values) ⇒ Object

Assignes values to load depend of load type and load distribution (private)

Kind: global function
Returns: Object - Returns modified load

Param Type Description
load_type String Load type
load_distribution String Load distribution, can be undefined
load_values Array Load parameters depend on load type and load distribution - (load type / load distribution: [valid values]) - "Force" / "Uniform/Trapezoidal": [p] - "Force" / "Linear/Trapezoidal": [Node1, Node2, Node3, p1, p2, p3]