Model class

Returns

Model object

Return type

Model

Example

To create a new model

var m = new Model();

To create model 10

var m = new Model(10);

Details of functions

AreaVolumeFlagged(flag[Flag])

Description

Calculates the Area/Volume of the selected items.
Note: The area calculation is based only on shell elements, and the volume calculation is based only on solid elements.

Returns

Example

To calculate the area/volume properties of the items flagged by flag f.

var props = m.AreaVolumeFlagged(f);
var area = props.area;
var volume = props.volume;

Attached(flag[Flag], redraw (optional)[boolean])

Description

Finds attached items to flagged items. The attached items are flagged with the same flag.

Returns

No return value

Example

To find items attached to items flagged with flag f in model m:

m.Attached(f);

Autofix()

Description

Autofix option does a model check and autofixes all the fixable errors in the model

Returns

No return value

Example

To autofix fixable errors of the model 'm'

m.Autofix();

Blank()

Description

Blanks a model in PRIMER

Returns

No return value

Example

To blank model object m

m.Blank();

BlankAll() [static]

Description

Blanks all models

Returns

No return value

Example

To blank all models

Model.BlankAll();

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

Description

Blanks all of the flagged items in the model.

Returns

No return value

Example

To blank everything in model m flagged with flag f:

m.BlankFlagged(f);

CentreOfGravity()

Description

Returns the centre of gravity for a model

Returns

An array containing the x, y and z coordinates for the CofG.

Return type

Array

Example

To get the centre of gravity for model m:

var cofg = m.CentreOfGravity();
var x = cofg[0];
var y = cofg[1];
var z = cofg[2];

Check(filename[string], detailed (optional)[boolean], json (optional)[boolean], include (optional)[boolean])

Description

Checks a model, writing any errors to file.

Returns

No return value

Example

To check model m, writing detailed errors to file 'errors.txt' in include layout:

m.Check('errors.txt', true, false, true);

To check a model writing the warnings/errors as JSON to file 'errors.json', parse it and write them to the dialogue box:

m.Check('errors.json', true, true);
var f = new File('errors.json', File.READ);
var json = f.ReadAll();
f.Close();
var o = JSON.parse(json);

for (var e in o)                                     // "error" or "warning"
{
    Message(e);
    for (var t in o[e])                              // type
    {
        Message("  "+t);
        for (var m in o[e][t])                       // message
        {
            Message("    "+m);
            for (var i=0; i<o[e][t][m].length; i++)  // Array of objects containing label and include
            {
                Message("        "+o[e][t][m][i].label+" (include "+o[e][t][m][i].include+")");
            }
        }
    }
}

ClearFlag(flag[Flag])

Description

Clears the flagging for a model in PRIMER. See also Model.PropagateFlag(), Model.SetFlag(), global.AllocateFlag() and global.ReturnFlag().

Returns

No return value

Example

To clear flag f for everything in model m:

m.ClearFlag(f);

Copy(update (optional)[boolean])

Description

Copy model to the next free model in PRIMER

Returns

Model object for new model.

Return type

Model

Example

To copy model m to the next free model in PRIMER.

var mnew = m.Copy();

CopyFlagged(flag[Flag], update (optional)[boolean])

Description

Copy flagged items in a model to the next free model in PRIMER

Returns

Model object for new model.

Return type

Model

Example

To copy everything in model m flagged with flag f to the next free model in PRIMER.

var mnew = m.CopyFlagged(f);

Delete()

Description

Deletes a model in PRIMER
Do not use the Model object after calling this method.

Returns

No return value

Example

To delete model m in PRIMER

m.Delete();

DeleteAll() [static]

Description

Deletes all existing models from PRIMER

Returns

No return value

Example

To delete all models

Model.DeleteAll();

DeleteFlagged(flag[Flag], recursive (optional)[boolean])

Description

Deletes all of the flagged items in the model. Note that this may not actually delete all of the items. For example if a node is flagged but the node is used in a shell which is not flagged then the node will not be deleted.

Returns

No return value

Example

To delete everything in model m flagged with flag f:

m.DeleteFlagged(f);

DeleteInclude(Include label[integer], method (optional)[constant], force (optional)[boolean])

Description

Tries to delete an include file from the model. Note that this may not actually delete the include file. For example if some of the items in the include file are required by other things in different includes then the include file will not be deleted.

Returns

true if include successfully deleted, false otherwise

Return type

Boolean

Example

To delete include file number 5 in model m removing items from sets in other includes if required:

m.DeleteInclude(5, 1);

FindElemEnd()   [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

Tidy internal flag used by functions which find elements within a box. This function is only required if there has been a previous call to Model.FindElemInit() with a flag defined. This usage is deprecated for v20.0 where the flag should be applied in Beam.FindBeamInBox() Shell.FindShellInBox() Solid.FindSolidInBox() Tshell.FindTShellInBox() and there is no need to use FindElemInit or FindElemEnd

Returns

No return value

Example

m.FindElemEnd();

FindElemInit(flag (optional)[Flag])   [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

In v20.0 this function is obsolete. FindXXXInBox() is called without it. Refinement of element selection is now done with optional flagging argument in Beam.FindBeamInBox() Shell.FindShellInBox() Solid.FindSolidInBox() Tshell.FindTShellInBox() If you do use this function with flagging bit (not recommended), PRIMER copies flagging to another allocated flag, so you will need on completion to call FindElemEnd() to return this flag.

Returns

No return value

Example

To initialize find setup for flagged elements in model m:

m.FindElemInit(flag);

First() [static]

Description

Returns the Model object for the first model in PRIMER (or null if there are no models)

Returns

Model object

Return type

Model

Example

To get the Model object for the first model:

var m = Model.First();

FirstFreeItemLabel(type[string], layer (optional)[Include number]) [static]

Description

Returns the first free label for an item type in the model. Also see Model.LastFreeItemLabel() and Model.NextFreeItemLabel().

Returns

integer

Return type

Number

Example

To get the first free node label in model m:

var label = m.FirstFreeItemLabel("NODE");

FlagDuplicate(flag[Flag])

Description

Flag all nodes referenced in two different includes

Returns

No return value

Example

To Flag with flag f all the nodes referenced in different includes from model m

m.FlagDuplicate(f);

Flagged(flag[Flag])

Description

Checks if the model is flagged or not

Returns

true if flagged, false if not

Return type

Boolean

Example

To check if model m has flag f set on it:

if (m.Flagged(f) ) do_something...

GetAll() [static]

Description

Returns an array of Model objects for all the models in PRIMER

Returns

Array of Model objects

Return type

Array

Example

To make an array of Model objects for all of the models in PRIMER

var m = Model.GetAll();

GetFromID(model number[integer]) [static]

Description

Returns the Model object for a model ID or null if model does not exist

Returns

Model object

Return type

Model

Example

To get the Model object for model number 1

var m = Model.GetFromID(1);

GetIncludeTransformOffsets()

Description

Looks at all of the items in the model and determines values for IDNOFF, IDEOFF, IDPOFF etc that could be used with Model.ImportIncludeTransform to guarantee that there would not be any clashes with existing items in the model.

Returns

Example

To determine offsets for model m and then import an include transform "test.inc":

var o = m.GetIncludeTransformOffsets();
if (o)
{
    var success = m.ImportIncludeTransform("test.inc", o.idnoff, o.ideoff, o.idpoff, o.idmoff, o.idsoff, o.idfoff, o.iddoff, o.idroff);
}

Hide()

Description

Hides a model in PRIMER

Returns

No return value

Example

To hide model m in PRIMER

m.Hide();

Import(filename[string])

Description

Imports a file into model m. The model can already contain items. However, note that if the file cannot be imported because of a label clash or other problem PRIMER may delete the model and the script will terminate. Note prior to v17 of PRIMER imported data would always be imported to the master model, irrespective of the current layer. From v17 onwards this has been corrected and the current layer is used to determine the destination of imported data.

Returns

0: No errors/warnings.
> 0: This number of errors occurred.
< 0: Absolute number is the number of warnings that occurred.

Return type

Number

Example

To import file "test.key" into model m

m.Import("test.key");

ImportInclude(source[String OR Include Object], target (optional)[Include Object])

Description

Imports a keyword file or an Include object from different model as a new include or into an existing include file for model m. The labels of any items in the imported include contents that clash with existing labels will automatically be renumbered with one exception. The behaviour for *SET_COLLECT cards can be controlled with Options.merge_set_collect.

Returns

Include object for include file

Return type

Include

Example

To import include file "include.key" into model m (include.key will be a new include file in model m):

m.ImportInclude("include.key");

To import include file "include.key" into existing include number 3 in model m (include.key will be merged with include number 3 of m):

var incl_target = Include.GetFromID(m, 3);
m.ImportInclude("include.key", incl_target);

To import include number 5 from model m2 into model m1 (include number 5 from m2 will be a new include file in model m1):

var incl_source = Include.GetFromID(m2, 5);
m1.ImportInclude(incl_source);

To import include number 5 from model m2 into existing include number 3 in model m1 (include number 5 from m2 will be merged with include number 3 in m1):

var incl_source = Include.GetFromID(m2, 5);
var incl_target = Include.GetFromID(m1, 3);
m1.ImportInclude(incl_source, incl_target);

ImportIncludeTransform(filename[string], idnoff[integer], ideoff[integer], idpoff[integer], idmoff[integer], idsoff[integer], idfoff[integer], iddoff[integer], idroff[integer])

Description

Imports a file as an include transform file for model m. The labels of any items in the include file will be renumbered by idnoff, ideoff etc.

Returns

Include object if successful, null if not

Return type

Include

Example

To import include transform file "include.key" into model m using 1000 for all offsets

m.ImportIncludeTransform("include.key", 1000, 1000, 1000, 1000, 1000, 1000, 1000, 1000);

Last() [static]

Description

Returns the Model object for the last model in PRIMER (or null if there are no models)

Returns

Model object

Return type

Model

Example

To get the Model object for the last model:

var m = Model.Last();

LastFreeItemLabel(type[string], layer (optional)[Include number]) [static]

Description

Returns the last free label for an item type in the model. Also see Model.FirstFreeItemLabel() and Model.NextFreeItemLabel().

Returns

integer

Return type

Number

Example

To get the last free node label in model m:

var label = m.LastFreeItemLabel("NODE");

Mass()

Description

Returns the mass for a model

Returns

real

Return type

Number

Example

To get the mass for model m:

var mass = m.Mass();

MassPropCalc(flag[Flag])

Description

Calculates the Mass, CoG, and Intertia Tensor of the flagged items and returns an object with the above properties. See Properties for mass properties calculation under options class to configure inclusion of lumped mass, etc.

Returns

Example

To calculate the mass properties of the items flagged by flag f

var props = m.MassPropCalc(f);

Merge(Primary Model[Model], Secondary Model[Model], Option to fix clashes (optional)[constant], Merge nodes flag (optional)[boolean], dist (required if merge nodes flag used) (optional)[real], label (optional)[integer], position (optional)[integer]) [static]

Description

Merge 2 models together to make a new model.

Returns

Model object (or null if the merge is unsuccessful)

Return type

Model

Example

To merge models m1 and m2 together:

var m = Model.Merge(m1, m2);

MergeNodes(flag[Flag], dist[real], label (optional)[integer], position (optional)[integer])

Description

Attempts to merge nodes on items flagged with flag for this model in PRIMER. Merging nodes on *AIRBAG_SHELL_REFERENCE_GEOMETRY can be controlled by using Options.node_replace_asrg. Also see Node.Merge().

Returns

The number of nodes merged

Return type

Number

Example

To (try to) merge nodes on everything in model m flagged with flag f, with a distance of 0.1:

m.MergeNodes(f, 0.1);

NextFreeItemLabel(type[string], layer (optional)[Include number]) [static]

Description

Returns the next free label for an item type in the model. Also see Model.FirstFreeItemLabel() and Model.LastFreeItemLabel().

Returns

integer

Return type

Number

Example

To get the next free node label in model m:

var label = m.NextFreeItemLabel("NODE");

PopulateInitialVelocities()

Description

Populate the initial velocity field (nvels) for all nodes of the model

Returns

No return value

Example

m.PopulateInitialVelocities();

PropagateFlag(flag[Flag])

Description

Propagates the flagging for a model in PRIMER. For example if a part in the model is flagged, this will flag the elements in the part, the nodes on those elements... See also Model.ClearFlag(), Model.SetFlag(), global.AllocateFlag() and global.ReturnFlag().

Returns

No return value

Example

To propagate the flagging in model m for flag f

m.PropagateFlag(f);

Read(filename[string], filetype (optional)[constant], number (optional)[integer]) [static]

Description

Reads a file into the first free model in PRIMER

Returns

Model object (or null if error)

Return type

Model

Example

To read the keyword file /data/test/file.key

Model.Read("/data/test/file.key");

To read the NASTRAN file /data/test/file.dat

Model.Read("/data/test/file.dat", Model.NASTRAN);

To read the keyword file /data/test/file.key into model 10

Model.Read("/data/test/file.key", Model.LSDYNA, 10);

RenumberAll(start[integer])

Description

Renumbers all of the items in the model.

Returns

No return value

Example

To renumber everything in model m, starting at 1000000:

m.RenumberAll(1000000);

RenumberFlagged(flag[Flag], start[integer], mode (optional)[constant])

Description

Renumbers all of the flagged items in the model.

Returns

No return value

Example

To renumber everything in model m flagged with flag f, starting at 1000000, using mode MOVE_CLASH_UP:

m.RenumberFlagged(f, 1000000, Model.MOVE_CLASH_UP);

Select(prompt[string], modal (optional)[boolean]) [static]

Description

Allows the user to select a model using standard PRIMER object menus. If there are no models in memory then Select returns null. If only one model is present then the model object is returned. If there is more than one model in memory then an object menu is mapped allowing the user to choose a model.

Returns

Model object (or null if no models present).

Return type

Model

Example

To select a model giving the prompt 'Select model':

var m = Model.Select('Select model');

SetColour(colour[colour from Colour class.])

Description

Sets the colour of the model.

Returns

No return value

Example

To set the colour of model m to red:

m.SetColour(Colour.RED);

or

m.SetColour(Colour.RGB(255, 0, 0));

SetFlag(flag[Flag])

Description

Sets the flagging for a model in PRIMER. See also Model.PropagateFlag(), Model.ClearFlag(), global.AllocateFlag() and global.ReturnFlag().

Returns

No return value

Example

To set flag f for everything in model m:

m.SetFlag(f);

Show()

Description

Shows a model in PRIMER

Returns

No return value

Example

To show model m in PRIMER

m.Show();

Total() [static]

Description

Returns the total number of models.

Returns

integer

Return type

Number

Example

To find how many models there are in PRIMER:

var num = Model.Total();

Unblank()

Description

Unblanks a model in PRIMER

Returns

No return value

Example

To unblank model m

m.Unblank();

UnblankAll() [static]

Description

Unblanks all models

Returns

No return value

Example

To unblank all models

Model.UnblankAll();

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

Description

Unblanks all of the flagged items in the model.

Returns

No return value

Example

To unblank everything in model m flagged with flag f:

m.UnblankFlagged(f);

UnsketchAll(redraw (optional)[boolean])

Description

Unsketches all of the sketched items in the model.

Returns

No return value

Example

To unsketch all the sketched objects in model m:

m.UnsketchAll();

UpdateGraphics()

Description

Updates the graphics for a model in PRIMER

Returns

No return value

Example

To update the graphics for model m

m.UpdateGraphics();

UsesLargeLabels()

Description

Checks to see if a model uses large labels

Returns

logical, true if model uses large labels, false otherwise

Return type

Boolean

Example

To check if model m uses large labels:

var large = m.UsesLargeLabels();

Write(filename[string], options (optional)[object])

Description

Writes a model in PRIMER to file

Returns

No return value

Example

To Write model m to file /data/test/file.key as a compressed gzip in version R10.0

 var output_obj = new Object();
 output_obj.version = "R10.0";
 output_obj.compress = true;
 output_obj.compressMode = Model.INDIVIDUAL_GZIP;
 m.Write("/data/test/file.key", output_obj);

Write(filename[string], method (optional)[constant], path (optional)[constant], separator (optional)[constant], version (optional)[string], large (optional)[boolean])   [deprecated]

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

Writes a model in PRIMER to file

Returns

No return value

Example

To Write model m to file /data/test/file.key

m.Write("/data/test/file.key");