Solid class

Returns

Solid object

Return type

Solid

Example

To create a new solid in model m with label 100, part 10 and nodes 1, 2, 3, 4:

var s = new Solid(m, {eid: 100, pid: 10, nodes: [1,2,3,4]} );

new Solid(Model[Model], eid[integer], pid[integer], n1[integer], n2[integer], n3[integer], n4[integer], n5 (optional)[integer], n6 (optional)[integer], n7 (optional)[integer], n8 (optional)[integer])   [deprecated]

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

Create a new Solid object. Use either 4, 6 or 8 nodes when creating a new solid. If you are creating a 4 noded solid either only give 4 nodes or give 8 nodes but make nodes 4 to 8 the same number. If you are creating a 6 noded solid either only give 6 nodes or give 8 nodes but make nodes 5 and 6 the same number and nodes 7 and 8 the same number.

Returns

Solid object

Return type

Solid

Example

To create a new solid in model m with label 100, part 10 and nodes 1, 2, 3, 4, 5, 6, 7, 8:

var s = new Solid(m, 100, 10, 1, 2, 3, 4, 5, 6, 7, 8); 

Details of functions

AspectRatio()

Description

Calculates the aspect ratio for the solid

Returns

real

Return type

Number

Example

To calculate the aspect ratio for solid s:

var ratio = s.AspectRatio();

AssociateComment(Comment[Comment])

Description

Associates a comment with a solid.

Returns

No return value

Example

To associate comment c to the solid s:

s.AssociateComment(c);

Blank()

Description

Blanks the solid

Returns

No return value

Example

To blank solid s:

s.Blank();

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

Description

Blanks all of the solids in the model.

Returns

No return value

Example

To blank all of the solids in model m:

Solid.BlankAll(m);

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

Description

Blanks all of the flagged solids in the model.

Returns

No return value

Example

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

Solid.BlankFlagged(m, f);

Blanked()

Description

Checks if the solid is blanked or not.

Returns

true if blanked, false if not.

Return type

Boolean

Example

To check if solid s is blanked:

if (s.Blanked() ) do_something...

Browse(modal (optional)[boolean])

Description

Starts an edit panel in Browse mode.

Returns

no return value

Example

To Browse solid s:

s.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the solid.

Returns

No return value

Example

To clear flag f for solid s:

s.ClearFlag(f);

CoordsToIsoparametric(Model[Model], x[real], y[real], z[real], n1[integer], n2[integer], n3[integer], n4[integer]) [static]

Description

Calculates the isoparametric coordinates for a point on 3 or 4 noded segment

Returns

Array containing s and t isoparametric coordinates and the distance the point is from the segment If it is not possible to calculate the isoparametric coordinates null is returned.

Return type

Array

Example

To calculate the isoparametric coordinates of point (100, 100, 20) on segment defined by nodes 11,12,13,14:

var isocoords = Solid.CoordsToIsoparametric(100, 100, 20, 11, 12, 13, 14);

Copy(range (optional)[boolean])

Description

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

Returns

Solid object

Return type

Solid

Example

To copy solid s into solid z:

var z = s.Copy();

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

Description

Starts an interactive editing panel to create a solid

Returns

Solid object (or null if not made).

Return type

Solid

Example

To start creating a solid in model m:

var s = Solid.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a solid.

Returns

No return value

Example

To detach comment c from the solid s:

s.DetachComment(c);

Edit(modal (optional)[boolean])

Description

Starts an interactive editing panel.

Returns

no return value

Example

To Edit solid s:

s.Edit();

ElemCut(Database cross section label[integer])

Description

Returns coordinates of the intersections between a solid and a database cross section.

Returns

Example

To see if the database cross section 200 cuts solid s and at which points it cuts face 3 of the solid:

var data = s.ElemCut(200);
var face = data.face3;
if(face)
{
   var point1_x = face[0];
   var point1_y = face[1];
   var point1_z = face[2];
   var point2_x = face[3];
   var point2_y = face[4];
   var point2_z = face[5];
} 

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

Description

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

Returns

No return value

Example

To add an error message "My custom error" for solid s:

s.Error("My custom error");

ExtractColour()

Description

Extracts the actual colour used for solid.
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 solid 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 solid.

Returns

colour value (integer)

Return type

Number

Example

To return the colour used for drawing solid s:

var colour = s.ExtractColour();

FindSolidInBox(Model[Model], xmin[real], xmax[real], ymin[real], ymax[real], zmin[real], zmax[real], flag (optional)[integer], excl (optional)[integer], vis_only (optional)[integer]) [static]

Description

Returns an array of Solid objects for the solids within a box. Please note this function provides a list of all solids that could potentially be in the box (using computationally cheap bounding box comparison) it is not a rigorous test of whether the solid is actually in the box. This may include solids that are ostensibly outside box. The user should apply their own test. (this function is intended to provide an upper bound of elems to test) Setting the "excl" flag will require that the solid is fully contained but this may not capture all the solids you want to process.

Returns

Array of Solid objects

Return type

Array

Example

To get an array of Solid objects for flagged solids within defined box (inclusive selection)

var s = Solid.FindSolidInBox(m, xmin, xmax, ymin, ymax, zmin, zmax, flag, 0, 0);

FindSolidInit(Model[Model], flag (optional)[Flag]) [static]  [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

Initialize setup so that all flagged solids in model can be tested to see if they are within box. In v20.0 this function is obsolete and the flagging bit (if required) should be specified in Solid.FindSolidInBox()

Returns

No return value

Example

To initialize find setup for flagged solids in model m:

Solid.FindSolidInit(m, flag);

First(Model[Model]) [static]

Description

Returns the first solid in the model.

Returns

Solid object (or null if there are no solids in the model).

Return type

Solid

Example

To get the first solid in model m:

var s = Solid.First(m);

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

Description

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

Returns

Solid label.

Return type

Number

Example

To get the first free solid label in model m:

var label = Solid.FirstFreeLabel(m);

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

Description

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

Returns

No return value

Example

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

Solid.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the solid is flagged or not.

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if solid s has flag f set on it:

if (s.Flagged(f) ) do_something...

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

Description

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

Returns

No return value

Example

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

Solid.ForEach(m, test);
function test(s)
{
// s is Solid object
}

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

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

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

Description

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

Returns

Array of Solid objects or properties

Return type

Array

Example

To make an array of Solid objects for all of the solids in model m:

var a = Solid.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a solid.

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 solid s:

var comm_array = s.GetComments();

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

Description

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

Returns

Array of Solid objects or properties

Return type

Array

Example

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

var s = Solid.GetFlagged(m, f);

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

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

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

Description

Returns the Solid object for a solid ID.

Returns

Solid object (or null if solid does not exist).

Return type

Solid

Example

To get the Solid object for solid 100 in model m

var s = Solid.GetFromID(m, 100);

GetParameter(prop[string])

Description

Checks if a Solid 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 Solid.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 Solid property s.example is a parameter:

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

To check if Solid property s.example is a parameter by using the GetParameter method:

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

Jacobian()

Description

Calculates the jacobian for the solid

Returns

real

Return type

Number

Example

To calculate the jacobian for solid s:

var jacobian = s.Jacobian();

Keyword()

Description

Returns the keyword for this solid (*SOLID, *SOLID_SCALAR or *SOLID_SCALAR_VALUE). Note that a carriage return is not added. See also Solid.KeywordCards()

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for solid s:

var key = s.Keyword();

KeywordCards()

Description

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

Returns

string containing the cards.

Return type

String

Example

To get the cards for solid s:

var cards = s.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last solid in the model.

Returns

Solid object (or null if there are no solids in the model).

Return type

Solid

Example

To get the last solid in model m:

var s = Solid.Last(m);

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

Description

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

Returns

Solid label.

Return type

Number

Example

To get the last free solid label in model m:

var label = Solid.LastFreeLabel(m);

Next()

Description

Returns the next solid in the model.

Returns

Solid object (or null if there are no more solids in the model).

Return type

Solid

Example

To get the solid in model m after solid s:

var s = s.Next();

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

Description

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

Returns

Solid label.

Return type

Number

Example

To get the next free solid label in model m:

var label = Solid.NextFreeLabel(m);

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

Description

Allows the user to pick a solid.

Returns

Solid object (or null if not picked)

Return type

Solid

Example

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

var s = Solid.Pick('Pick solid from screen', m);

Previous()

Description

Returns the previous solid in the model.

Returns

Solid object (or null if there are no more solids in the model).

Return type

Solid

Example

To get the solid in model m before solid s:

var s = s.Previous();

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

Description

Renumbers all of the solids in the model.

Returns

No return value

Example

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

Solid.RenumberAll(m, 1000000);

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

Description

Renumbers all of the flagged solids in the model.

Returns

No return value

Example

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

Solid.RenumberFlagged(m, f, 1000000);

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

Description

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

Returns

Number of solids selected or null if menu cancelled

Return type

Number

Example

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

Solid.Select(f, 'Select solids', m);

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

Solid.Select(f, 'Select solids', l);

SetFlag(flag[Flag])

Description

Sets a flag on the solid.

Returns

No return value

Example

To set flag f for solid s:

s.SetFlag(f);

Sketch(redraw (optional)[boolean])

Description

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

Returns

No return value

Example

To sketch solid s:

s.Sketch();

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

Description

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

Returns

No return value

Example

To sketch all solids flagged with flag in model m:

Solid.SketchFlagged(m, flag);

TetCollapse()

Description

Calculates the tetrahedral collapse for the solid

Returns

real

Return type

Number

Example

To calculate the tet collapse for solid s:

var tet collapse = s.TetCollapse();

TiedNodeCheck(Contact label[integer], Flag[Flag], Option1[integer], Option2[integer])

Description

Checks if nodes of solid are tied by contact or directly attached (non-zero option1).

Returns

string

Return type

String

Example

To check if all nodes of solid h are tied by contact 200 or attach directly to constraint or shell:

var message = h.TiedNodeCheck(200, flag, 1|4, 1)

Timestep()

Description

Calculates the timestep for the solid

Returns

real

Return type

Number

Example

To calculate the timestep for solid s:

var timestep = s.Timestep();

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

Description

Returns the total number of solids in the model.

Returns

number of solids

Return type

Number

Example

To get the total number of solids in model m:

var total = Solid.Total(m);

Unblank()

Description

Unblanks the solid

Returns

No return value

Example

To unblank solid s:

s.Unblank();

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

Description

Unblanks all of the solids in the model.

Returns

No return value

Example

To unblank all of the solids in model m:

Solid.UnblankAll(m);

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

Description

Unblanks all of the flagged solids in the model.

Returns

No return value

Example

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

Solid.UnblankFlagged(m, f);

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

Description

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

Returns

No return value

Example

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

Solid.UnflagAll(m, f);

Unsketch(redraw (optional)[boolean])

Description

Unsketches the solid.

Returns

No return value

Example

To unsketch solid s:

s.Unsketch();

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

Description

Unsketches all solids.

Returns

No return value

Example

To unsketch all solids in model m:

Solid.UnsketchAll(m);

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

Description

Unsketches all flagged solids in the model.

Returns

No return value

Example

To unsketch all solids flagged with flag in model m:

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

Solid object.

Return type

Solid

Example

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

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

Volume()

Description

Calculates the volume for the solid

Returns

real

Return type

Number

Example

To calculate the volume for solid s:

var volume = s.Volume();

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

Description

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

Returns

No return value

Example

To add a warning message "My custom warning" for solid s:

s.Warning("My custom warning");

Warpage()

Description

Calculates the warpage for the solid

Returns

real

Return type

Number

Example

To calculate the warpage for solid s:

var warpage = s.Warpage();

Xrefs()

Description

Returns the cross references for this solid.

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for solid s:

var xrefs = s.Xrefs();

toString()

Description

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

Returns

string

Return type

String

Example

To get data for solid s in keyword format

var str = s.toString();