Node class

The Node class gives you access to nodes in D3PLOT. More...

The D3PLOT JavaScript API provides many class constants, properties and methods. For Arup to be able to extend and enhance the API in the future any constant, property or method names beginning with a lowercase or uppercase letter are reserved.
If you need to add your own properties or methods to one of the existing classes then to avoid any potential future conflict you should ensure that the name begins with either an underscore (_) or a dollar sign ($) or the name is prefixed with your own unique identifier.
For example if company 'ABC' need to add a property called 'example' then to avoid any potential future conflict use one of:

_example
$example
ABC_example

Class functions

BlankAll(window[GraphicsWindow], model[Model])
BlankFlagged(window[GraphicsWindow], model[Model], flag[Flag])
First(model[Model])
FlagAll(model[Model], flag[Flag])
GetAll(model[Model], property (optional)[string])
GetFlagged(model[Model], flag[Flag], property (optional)[string])
GetFromID(model[Model], label[integer])
GetFromIndex(model[Model], index[integer])
GetMultipleData(component[constant], items[array], options (optional)[object])
Last(model[Model])
Pick()
Select(flag[Flag])
Total(model[Model])
UnblankAll(window[GraphicsWindow], model[Model])
UnblankFlagged(window[GraphicsWindow], model[Model], flag[Flag])
UnflagAll(model[Model], flag[Flag])

Member functions

Acceleration()
Blank(window[GraphicsWindow])
Blanked(window[GraphicsWindow])
ClearFlag(flag[Flag])
Coordinates()
Displacement()
Elements(type[constant])
Flagged(flag[Flag])
GetData(component[constant], options (optional)[object])
Next()
Previous()
SetFlag(flag[Flag])
Unblank(window[GraphicsWindow])
Velocity()

Node properties

Name	Type	Description
data (read only)	real\|array	Component data for a node passed as an argument to GetMultipleData. Note that data will only exist for the instance of the node passed to GetMultipleData. i.e. it is a local property stored on the specific instance. It is not stored in the D3PLOT database
include (read only)	integer	The include file number in the model that the node is in
index (read only)	integer	The internal index for the node in D3PLOT (starting at 0)
label (read only)	integer	The Ansys LS-DYNA label for the node
model (read only)	Model	The Model that the node is in
type (read only)	constant	The type for the node (will be Type.NODE)

Detailed Description

The Node class allows you to inspect nodes in a model. See the documentation below for more details.

Details of functions

Acceleration()

Description

Returns the acceleration for the node

Arguments

No arguments

Returns

Array containing the nodal acceleration [Ax, Ay, Az] (or null if the value cannot be calculated)

Return type

array

Example

To return the acceleration of node n:

var acc = n.Acceleration();
if (acc !== null) do_something...

Blank(window[GraphicsWindow])

Description

Blanks the node in a graphics window

Arguments

window (GraphicsWindow)

GraphicsWindow) to blank the node in

Returns

No return value

Example

To blank node n in graphics window g:

n.Blank(g);

BlankAll(window[GraphicsWindow], model[Model]) [static]

Description

Blanks all of the nodes in the model

Arguments

window (GraphicsWindow)

GraphicsWindow) to blank the nodes in

model (Model)

Model that all the nodes will be blanked in

Returns

No return value

Example

To blank all of the nodes in model m, in graphics window gw:

Node.BlankAll(gw, m);

BlankFlagged(window[GraphicsWindow], model[Model], flag[Flag]) [static]

Description

Blanks all of the nodes in the model flagged with a defined flag

Arguments

window (GraphicsWindow)

GraphicsWindow) to blank the nodes in

model (Model)

Model that the flagged nodes will be blanked in

flag (Flag)

Flag (see AllocateFlag) set on the nodes to blank

Returns

No return value

Example

To blank all of the nodes flagged with flag f in model m, in graphics window gw:

Node.BlankFlagged(gw, m, f);

Blanked(window[GraphicsWindow])

Description

Checks if the node is blanked in a graphics window or not

Arguments

window (GraphicsWindow)

GraphicsWindow) in which to check if the node is blanked

Returns

true if blanked, false if not

Return type

boolean

Example

To check if node n is blanked in graphics window g:

if (n.Blanked(g) ) do_something...

ClearFlag(flag[Flag])

Description

Clears a flag on a node

Arguments

flag (Flag)

Flag (see AllocateFlag) to clear on the node

Returns

No return value

Example

To clear flag f on node n:

n.ClearFlag();

Coordinates()

Description

Returns the coordinates for the node

Arguments

No arguments

Returns

Array containing the nodal coordinates [Cx, Cy, Cz] (or null if the value cannot be calculated)

Return type

array

Example

To return the coordinates of node n:

var coords = n.Coordinates();
if (coords !== null) do_something...

Displacement()

Description

Returns the displacement for the node

Arguments

No arguments

Returns

Array containing the nodal displacement [Dx, Dy, Dz] (or null if the value cannot be calculated)

Return type

array

Example

To return the displacement of node n:

var disp = n.Displacement();
if (disp !== null) do_something...

Elements(type[constant])

Description

Returns the elements using this node

Arguments

type (constant)

The type of elements. Either Type.BEAM, Type.SHELL, Type.SOLID or Type.TSHELL

Returns

Array containing the elements or null if there are no elements

Return type

array

Example

To return the shell elements using node n:

var shells = n.Elements(Type.SHELL);

First(model[Model]) [static]

Description

Returns the first node in the model (or null if there are no nodes in the model)

Arguments

model (Model)

Model to get first node in

Returns

Node object

Return type

Node

Example

To get the first node in model m:

var n = Node.First(m);

FlagAll(model[Model], flag[Flag]) [static]

Description

Flags all of the nodes in the model with a defined flag

Arguments

model (Model)

Model that all the nodes will be flagged in

flag (Flag)

Flag (see AllocateFlag) to set on the nodes

Returns

No return value

Example

To flag all of the nodes with flag f in model m:

Node.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the node is flagged or not

Arguments

flag (Flag)

Flag (see AllocateFlag) to test on the node

Returns

true if flagged, false if not

Return type

boolean

Example

To check if node n has flag f set on it:

if (n.Flagged(f) ) do_something...

GetAll(model[Model], property (optional)[string]) [static]

Description

Returns an array of Node objects or properties for all of the nodes in the model. If the optional property argument is not given then an array of Node objects is returned. If the property argument is given, that property value for each node is returned in the array instead of a Node object

Arguments

model (Model)

Model that all the nodes are in

property (optional) (string)

Name for property to get for all nodes in the model

Returns

Array of Node objects or properties

Return type

Array

Example

To get all of the nodes in model m:

var n = Node.GetAll(m);

To return an array containing the value of property 'foo' (for example 'label' for a node) for each node in model m:

var a = Node.GetAll(m, 'foo');

GetData(component[constant], options (optional)[object])

Description

Returns the value for a data component.
Also see GetMultipleData

Arguments

component (constant)

Component constant to get data for

options (optional) (object)

Object containing options for getting data. Can be any of:

Object has the following properties:

Name	Type	Description
extra	integer	The extra data component number if component Component.SOX for solids, Component.BMX for beams or Component.SHX for shells and thick shells
ip	integer	Integration point number to get the data at (ip >= 1 or one of the constants Constant.TOP, Constant.MIDDLE or Constant.BOTTOM). If the integration point is not defined it will use the integration point defined on the current GUI "data" panel, which defaults to the middle surface for shells, thick shells, and solids, and Mag All for beams, but may vary if changed by an interactive user. If consistent output from a script is required, independent of any prior interactive activity, an explicit integration point or surface should be defined
op	integer	On plane integration point number for shells and thick shells (op >= 1 [default])
referenceFrame	constant	The frame of reference to return values in. Either Constant.GLOBAL (default), Constant.LOCAL, Constant.CYLINDRICAL, Constant.USER_DEFINED or Constant.MATERIAL. This is only necessary for directional components (eg X stress) and then only when something other than the default Constant.GLOBAL coordinate system is to be used
user	integer	The user-defined component number if component Component.UNOS, Component.UNOV, Component.USSS, Component.USST, Component.UBMS or Component.UBMV

Returns

Number if a scalar component, array if a vector or tensor component (or null if the value cannot be calculated because it's not available in the model).
If requesting an invalid component it will throw an error (e.g. Component.AREA of a node).

Return type

real|array

Example

To calculate a component and check it has been calculated (note that in the example, the argument extra is optional):

var value = n.GetData(component, {extra: 1});
if (value !== null) do_something...

GetFlagged(model[Model], flag[Flag], property (optional)[string]) [static]

Description

Gets all of the nodes in the model flagged with a defined flag. If the optional property argument is not given then an array of Node objects is returned. If the property argument is given, that property value for each node is returned in the array instead of a Node object

Arguments

model (Model)

Model that the flagged nodes are in

flag (Flag)

Flag (see AllocateFlag) set on the nodes to get

property (optional) (string)

Name for property to get for all flagged nodes in the model

Returns

Array of Node objects or properties

Return type

Array

Example

To get all of the nodes flagged with flag f in model m:

Node.GetFlagged(m, f);

To return an array containing the value of property 'foo' (for example 'label' for a node) for all nodes flagged with flag f in model m:

var a = Node.GetFlagged(m, f, 'foo');

GetFromID(model[Model], label[integer]) [static]

Description

Returns the Node object for node in model with label (or null if it does not exist)

Arguments

model (Model)

Model to get node in

label (integer)

The Ansys LS-DYNA label for the node in the model

Returns

Node object

Return type

Node

Example

To get the node in model m with label 1000:

var n = Node.GetFromID(m, 1000);

GetFromIndex(model[Model], index[integer]) [static]

Description

Returns the Node object for node in model with index (or null if it does not exist)

Arguments

model (Model)

Model to get node in

index (integer)

The D3PLOT internal index in the model for node, starting at 0.

Returns

Node object

Return type

Node

Example

To get the 51st node in model m:

var n = Node.GetFromIndex(m, 50);

GetMultipleData(component[constant], items[array], options (optional)[object]) [static]

Description

Returns the value for a data component for multiple nodes. For each node a local property called data will be created containing a number if a scalar component, or an array if a vector or tensor component (or null if the value cannot be calculated). The data is also returned as an object.
Also see GetData

Arguments

component (constant)

Component constant to get data for

items (array)

Array of Node objects to get the data for. All of the nodes must be in the same model.

options (optional) (object)

Object containing options for getting data. Can be any of:

Object has the following properties:

Name	Type	Description
extra	integer	The extra data component number if component Component.SOX for solids, Component.BMX for beams or Component.SHX for shells and thick shells
ip	integer	Integration point number to get the data at (ip >= 1 or one of the constants Constant.TOP, Constant.MIDDLE or Constant.BOTTOM)
op	integer	On plane integration point number for shells and thick shells (op >= 1 [default])
referenceFrame	constant	The frame of reference to return values in. Either Constant.GLOBAL (default), Constant.LOCAL, Constant.CYLINDRICAL, Constant.USER_DEFINED or Constant.MATERIAL. This is only necessary for directional components (eg X stress) and then only when something other than the default Constant.GLOBAL coordinate system is to be used
user	integer	The user-defined component number if component Component.UNOS, Component.UNOV, Component.USSS, Component.USST, Component.UBMS or Component.UBMV

Returns

Object containing the data. A property is created in the object for each node with the label. The value of the property is a number if a scalar component or an array if a vector or tensor component (or null if the value cannot be calculated)

Return type

object

Example

To calculate a component for nodes in array items and use the data property (note that in the example, the argument extra is optional):

Node.GetMultipleData(component, items, {extra: 1});
for (i=0; i<items.length; i++)
{
    if (items[i].data !== null) do_something...
}

To calculate a component for nodes in array items and use the return value (note that in the example, the argument extra is optional):

var data = Node.GetMultipleData(component, items, {extra: 1});
for (d in data)
{
    Message("Label is " + d);
    if (data[d] !== null) do_something...
}

Last(model[Model]) [static]

Description

Returns the last node in the model (or null if there are no nodes in the model)

Arguments

model (Model)

Model to get last node in

Returns

Node object

Return type

Node

Example

To get the last node in model m:

var n = Node.Last(m);

Next()

Description

Returns the next node in the model (or null if there is not one)

Arguments

No arguments

Returns

Node object

Return type

Node

Example

To get the next node after node n:

n = n.Next();

Pick() [static]

Description

Allows the user to pick a node from the screen

Arguments

No arguments

Returns

Node object or null if cancelled

Return type

Node

Example

To pick a node:

var n = Node.Pick();

Previous()

Description

Returns the previous node in the model (or null if there is not one)

Arguments

No arguments

Returns

Node object

Return type

Node

Example

To get the previous node before node n:

n = n.Previous();

Select(flag[Flag]) [static]

Description

Selects nodes using an object menu

Arguments

flag (Flag)

Flag (see AllocateFlag) to use when selecting nodes

Returns

The number of nodes selected or null if menu cancelled

Return type

integer

Example

To select nodes, flagging those selected with flag f:

var total = Node.Select(f);

SetFlag(flag[Flag])

Description

Sets a flag on a node

Arguments

flag (Flag)

Flag (see AllocateFlag) to set on the node

Returns

No return value

Example

To set flag f on node n:

n.SetFlag(f);

Total(model[Model]) [static]

Description

Returns the total number of nodes in the model

Arguments

model (Model)

Model to get total in

Returns

The number of nodes

Return type

integer

Example

To get the number of nodes in model m:

var total = Node.Total(m);

Unblank(window[GraphicsWindow])

Description

Unblanks the node in a graphics window

Arguments

window (GraphicsWindow)

GraphicsWindow) to unblank the node in

Returns

No return value

Example

To unblank node n in graphics window g:

n.Unblank(g);

UnblankAll(window[GraphicsWindow], model[Model]) [static]

Description

Unblanks all of the nodes in the model

Arguments

window (GraphicsWindow)

GraphicsWindow) to unblank the nodes in

model (Model)

Model that all the nodes will be unblanked in

Returns

No return value

Example

To unblank all of the nodes in model m, in graphics window gw:

Node.UnblankAll(gw, m);

UnblankFlagged(window[GraphicsWindow], model[Model], flag[Flag]) [static]

Description

Unblanks all of the nodes in the model flagged with a defined flag

Arguments

window (GraphicsWindow)

GraphicsWindow) to unblank the nodes in

model (Model)

Model that the flagged nodes will be unblanked in

flag (Flag)

Flag (see AllocateFlag) set on the nodes to unblank

Returns

No return value

Example

To unblank all of the nodes flagged with flag f in model m, in graphics window gw:

Node.UnblankFlagged(gw, m, f);

UnflagAll(model[Model], flag[Flag]) [static]

Description

Unsets a defined flag on all of the nodes in the model

Arguments

model (Model)

Model that the defined flag for all nodes will be unset in

flag (Flag)

Flag (see AllocateFlag) to unset on the nodes

Returns

No return value

Example

To unset flag f on all of the nodes in model m:

Node.UnflagAll(m, f);

Velocity()

Description

Returns the velocity for the node

Arguments

No arguments

Returns

Array containing the nodal velocity [Vx, Vy, Vz] (or null if the value cannot be calculated)

Return type

array

Example

To return the velocity of node n:

var vel = n.Velocity();
if (disp !== null) do_something...