Contact class

Returns

Contact object

Return type

Contact

Example

To create a new AUTOMATIC_GENERIC contact n model m with label 10 and title "Test contact"

var c = new Contact(m, "AUTOMATIC_GENERAL", 10, "Test contact");

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a contact.

Returns

No return value

Example

To associate comment c to the contact c:

c.AssociateComment(c);

Blank()

Description

Blanks the contact

Returns

No return value

Example

To blank contact c:

c.Blank();

BlankAll(Model[Model], redraw (optional)[boolean]) [static]

Description

Blanks all of the contacts in the model.

Returns

No return value

Example

To blank all of the contacts in model m:

Contact.BlankAll(m);

BlankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

Description

Blanks all of the flagged contacts in the model.

Returns

No return value

Example

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

Contact.BlankFlagged(m, f);

Blanked()

Description

Checks if the contact is blanked or not.

Returns

true if blanked, false if not.

Return type

Boolean

Example

To check if contact c is blanked:

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

Browse(modal (optional)[boolean])

Description

Starts an edit panel in Browse mode.

Returns

no return value

Example

To Browse contact c:

c.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the contact.

Returns

No return value

Example

To clear flag f for contact c:

c.ClearFlag(f);

Constrained(connection (optional)[boolean])

Description

see if tied/spotweld contact uses constrained formulation

Returns

logical

Return type

Boolean

Example

To see if contact is of type tied and constrained

c.Constrained();

Copy(range (optional)[boolean])

Description

Copies the contact. The target include of the copied contact can be set using Options.copy_target_include.

Returns

Contact object

Return type

Contact

Example

To copy contact c into contact z:

var z = c.Copy();

Create(Model[Model], modal (optional)[boolean]) [static]

Description

Starts an interactive editing panel to create a contact

Returns

Contact object (or null if not made).

Return type

Contact

Example

To start creating a contact in model m:

var c = Contact.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a contact.

Returns

No return value

Example

To detach comment c from the contact c:

c.DetachComment(c);

Edit(modal (optional)[boolean])

Description

Starts an interactive editing panel.

Returns

no return value

Example

To Edit contact c:

c.Edit();

Error(message[string], details (optional)[string])

Description

Adds an error for contact. For more details on checking see the Check class.

Returns

No return value

Example

To add an error message "My custom error" for contact c:

c.Error("My custom error");

ExtractColour()

Description

Extracts the actual colour used for contact.
By default in PRIMER many entities such as elements get their colour automatically from the part that they are in. PRIMER cycles through 13 default colours based on the label of the entity. In this case the contact colour property will return the value Colour.PART instead of the actual colour. This method will return the actual colour which is used for drawing the contact.

Returns

colour value (integer)

Return type

Number

Example

To return the colour used for drawing contact c:

var colour = c.ExtractColour();

FindInteractions()   [deprecated]

This function is deprecated in version 11.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

Use Contact.Interactions() instead.

Returns

No return value

First(Model[Model]) [static]

Description

Returns the first contact in the model.

Returns

Contact object (or null if there are no contacts in the model).

Return type

Contact

Example

To get the first contact in model m:

var c = Contact.First(m);

FirstFreeLabel(Model[Model], layer (optional)[Include number]) [static]

Description

Returns the first free contact label in the model. Also see Contact.LastFreeLabel(), Contact.NextFreeLabel() and Model.FirstFreeItemLabel().

Returns

Contact label.

Return type

Number

Example

To get the first free contact label in model m:

var label = Contact.FirstFreeLabel(m);

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

Description

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

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.

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...

ForEach(Model[Model], func[function], extra (optional)[any]) [static]

Description

Calls a function for each contact in the model.
Note that ForEach has been designed to make looping over contacts as fast as possible and so has some limitations.
Firstly, a single temporary Contact object is created and on each function call it is updated with the current contact data. This means that you should not try to store the Contact object for later use (e.g. in an array) as it is temporary.
Secondly, you cannot create new contacts inside a ForEach loop.

Returns

No return value

Example

To call function test for all of the contacts in model m:

Contact.ForEach(m, test);
function test(c)
{
// c is Contact object
}

To call function test for all of the contacts in model m with optional object:

var data = { x:0, y:0 };
Contact.ForEach(m, test, data);
function test(c, extra)
{
// c is Contact object
// extra is data
}

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

Description

Returns an array of Contact objects or properties for all of the contacts in a model in PRIMER. 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

Returns

Array of Contact objects or properties

Return type

Array

Example

To make an array of Contact objects for all of the contacts in model m:

var a = Contact.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a contact.

Returns

Array of Comment objects (or null if there are no comments associated to the node).

Return type

Array

Example

To get the array of comments associated to the contact c:

var comm_array = c.GetComments();

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

Description

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

Returns

Array of Contact objects or properties

Return type

Array

Example

To make an array of Contact objects for all of the contacts in model m flagged with f:

var c = Contact.GetFlagged(m, f);

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

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

GetFromID(Model[Model], number[integer]) [static]

Description

Returns the Contact object for a contact ID.

Returns

Contact object (or null if contact does not exist).

Return type

Contact

Example

To get the Contact object for contact 100 in model m

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

GetParameter(prop[string])

Description

Checks if a Contact property is a parameter or not. Note that object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. For this function to work the JavaScript interpreter must use the parameter name instead of the value. This can be done by setting the Options.property_parameter_names option to true before calling the function and then resetting it to false afterwards.. This behaviour can also temporarily be switched by using the Contact.ViewParameters() method and 'method chaining' (see the examples below).

Returns

Parameter object if property is a parameter, null if not.

Return type

Parameter

Example

To check if Contact property c.example is a parameter:

Options.property_parameter_names = true;
if (c.GetParameter(c.example) ) do_something...
Options.property_parameter_names = false;

To check if Contact property c.example is a parameter by using the GetParameter method:

if (c.ViewParameters().GetParameter(c.example) ) do_something...

Interactions(type (optional)[constant])

Description

Returns an array of objects describing the interactions which can either be penetrations (tracked nodes that are tied to or penetrate elements in the contact) or crossed edges (contact segments that cross).

Returns

Example

To get the penetration interactions for contact c:

var interactions = c.Interactions();
for(i=0; i<interactions.length; i++)
{
    var type  = interactions[i].type;	// Will be Contact.PENETRATIONS
    var node  = interactions[i].node;
    var shell = interactions[i].shell;
    var n1    = interactions[i].n1;
    var n2    = interactions[i].n2;
    var n3    = interactions[i].n3;
    var n4    = interactions[i].n4;
    var s     = interactions[i].s;
    var t     = interactions[i].t;
    var ex    = interactions[i].ex;
    var ey    = interactions[i].ey;
    var ez    = interactions[i].ez;
    var pen   = interactions[i].pen;
    var thick = interactions[i].thick;
    var rthick = interactions[i].rthick;
    var qthick = interactions[i].qthick;

    if(shell != undefined)
            ... process shell ...
}

To get the penetration and crossed edge interactions for contact c:

var interactions = c.Interactions(Contact.PENETRATIONS|Contact.CROSSED_EDGES);
for(i=0; i<interactions.length; i++)
{
    if (interactions[i].type == Contact.PENETRATIONS)
    {
        var node  = interactions[i].node;
        ...
    }
    else if (interactions[i].type == Contact.CROSSED_EDGES)
    {
        var start = interactions[i].start;
        ...
    }
}

Keyword()

Description

Returns the keyword for this Contact (*BOUNDARY_PRESCRIBED_MOTION_xxxx). Note that a carriage return is not added. See also Contact.KeywordCards()

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for Contact c:

var key = c.Keyword();

KeywordCards()

Description

Returns the keyword cards for the Contact. Note that a carriage return is not added. See also Contact.Keyword()

Returns

string containing the cards.

Return type

String

Example

To get the cards for Contact c:

var cards = c.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last contact in the model.

Returns

Contact object (or null if there are no contacts in the model).

Return type

Contact

Example

To get the last contact in model m:

var c = Contact.Last(m);

LastFreeLabel(Model[Model], layer (optional)[Include number]) [static]

Description

Returns the last free contact label in the model. Also see Contact.FirstFreeLabel(), Contact.NextFreeLabel() and see Model.LastFreeItemLabel()

Returns

Contact label.

Return type

Number

Example

To get the last free contact label in model m:

var label = Contact.LastFreeLabel(m);

Next()

Description

Returns the next contact in the model.

Returns

Contact object (or null if there are no more contacts in the model).

Return type

Contact

Example

To get the contact in model m after contact c:

var c = c.Next();

NextFreeLabel(Model[Model], layer (optional)[Include number]) [static]

Description

Returns the next free (highest+1) contact label in the model. Also see Contact.FirstFreeLabel(), Contact.LastFreeLabel() and Model.NextFreeItemLabel()

Returns

Contact label.

Return type

Number

Example

To get the next free contact label in model m:

var label = Contact.NextFreeLabel(m);

PenCheck(flag[Flag], eflag[integer])

Description

Flags nodes that penetrate (or tie) in contact

Returns

zero if contact successfully checked

Return type

Number

Example

To set flag f on tracked nodes of Contact c which tie to elements flagged with f:

c.PenCheck(f, f);

PenCheckEdit(modal (optional)[boolean], check_mode (optional)[constant], mpp_threshold (optional)[real], report_crossed_3d_elems (optional)[boolean], contact_penchk_dup_shells (optional)[constant])

Description

launches the interactive edit panel for penetration check on the con

Returns

No return value

Example

To launch an edit panel with modal set to TRUE, check_method set to MPP, mpp_threshold set to 1.123, report_crossed_3d_elems set to true and contact_penchk_dup_shells set to thinnest always:

c.PenCheckEdit(true,Contact.MPP_METHOD,1.123,true,Contact.SHELL_THIN);

Pick(prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean], button text (optional)[string]) [static]

Description

Allows the user to pick a contact.

Returns

Contact object (or null if not picked)

Return type

Contact

Example

To pick a contact from model m giving the prompt 'Pick contact from screen':

var c = Contact.Pick('Pick contact from screen', m);

Previous()

Description

Returns the previous contact in the model.

Returns

Contact object (or null if there are no more contacts in the model).

Return type

Contact

Example

To get the contact in model m before contact c:

var c = c.Previous();

RenumberAll(Model[Model], start[integer]) [static]

Description

Renumbers all of the contacts in the model.

Returns

No return value

Example

To renumber all of the contacts in model m, from 1000000:

Contact.RenumberAll(m, 1000000);

RenumberFlagged(Model[Model], flag[Flag], start[integer]) [static]

Description

Renumbers all of the flagged contacts in the model.

Returns

No return value

Example

To renumber all of the contacts in model m flagged with f, from 1000000:

Contact.RenumberFlagged(m, f, 1000000);

Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean]) [static]

Description

Allows the user to select contacts using standard PRIMER object menus.

Returns

Number of contacts selected or null if menu cancelled

Return type

Number

Example

To select contacts from model m, flagging those selected with flag f, giving the prompt 'Select contacts':

Contact.Select(f, 'Select contacts', m);

To select contacts, flagging those selected with flag f but limiting selection to contacts flagged with flag l, giving the prompt 'Select contacts':

Contact.Select(f, 'Select contacts', l);

SetFlag(flag[Flag])

Description

Sets a flag on the contact.

Returns

No return value

Example

To set flag f for contact c:

c.SetFlag(f);

Sketch(redraw (optional)[boolean])

Description

Sketches the contact. The contact will be sketched until you either call Contact.Unsketch(), Contact.UnsketchAll(), Model.UnsketchAll(), or delete the model

Returns

No return value

Example

To sketch contact c:

c.Sketch();

SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

Description

Sketches all of the flagged contacts in the model. The contacts will be sketched until you either call Contact.Unsketch(), Contact.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

Returns

No return value

Example

To sketch all contacts flagged with flag in model m:

Contact.SketchFlagged(m, flag);

StatusCheck()

Description

Checks sliding contact for crossed edges and penetrations

Returns

An array containing count of crossed edges, count of penetrations (note if a node penetrates more than one segment, it is only reported once here)

Return type

Array

Example

To check Contact c:

var status = c.StatusCheck(); ncrossed = status[0]; npens = status[1]

Total(Model[Model], exists (optional)[boolean]) [static]

Description

Returns the total number of contacts in the model.

Returns

number of contacts

Return type

Number

Example

To get the total number of contacts in model m:

var total = Contact.Total(m);

Unblank()

Description

Unblanks the contact

Returns

No return value

Example

To unblank contact c:

c.Unblank();

UnblankAll(Model[Model], redraw (optional)[boolean]) [static]

Description

Unblanks all of the contacts in the model.

Returns

No return value

Example

To unblank all of the contacts in model m:

Contact.UnblankAll(m);

UnblankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

Description

Unblanks all of the flagged contacts in the model.

Returns

No return value

Example

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

Contact.UnblankFlagged(m, f);

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

Description

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

Returns

No return value

Example

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

Contact.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the contact.

Returns

No return value

Example

To unsketch contact c:

c.Unsketch();

UnsketchAll(Model[Model], redraw (optional)[boolean]) [static]

Description

Unsketches all contacts.

Returns

No return value

Example

To unsketch all contacts in model m:

Contact.UnsketchAll(m);

UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

Description

Unsketches all flagged contacts in the model.

Returns

No return value

Example

To unsketch all contacts flagged with flag in model m:

Contact.UnsketchAll(m, flag);

ViewParameters()

Description

Object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. This function temporarily changes the behaviour so that if a property is a parameter the parameter name is returned instead. This can be used with 'method chaining' (see the example below) to make sure a property argument is correct.

Returns

Contact object.

Return type

Contact

Example

To check if Contact property c.example is a parameter by using the Contact.GetParameter() method:

if (c.ViewParameters().GetParameter(c.example) ) do_something...

Warning(message[string], details (optional)[string])

Description

Adds a warning for contact. For more details on checking see the Check class.

Returns

No return value

Example

To add a warning message "My custom warning" for contact c:

c.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this contact.

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for contact c:

var xrefs = c.Xrefs();

toString()

Description

Creates a string containing the Contact data in keyword format. Note that this contains the keyword header and the keyword cards. See also Contact.Keyword() and Contact.KeywordCards().

Returns

string

Return type

String

Example

To get data for Contact c in keyword format

var data = c.toString();