Contact class

The Contact class gives you access to contacts 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

Blank(window[GraphicsWindow])
Blanked(window[GraphicsWindow])
ClearFlag(flag[Flag])
Flagged(flag[Flag])
GetData(component[constant], options (optional)[object])
GetNode(side[constant], index[integer])
GetSegment(side[constant], index[integer])
Next()
Previous()
SetFlag(flag[Flag])
Unblank(window[GraphicsWindow])

Contact constants

Name	Description
Contact.SURFA	SURFA side of the contact
Contact.SURFB	SURFB side of the contact

Contact properties

Name	Type	Description
aNodes (read only)	integer	Total number of nodes on the SURFA side of the contact
aSegments (read only)	integer	Total number of segments on the SURFA side of the contact
bNodes (read only)	integer	Total number of nodes on the SURFB side of the contact
bSegments (read only)	integer	Total number of segments on the SURFB side of the contact
data (read only)	real\|array	Component data for a contact passed as an argument to GetMultipleData. Note that data will only exist for the instance of the contact 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 contact is in
index (read only)	integer	The internal index for the contact in D3PLOT (starting at 0)
label (read only)	integer	The Ansys LS-DYNA label for the contact
model (read only)	Model	The Model that the contact is in
name (read only)	string	The name of the contact type
title (read only)	string	The title of the contact
type (read only)	constant	The type for the contact (will be Type.CONTACT)

Detailed Description

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

Details of functions

Blank(window[GraphicsWindow])

Description

Blanks the contact in a graphics window

Arguments

window (GraphicsWindow)

GraphicsWindow) to blank the contact in

Returns

No return value

Example

To blank contact c in graphics window g:

c.Blank(g);

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

Description

Blanks all of the contacts in the model

Arguments

window (GraphicsWindow)

GraphicsWindow) to blank the contacts in

model (Model)

Model that all the contacts will be blanked in

Returns

No return value

Example

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

Contact.BlankAll(gw, m);

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

Description

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

Arguments

window (GraphicsWindow)

GraphicsWindow) to blank the contacts in

model (Model)

Model that the flagged contacts will be blanked in

flag (Flag)

Flag (see AllocateFlag) set on the contacts to blank

Returns

No return value

Example

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

Contact.BlankFlagged(gw, m, f);

Blanked(window[GraphicsWindow])

Description

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

Arguments

window (GraphicsWindow)

GraphicsWindow) in which to check if the contact is blanked

Returns

true if blanked, false if not

Return type

boolean

Example

To check if contact c is blanked in graphics window g:

if (c.Blanked(g) ) do_something...

ClearFlag(flag[Flag])

Description

Clears a flag on a contact

Arguments

flag (Flag)

Flag (see AllocateFlag) to clear on the contact

Returns

No return value

Example

To clear flag f on contact c:

c.ClearFlag();

First(model[Model]) [static]

Description

Returns the first contact in the model (or null if there are no contacts in the model)

Arguments

model (Model)

Model to get first contact in

Returns

Contact object

Return type

Contact

Example

To get the first contact in model m:

var c = Contact.First(m);

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

Description

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

Arguments

model (Model)

Model that all the contacts will be flagged in

flag (Flag)

Flag (see AllocateFlag) to set on the contacts

Returns

No return value

Example

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

Contact.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the contact is flagged or not

Arguments

flag (Flag)

Flag (see AllocateFlag) to test on the contact

Returns

true if flagged, false if not

Return type

boolean

Example

To check if contact c has flag f set on it:

if (c.Flagged(f) ) do_something...

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

Description

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

Arguments

model (Model)

Model that all the contacts are in

property (optional) (string)

Name for property to get for all contacts in the model

Returns

Array of Contact objects or properties

Return type

Array

Example

To get all of the contacts in model m:

var c = Contact.GetAll(m);

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

var a = Contact.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 = c.GetData(component, {extra: 1});
if (value !== null) do_something...

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

Description

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

Arguments

model (Model)

Model that the flagged contacts are in

flag (Flag)

Flag (see AllocateFlag) set on the contacts to get

property (optional) (string)

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

Returns

Array of Contact objects or properties

Return type

Array

Example

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

Contact.GetFlagged(m, f);

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

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

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

Description

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

Arguments

model (Model)

Model to get contact in

label (integer)

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

Returns

Contact object

Return type

Contact

Example

To get the contact in model m with label 1000:

var c = Contact.GetFromID(m, 1000);

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

Description

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

Arguments

model (Model)

Model to get contact in

index (integer)

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

Returns

Contact object

Return type

Contact

Example

To get the 51st contact in model m:

var c = Contact.GetFromIndex(m, 50);

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

Description

Returns the value for a data component for multiple contacts. For each contact 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 Contact objects to get the data for. All of the contacts 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 contact 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 contacts in array items and use the data property (note that in the example, the argument extra is optional):

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

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

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

GetNode(side[constant], index[integer])

Description

Gets a node for a contact

Arguments

side (constant)

The side of the contact to get the node for. Either Contact.SURFA or Contact.SURFB

index (integer)

index of the node to get.
0 <= index < aNodes for side SURFA
0 <= index < bNodes for side SURFB

Returns

Node object

Return type

Node

Example

To get the 10th node on SURFB side of contact c in D3PLOT

var node = c.GetNode(Contact.SURFB, 9);

GetSegment(side[constant], index[integer])

Description

Gets a segment for a contact

Arguments

side (constant)

The side of the contact to get the segment for. Either Contact.SURFA or Contact.SURFB

index (integer)

index of the segment to get.
0 <= index < aSegments for side SURFA
0 <= index < bSegments for side SURFB

Returns

Segment object

Return type

Segment

Example

To get the 10th segment on SURFB side of contact c in D3PLOT

var segm = c.GetSegment(Contact.SURFB, 9);

Last(model[Model]) [static]

Description

Returns the last contact in the model (or null if there are no contacts in the model)

Arguments

model (Model)

Model to get last contact in

Returns

Contact object

Return type

Contact

Example

To get the last contact in model m:

var c = Contact.Last(m);

Next()

Description

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

Arguments

No arguments

Returns

Contact object

Return type

Contact

Example

To get the next contact after contact c:

c = c.Next();

Pick() [static]

Description

Allows the user to pick a contact from the screen

Arguments

No arguments

Returns

Contact object or null if cancelled

Return type

Contact

Example

To pick a contact:

var c = Contact.Pick();

Previous()

Description

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

Arguments

No arguments

Returns

Contact object

Return type

Contact

Example

To get the previous contact before contact c:

c = c.Previous();

Select(flag[Flag]) [static]

Description

Selects contacts using an object menu

Arguments

flag (Flag)

Flag (see AllocateFlag) to use when selecting contacts

Returns

The number of contacts selected or null if menu cancelled

Return type

integer

Example

To select contacts, flagging those selected with flag f:

var total = Contact.Select(f);

SetFlag(flag[Flag])

Description

Sets a flag on a contact

Arguments

flag (Flag)

Flag (see AllocateFlag) to set on the contact

Returns

No return value

Example

To set flag f on contact c:

c.SetFlag(f);

Total(model[Model]) [static]

Description

Returns the total number of contacts in the model

Arguments

model (Model)

Model to get total in

Returns

The number of contacts

Return type

integer

Example

To get the number of contacts in model m:

var total = Contact.Total(m);

Unblank(window[GraphicsWindow])

Description

Unblanks the contact in a graphics window

Arguments

window (GraphicsWindow)

GraphicsWindow) to unblank the contact in

Returns

No return value

Example

To unblank contact c in graphics window g:

c.Unblank(g);

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

Description

Unblanks all of the contacts in the model

Arguments

window (GraphicsWindow)

GraphicsWindow) to unblank the contacts in

model (Model)

Model that all the contacts will be unblanked in

Returns

No return value

Example

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

Contact.UnblankAll(gw, m);

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

Description

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

Arguments

window (GraphicsWindow)

GraphicsWindow) to unblank the contacts in

model (Model)

Model that the flagged contacts will be unblanked in

flag (Flag)

Flag (see AllocateFlag) set on the contacts to unblank

Returns

No return value

Example

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

Contact.UnblankFlagged(gw, m, f);

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

Description

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

Arguments

model (Model)

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

flag (Flag)

Flag (see AllocateFlag) to unset on the contacts

Returns

No return value

Example

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

Contact.UnflagAll(m, f);