CutSection

Returns

Example

// Get the coordinates where the second cut plane in window 1 cuts the first shell in model 3 in state 10.
if(a = GetCutCoords({ type_code:SHELL, item:1, window_id:1, model_id:3, direction_id:2, state_id:10 }))
{
    var n = a.n;
    for(var i=0; i<n; i++)
    {
        Message("Coords: " + a.x[i] + ", " + a.y[i] + ", a.z[i]);
    }
}

GetCutCoords(type_code[integer], item[integer], state_id (optional)[integer]) [static]  [deprecated]

This function is deprecated in version 19.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Returns the coordinates where the cut-section cuts through element <type/item>.

Returns

Example

// Get the coordinates where the cut section cuts the first shell in the current model.
if(a = GetCutCoords(SHELL, 1))
{
    var n = a.n;
    for(var i=0; i<n; i++)
    {
        Message("Coords: " + a.x[i] + ", " + a.y[i] + ", a.z[i]);
    }
}

GetCutForces(options[object]) [static]

Description

Returns the forces, moments, centroid and area of the cut section in <window_id>.

The coordinate system of these results depends upon the cut section's space system as follows:

• BASIC space: Forces are moments are always returned in the global axis system, about the geometrical centre of the cut elements at the given state. Therefore the effective origin is likely to change as the model deforms. (This is the method used by Ansys LS-DYNA)
• DEFORMED space: Forces and moments are returned in the plane local axis system, about the current section origin. The origin and axes will remain fixed as the model deforms unless one of the "section follows node(s)" options has been used.

WARNING #1: Cut-sections in D3PLOT are a "per window" attribute, cutting all models in a window at the current "frame".

If the optional <state_id> argument is not supplied the forces and moments returned will be at the state of the current "frame" of the window, and while this will normally be the same as the current "state" this is not necessarily the case, since the user may have interpolated results by time

Likewise if the optional <model_id> argument is not supplied then the model used will be the first in the window (as reported by function GetWindowModels()), which may not be the same as the "current model" of the JavaScript interface.

Therefore to avoid ambiguity when extracting cut-section forces and moments it is recommended that:

• The window being used should only contain a single model
• The window should be set up to display all states without interpolation, thus <state id> == <frame id>. (This is the default for windows.)

This "single model in a window" approach is strongly recommended in this context since visual feedback will then match computed values.

WARNING #2: By default computed forces do NOT include blanked elements.

Since cut section display is primarily intended to be used interactively the default behaviour is to omit blanked elements from the forceand moment calculation, since in this way the reported values match what is visible on the screen.

This behaviour is not ideal for batch processing since the user can, by manipulating blanking, change the results which are computed. Therefore the optional argument <include_blanked> may be used to override this behaviour and to force blanked elements to be considered. If omitted, or set to zero, then the default behaviour of omitting blanked elements will continue.

WARNING #3: Cutting a model exactly at mesh lines can result in ill-conditioned force and moment calculation.

It is tempting to define cut planes at nodes since this is easy to do, however this can give rise to ill-conditioning in a rectilinear mesh since the cut may lie exactly on the border between two adjacent elements and therefore won't "know" which one's results to use. Since Ansys LS-DYNA elements are constant stress there can be a step change in data values at element borders, and moving the cut plane by a tiny amount can result in a correspondingly large change in cut force and moment values.

It is strongly recommended that cut section definitions used for force and moment extraction should be located away from mesh lines so that they cut elements near their centres, thus avoiding any ambiguity about which elements to use.

WARNING #4: Any element types or parts excluded from the cut section are still included in the force and moment calculation.

Returns

Example

// Retrieve the results of the cut section in window 1 using all default attributes.
if(a = GetCutForces({window_id: 1}))
{
    var fx = a.force[X];
    var myy = a.moment[Y];
    var area = a.area;
}

// Retrieve the results from unblanked elements in the third part using the section
// in window 2 for state 12 in model 1 for the second non-parallel plane direction.
var b = GetCutForces({window_id: 2, include_blanked: 0, part_id: 3, state_id: 12, model_id: 1, direction_id: 2});

GetCutForces(window_id[integer], include_blanked (optional)[integer], part_id (optional)[integer], state_id (optional)[integer], model_id (optional)[integer]) [static]  [deprecated]

This function is deprecated in version 19.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Returns the forces, moments, centroid and area of the cut section in <window_id>.

The coordinate system of these results depends upon the cut section's space system as described in the non-deprecated function with the same name.

Returns

Example

// Retrieve the results of the cut section in window 1 using all default attributes.
if(a = GetCutForces(1))
{
    var fx = a.force[X];
    var myy = a.moment[Y];
    var area = a.area;
}

// Retrieve the results from unblanked elements in the third part using the section in window 2 for state 12 in model 1.
var b = GetCutForces(2, 0, 3, 12, 1);

GetCutSection(options[object]) [static]

Description

Retrieves all attributes of the cut section in <window_id>.

Returns

For definition = CONST_X/Y/Z: nodes[0] = index of node if supplied

For definition = N3: nodes[0 to 2] = indices of three N3 nodes

This array will always be present and have three entries, with unused entries being set to zero.

when multi_custom_cut is false and multi_cut is true: spacing value

when multi_custom_cut is true and multi_cut is true: array of offsets from the local cut origin

when multi_cut is false: 0.0

Example

// Retrieve the attributes of the cut section in window 1 at the current state and model.
var a = GetCutSection({window_id: 1});

// Retrieve the attributes of the cut section in window 2, at state #10 in model #3.
var a = GetCutSection({window_id: 2, state_id: 10, model_id : 3});

// Retrieve the attributes of the cut section in window 1 for the second of several
// non-parallel plane directions.
var a = GetCutSection({window_id: 1, direction_id: 2});

GetCutSection(window_id[integer], state_id (optional)[integer], model_id (optional)[integer]) [static]  [deprecated]

This function is deprecated in version 19.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Retrieves all attributes of the cut section in <window_id>.

Returns

For definition = CONST_X/Y/Z: nodes[0] = index of node if supplied

For definition = N3: nodes[0 to 2] = indices of three N3 nodes

This array will always be present and have three entries, with unused entries being set to zero.

when multi_custom_cut is false and multi_cut is true: spacing value

when multi_custom_cut is true and multi_cut is true: array of offsets from the local cut origin

when multi_cut is false: undefined

Example

// Retrieve the attributes of the cut section in window 1 at the current state and model.
var a = GetCutSection(1);

// Retrieve the attributes of the cut-section in window 2, at state #10 in model #3.
var a = GetCutSection(2, 10, 3);

RemoveCutDirection(options[object]) [static]  [deprecated]

This function is deprecated in version 20.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Turns off a cut plane from a window with multiple non-parallel planes. Note that from D3PLOT 20.0 onwards cut directions can be turned off with the <visible> property in SetCutSection instead.

Returns

Return type

Example

// Assuming that there are 3 non-parallel cut planes in window 1, remove the second direction:
RemoveCutDirection({ window_id:1, direction_id:2 });

SetCutSection(options[object]) [static]

Description

Sets properties of the cut section in <window_id>

Each D3PLOT window can have cut planes in up to three directions, which are by default not active. Their location, orientation and type can be defined here, and it can be turned on or off. Forces and moments from the cut sections can be obtained from function GetCutForces().

Cut section definitions are a "per window" attribute that apply to all models in the window. Thefore if the window has multiple models, and nodes are used to define the section (CONST_X, CONST_Y, CONST_Z with a node or N3), the origin and/or vectors of the section may vary for each model in the window. In addition if the coordinates of these nodes are "followed" (see the <follow_n> property on the options), then the section locations may change from state to state.

• N3. The motion of all three nodes will update the origin and axes at each state.
• CONST_X, CONST_Y or CONST_Z where a node has been used to define the origin. The node motion will update the section origin at each state, but its axes will remain constant.

Returns

boolean

Return type

Boolean

Example

// Set the cut section to "deformed" (lagrangian) space in window 1.
SetCutSection({window_id: 1, space: DEFORMED});

// Make the section in window 2 constant in Z, with its origin at
// (1,2,3). Implicitly this means a plane of constant Z = 3.
if(!SetCutSection({window_id: 2, definition: CONST_Z, origin: [1,2,3]}))
{
    ... deal with error
}

// Make a cut-section in window 3 using the LS_DYNA method with the
// origin at (0,0,0), Z axis pointing down the global X vector (head at
// (10,0,0)), and X axis down the global Y vector (0,10,0)
if(!SetCutSection({window_id: 3, definition: LS_DYNA, origin: [0,0,0], normal_head: [10,0,0], x_axis_head: [0,10,0]}))
{
    ... deal with error
}

// In window 1 define the second direction with origin (10, 0, 0), local
// X axis (1,-1,0) and local Y axis (1,1,1). This can be called whether
// direction 2 is defined already or not.
if(!SetCutSection({window_id: 1, definition: OR_AND_V, origin: [10,0,0], x_axis: [1,-1,0], xy_plane: [1,1,1], direction_id: 2}))
{
    ... deal with error
}

// If there is only one cut plane in window 1, turn on a thick cut with
// thickness 4.0:
if(!SetCutSection({window_id: 1, thickness: 4.0}))
{
    ... deal with error
}

// Turn off a thick cut for the second direction in window 1:
if(!SetCutSection({window_id: 1, direction_id: 2, thickness: 0.0}))
{
    ... deal with error
}

// For a single cut plane in window 1 turn on 10 parallel cuts in
// positive and 5 parallel cuts in negative direction with a uniform
// spacing of 20.0 length units:
if(!SetCutSection({window_id: 1, spacing: 20.0, npos: 10, nneg: 5}))
{
    ... deal with error
}

// For the third plane direction in window 1 turn on parallel planes
// with custom spacing such that the offsets from the local cut origin
// are -20.0, 0.0, 10.0 and 20.0 length units:
if(!SetCutSection({window_id: 1, direction_id: 3, spacing: [-20.0, 0.0, 10.0, 20.0]}))
{
    ... deal with error
}

// Turn off parallel cuts for the first direction in window 1:
if(!SetCutSection({window_id: 1, spacing: 0.0}))
{
    ... deal with error
}

// For the first plane direction use normal drawing on the positive
// side and omit items on the negative side:
if(!SetCutSection({direction_id:1, positive_action:NORMAL, negative_action:OMIT}))
{
    ... deal with error
}

// For multiple cut directions use the intersection mode:
if(!SetCutSection({combination:INTERSECTION}))
{
    ... deal with error
}

SetCutSection(window_id[integer], attribute[integer], value[integer | array of reals | array of integers]) [static]  [deprecated]

This function is deprecated in version 19.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Sets properties of the cut section in <window_id>

Each D3PLOT window can have cut planes in up to three directions, which are by default not active. Their location, orientation and type can be defined here, and it can be turned on or off. Forces and moments from the cut sections can be obtained from function GetCutForces().

Cut section definitions are a "per window" attribute that apply to all models in the window. Thefore if the window has multiple models, and nodes are used to define the section (CONST_X, CONST_Y, CONST_Z with a node or N3), the origin and/or vectors of the section may vary for each model in the window. In addition if the coordinates of these nodes are "followed" (see the <follow_n> property on the options), then the section locations may change from state to state.

Returns

boolean

Return type

Boolean

Example

// Set the cut section to "deformed" (lagrangian) space in window 1.
SetCutSection(1, SPACE, DEFORMED);

// Make the section in window 2 constant in Z, with its origin at (1,2,3). Implicitly this means a plane of constant Z = 3.
var coord = new Array(1.0, 2.0, 3.0);

if(!SetCutSection(2, CONST_Z, coord))
{
    ... deal with error
}

// Make a cut-section in window 3 using the LS_DYNA method with the origin at (0,0,0), Z axis pointing down the global
// X vector (head at (10,0,0)), and X axis down the global Y vector (0,10,0)
var data = new Array(0.0, 0.0, 0.0, 10.0, 0.0,0.0, 0.0, 10.0, 0.0);

if(!SetCutSection(3, LS_DYNA, data))
{
    ... deal with error
}