InterfaceSpringback class

The InterfaceSpringback class gives you access to interface springback cards in PRIMER. More...

The PRIMER 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

Create(Model[Model], modal (optional)[boolean])
First(Model[Model])
FlagAll(Model[Model], flag[Flag])
ForEach(Model[Model], func[function], extra (optional)[any])
GetAll(Model[Model], property (optional)[string])
GetFlagged(Model[Model], flag[Flag], property (optional)[string])
GetFromID(Model[Model], number[integer])
Last(Model[Model])
Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean])
Total(Model[Model], exists (optional)[boolean])
UnflagAll(Model[Model], flag[Flag])

Member functions

AssociateComment(Comment[Comment])
Browse(modal (optional)[boolean])
ClearFlag(flag[Flag])
Copy(range (optional)[boolean])
DetachComment(Comment[Comment])
Edit(modal (optional)[boolean])
Error(message[string], details (optional)[string])
Flagged(flag[Flag])
GetComments()
GetExcludeKeyword(idx[integer])
GetNodalPoint(npt[integer])
GetParameter(prop[string])
Keyword()
KeywordCards()
Next()
Previous()
RemoveExcludeKeyword(idx[integer])
RemoveNodalPoint(npt[integer])
SetExcludeKeyword(keystr[string], index (optional)[integer])
SetFlag(flag[Flag])
SetNodalPoint(npt[integer], nid[integer], tc[real], rc[real])
ViewParameters()
Warning(message[string], details (optional)[string])
Xrefs()
toString()

InterfaceSpringback constants

Constants for Types of Keyword

Name	Description
InterfaceSpringback.EXCLUDE	INTERFACE is *INTERFACE_SPRINGBACK_EXCLUDE.
InterfaceSpringback.LSDYNA	INTERFACE is *INTERFACE_SPRINGBACK_LSDYNA.
InterfaceSpringback.NASTRAN	INTERFACE is *INTERFACE_SPRINGBACK_NASTRAN.
InterfaceSpringback.NIKE3D	INTERFACE is *INTERFACE_SPRINGBACK_NIKE3D.
InterfaceSpringback.SEAMLESS	INTERFACE is *INTERFACE_SPRINGBACK_SEAMLESS.

InterfaceSpringback properties

Name	Type	Description
cflag	integer	Output contact state.
dtwrt	real	Time Interval.
exists (read only)	logical	true if interface springback exists, false if referred to but not defined.
fsplit	integer	Flag for splitting of the dynain file (0 - One file, 1 - Two files.). Used for OPTCARD field.
ftensr	integer	Flag for dumping tensor data from the element history variables into the dynain file (0/1).
ftype	integer	Filetype (0-3, 10-12).
hflag	integer	Output hourglass state.
include	integer	The Include file number that the interface springback is in.
intstrn	integer	Output of strains at all integration points of shell element is requested.
ivflg	integer	Initial volume output.
model (read only)	integer	The Model number that the interface springback is in.
ncyc	integer	Number of process cycles. Used for OPTCARD field.
ndflag	integer	Flag to dump nodes into dynain file.
nexclude	integer	gives the number of excluded keywords. Needed only for InterfaceSpringback.EXCLUDE.
nmwrt	integer	Maximum number of files.
nnodes	integer	gives the number of nodal points constrained for this keyword. (read_only)
nothickness	logical	true if _NOTHICKNESS (option2) is set. _NOTHICKNESS can be used only for InterfaceSpringback.LSDYNA or InterfaceSpringback.NASTRAN.
nshv	integer	Num additional Shell/Solid history variables number.
nthhsv	integer	Number of thermal history variables.
optcard	integer	(0) no optional cards (1) to have optional card 2 (2) to have optional cards 2, 3.1, 3.2.
psid	integer	Part set ID for springback.
sldo	integer	Output of solid element data as 0 - ELEMENT_SOLID, 1- ELEM_SOLID_ORTHO. Used for OPTCARD field.
type (read only)	integer	gives the type of InterfaceSpringback object.

Detailed Description

The InterfaceSpringback class allows you to create, modify, edit and manipulate interface springback cards. See the documentation below for more details.

Constructor

new InterfaceSpringback(Model[Model], options [object])

Description

Create a new InterfaceSpringback object.

Arguments

Model (Model)

Model that interface springback will be created in

options (object)

Options for creating the interface springback

Object has the following properties:

Name	Type	Description
cflag (optional)	integer	Output contact state.
dtwrt	real	Time Interval.
fsplit (optional)	integer	Flag for splitting of the dynain file (0 - One file, 1 - Two files.). Used only for optional card.
ftensr (optional)	integer	Flag for dumping tensor data from the element history variables into the dynain file (0/1).
ftype (optional)	integer	Filetype (0-3, 10-12).
hflag (optional)	integer	Output hourglass state.
intstrn (optional)	integer	Output of strains at all integration points of shell element is requested.
ivflg	integer	Initial volume output.
keylist (optional)	Array of strings	List of keywords to be excluded.(ONLY for EXCLUDE)
ncyc (optional)	integer	Number of process cycles. Used only for optional card.
ndflag (optional)	integer	Flag to dump nodes into dynain file.
nmwrt	integer	Maximum number of files.
nshv (optional)	integer	Num additional Shell/Solid history variables number.
nthhsv (optional)	integer	Number of thermal history variables.
optcard (optional)	integer	(0) no optional cards (1) to have optional card 2 (2) to have optional cards 2, 3.1, 3.2.
psid (optional)	integer	Part set ID for springback.(NOT for _EXCLUDE)
sldo (optional)	integer	Output of solid element data as 0 - ELEMENT_SOLID, 1- ELEM_SOLID_ORTHO. Used only for optional card.
type	constant	Specify the type of InterfaceSpringback (Can be InterfaceSpringback.NIKE3D or InterfaceSpringback.LSDYNA or InterfaceSpringback.NASTRAN or InterfaceSpringback.SEAMLESS )

Returns

InterfaceSpringback object

Return type

InterfaceSpringback

Example

To create a new interface springback in model m, type LSDYNA, part set id 100:

var i_s = new InterfaceSpringback(m, InterfaceSpringback.LSDYNA, 100);

Details of functions

AssociateComment(Comment[Comment])

Description

Associates a comment with a interface springback.

Arguments

Comment (Comment)

Comment that will be attached to the interface springback

Returns

No return value

Example

To associate comment c to the interface springback i_s:

i_s.AssociateComment(c);

Browse(modal (optional)[boolean])

Description

Starts an edit panel in Browse mode.

Arguments

modal (optional) (boolean)

If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

Returns

no return value

Example

To Browse interface springback i_s:

i_s.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the interface springback.

Arguments

flag (Flag)

Flag to clear on the interface springback

Returns

No return value

Example

To clear flag f for interface springback i_s:

i_s.ClearFlag(f);

Copy(range (optional)[boolean])

Description

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

Arguments

range (optional) (boolean)

If you want to keep the copied item in the range specified for the current include. Default value is false. To set current include, use Include.MakeCurrentLayer().

Returns

InterfaceSpringback object

Return type

InterfaceSpringback

Example

To copy interface springback i_s into interface springback z:

var z = i_s.Copy();

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

Description

Starts an interactive editing panel to create a interface springback

Arguments

Model (Model)

Model that the interface springback will be created in.

modal (optional) (boolean)

If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

Returns

InterfaceSpringback object (or null if not made).

Return type

InterfaceSpringback

Example

To start creating a interface springback in model m:

var i_s = InterfaceSpringback.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a interface springback.

Arguments

Comment (Comment)

Comment that will be detached from the interface springback

Returns

No return value

Example

To detach comment c from the interface springback i_s:

i_s.DetachComment(c);

Edit(modal (optional)[boolean])

Description

Starts an interactive editing panel.

Arguments

modal (optional) (boolean)

If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal.

Returns

no return value

Example

To Edit interface springback i_s:

i_s.Edit();

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

Description

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

Arguments

message (string)

The error message to give

details (optional) (string)

An optional detailed error message

Returns

No return value

Example

To add an error message "My custom error" for interface springback i_s:

i_s.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first interface springback in the model.

Arguments

Model (Model)

Model to get first interface springback in

Returns

InterfaceSpringback object (or null if there are no interface springbacks in the model).

Return type

InterfaceSpringback

Example

To get the first interface springback in model m:

var i_s = InterfaceSpringback.First(m);

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

Description

Flags all of the interface springbacks in the model with a defined flag.

Arguments

Model (Model)

Model that all interface springbacks will be flagged in

flag (Flag)

Flag to set on the interface springbacks

Returns

No return value

Example

To flag all of the interface springbacks with flag f in model m:

InterfaceSpringback.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the interface springback is flagged or not.

Arguments

flag (Flag)

Flag to test on the interface springback

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if interface springback i_s has flag f set on it:

if (i_s.Flagged(f) ) do_something...

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

Description

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

Arguments

Model (Model)

Model that all interface springbacks are in

func (function)

Function to call for each interface springback

extra (optional) (any)

An optional extra object/array/string etc that will appended to arguments when calling the function

Returns

No return value

Example

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

InterfaceSpringback.ForEach(m, test);
function test(i_s)
{
// i_s is InterfaceSpringback object
}

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

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

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

Description

Returns an array of InterfaceSpringback objects or properties for all of the interface springbacks in a model in PRIMER. If the optional property argument is not given then an array of InterfaceSpringback objects is returned. If the property argument is given, that property value for each interface springback is returned in the array instead of a InterfaceSpringback object

Arguments

Model (Model)

Model to get interface springbacks from

property (optional) (string)

Name for property to get for all interface springbacks in the model

Returns

Array of InterfaceSpringback objects or properties

Return type

Array

Example

To make an array of InterfaceSpringback objects for all of the interface springbacks in model m:

var a = InterfaceSpringback.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a interface springback.

Arguments

No arguments

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 interface springback i_s:

var comm_array = i_s.GetComments();

GetExcludeKeyword(idx[integer])

Description

Returns the keyword string excluded at given index in Keyword list. Needed only for InterfaceSpringback.EXCLUDE.

Arguments

idx (integer)

The index in Keyword list you want the Keyword string for. Note that indices start at 0, not 1.

Returns

A Keyword string at index "idx" from excluded keyword list .

Return type

String

Example

To get the 3rd Keyword string in Interface Springback i_s:

if (i_s.nexclude >= 3)
{
    var keyword = i_s.GetExcludeKeyword(2);
}

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

Description

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

Arguments

Model (Model)

Model to get interface springbacks from

flag (Flag)

Flag set on the interface springbacks that you want to retrieve

property (optional) (string)

Name for property to get for all flagged interface springbacks in the model

Returns

Array of InterfaceSpringback objects or properties

Return type

Array

Example

To make an array of InterfaceSpringback objects for all of the interface springbacks in model m flagged with f:

var i_s = InterfaceSpringback.GetFlagged(m, f);

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

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

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

Description

Returns the InterfaceSpringback object for a interface springback ID.

Arguments

Model (Model)

Model to find the interface springback in

number (integer)

number of the interface springback you want the InterfaceSpringback object for

Returns

InterfaceSpringback object (or null if interface springback does not exist).

Return type

InterfaceSpringback

Example

To get the InterfaceSpringback object for interface springback 100 in model m

var i_s = InterfaceSpringback.GetFromID(m, 100);

GetNodalPoint(npt[integer])

Description

Returns the data for nodal point constrained for *INTERFACE_SPRINGBACK.

Arguments

npt (integer)

The nodal point you want the data for. Note that nodal points start at 0, not 1.

Returns

An array containing the Node id, translational constraint (TC) and rotational constraint (RC) constants.

Return type

Array

Example

To get the nodal point data for the 3rd nodal constraint for Interface Springback i_s:

if (i_s.nnodes >= 3)
{
    var npt_data = i_s.GetNodalPoint(2);
}

GetParameter(prop[string])

Description

Checks if a InterfaceSpringback 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 InterfaceSpringback.ViewParameters() method and 'method chaining' (see the examples below).

Arguments

prop (string)

interface springback property to get parameter for

Returns

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

Return type

Parameter

Example

To check if InterfaceSpringback property i_s.example is a parameter:

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

To check if InterfaceSpringback property i_s.example is a parameter by using the GetParameter method:

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

Keyword()

Description

Returns the keyword for this Interface Springback (*INTERFACE_SPRINGBACK_xxxx_xxxx) Note that a carriage return is not added. See also InterfaceSpringback.KeywordCards()

Arguments

No arguments

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for InterfaceSpringback i_s:

var key = i_s.Keyword();

KeywordCards()

Description

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

Arguments

No arguments

Returns

string containing the cards.

Return type

String

Example

To get the cards for InterfaceSpringback i_s:

var cards = i_s.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last interface springback in the model.

Arguments

Model (Model)

Model to get last interface springback in

Returns

InterfaceSpringback object (or null if there are no interface springbacks in the model).

Return type

InterfaceSpringback

Example

To get the last interface springback in model m:

var i_s = InterfaceSpringback.Last(m);

Next()

Description

Returns the next interface springback in the model.

Arguments

No arguments

Returns

InterfaceSpringback object (or null if there are no more interface springbacks in the model).

Return type

InterfaceSpringback

Example

To get the interface springback in model m after interface springback i_s:

var i_s = i_s.Next();

Previous()

Description

Returns the previous interface springback in the model.

Arguments

No arguments

Returns

InterfaceSpringback object (or null if there are no more interface springbacks in the model).

Return type

InterfaceSpringback

Example

To get the interface springback in model m before interface springback i_s:

var i_s = i_s.Previous();

RemoveExcludeKeyword(idx[integer])

Description

Removes the keyword string excluded at given index in Keyword list. Needed only for InterfaceSpringback.EXCLUDE

Arguments

idx (integer)

The index in Keyword list you removed. Note that indices start at 0, not 1.

Returns

No return value.

Example

To remove the 3rd Keyword string in Interface Springback i_s:

if (i_s.nexclude >= 3)
{
    var keyword = i_s.RemoveExcludeKeyword(2);
}

RemoveNodalPoint(npt[integer])

Description

Removes the nodal point for constrained node for *INTERFACE_SPRINGBACK.

Arguments

npt (integer)

The nodal point you want to remove. Note that nodal points start at 0, not 1.

Returns

No return value.

Example

To remove the nodal point for the 3rd node for InterfaceSpringback i_s:

i_s.RemoveNodalPoint(2);

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

Description

Allows the user to select interface springbacks using standard PRIMER object menus.

Arguments

flag (Flag)

Flag to use when selecting interface springbacks

prompt (string)

Text to display as a prompt to the user

limit (optional) (Model or Flag)

If the argument is a Model then only interface springbacks from that model can be selected. If the argument is a Flag then only interface springbacks that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any interface springbacks can be selected. from any model.

modal (optional) (boolean)

If selection is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the selection will be modal.

Returns

Number of interface springbacks selected or null if menu cancelled

Return type

Number

Example

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

InterfaceSpringback.Select(f, 'Select interface springbacks', m);

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

InterfaceSpringback.Select(f, 'Select interface springbacks', l);

SetExcludeKeyword(keystr[string], index (optional)[integer])

Description

Sets a keyword string to be excluded. Adds a new keyword if index value is not given, else replaces the keyword string at given index. Note that indices start at 0, not 1. Needed only for InterfaceSpringback.EXCLUDE

Arguments

keystr (string)

The keyword string you want to be excluded.

index (optional) (integer)

The index at which keyword string should be set.

Returns

No return value.

Example

To set a keyword string at index 3 to be excluded for InterfaceSpringback i_s:

if(i_s.nexclude >= 4)
    i_s.SetExcludeKeyword("ELEMENT_SHELL", 3);

SetFlag(flag[Flag])

Description

Sets a flag on the interface springback.

Arguments

flag (Flag)

Flag to set on the interface springback

Returns

No return value

Example

To set flag f for interface springback i_s:

i_s.SetFlag(f);

SetNodalPoint(npt[integer], nid[integer], tc[real], rc[real])

Description

Sets the nodal point data for a node in *INTERFACE_SPRINGBACK.

Arguments

npt (integer)

The nodal point you want to set the data for. Note that nodal points start at 0, not 1.

nid (integer)

Node ID for the nodal point.

tc (real)

Translational constraint constant of the nodal point. (0-7)

rc (real)

Rotational constraint constant of the nodal point. (0-7)

Returns

No return value.

Example

To set the nodal data for the 3rd nodal point to node 1, tc 2 and rc 4, for InterfaceSpringback i_s:

i_s.SetNodalPoint(2, 1, 2, 4);

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

Description

Returns the total number of interface springbacks in the model.

Arguments

Model (Model)

Model to get total for

exists (optional) (boolean)

true if only existing interface springbacks should be counted. If false or omitted referenced but undefined interface springbacks will also be included in the total.

Returns

number of interface springbacks

Return type

Number

Example

To get the total number of interface springbacks in model m:

var total = InterfaceSpringback.Total(m);

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

Description

Unsets a defined flag on all of the interface springbacks in the model.

Arguments

Model (Model)

Model that the defined flag for all interface springbacks will be unset in

flag (Flag)

Flag to unset on the interface springbacks

Returns

No return value

Example

To unset the flag f on all the interface springbacks in model m:

InterfaceSpringback.UnflagAll(m, f);

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.

Arguments

No arguments

Returns

InterfaceSpringback object.

Return type

InterfaceSpringback

Example

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

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

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

Description

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

Arguments

message (string)

The warning message to give

details (optional) (string)

An optional detailed warning message

Returns

No return value

Example

To add a warning message "My custom warning" for interface springback i_s:

i_s.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this interface springback.

Arguments

No arguments

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for interface springback i_s:

var xrefs = i_s.Xrefs();

toString()

Description

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

Arguments

No arguments

Returns

string

Return type

String

Example

To get data for InterfaceSpringback i_s in keyword format

var i_str = i_s.toString();