Tshell class

The Tshell class gives you access to thick shell 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:

Class functions

Member functions

Tshell properties

Name Type Description
beta logical If BETA option is set.
beta_angle real Angle for BETA option.
colour Colour The colour of the thick shell
composite logical If COMPOSITE option is set. Can be true or false
eid integer Tshell number. Also see the label property which is an alternative name for this.
exists (read only) logical true if thick shell exists, false if referred to but not defined.
include integer The Include file number that the thick shell is in.
label integer Tshell number. Also see the eid property which is an alternative name for this.
model (read only) integer The Model number that the thick shell is in.
n1 integer Node number 1
n2 integer Node number 2
n3 integer Node number 3
n4 integer Node number 4
n5 integer Node number 5
n6 integer Node number 6
n7 integer Node number 7
n8 integer Node number 8
nip logical Number of integration points for composite thick shell
nodes (read only) integer Number of nodes thick shell has
pid integer Part number
transparency integer The transparency of the thick shell (0-100) 0% is opaque, 100% is transparent.

Detailed Description

The Tshell class allows you to create, modify, edit and manipulate thich shell cards. See the documentation below for more details.

Constructor

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

Description

Create a new Tshell object. Use either 6 or 8 nodes when creating a new thick shell.

Arguments

  • Model (Model)

    Model that thick shell will be created in

  • eid (integer)

    Tshell number

  • pid (integer)

    Part number

  • n1 (integer)

    Node number 1

  • n2 (integer)

    Node number 2

  • n3 (integer)

    Node number 3

  • n4 (integer)

    Node number 4

  • n5 (integer)

    Node number 5

  • n6 (integer)

    Node number 6

  • n7 (optional) (integer)

    Node number 7

  • n8 (optional) (integer)

    Node number 8

    Returns

    Tshell object

    Return type

    Tshell

    Example

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

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

    Details of functions

    AspectRatio()

    Description

    Calculates the aspect ratio for the thick shell

    Arguments

    No arguments

    Returns

    real

    Return type

    Number

    Example

    To calculate the aspect ratio for thick shell t: 

    var ratio = t.AspectRatio();

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a thick shell.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the thick shell

    Returns

    No return value

    Example

    To associate comment c to the thick shell t: 

    t.AssociateComment(c);

    Blank()

    Description

    Blanks the thick shell

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank thick shell t: 

    t.Blank();

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

    Description

    Blanks all of the thick shells in the model.

    Arguments

  • Model (Model)

    Model that all thick shells will be blanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To blank all of the thick shells in model m: 

    Tshell.BlankAll(m);

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

    Description

    Blanks all of the flagged thick shells in the model.

    Arguments

  • Model (Model)

    Model that all the flagged thick shells will be blanked in

  • flag (Flag)

    Flag set on the thick shells that you want to blank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

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

    Tshell.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the thick shell is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if thick shell t is blanked: 

    if (t.Blanked() ) do_something...

    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 thick shell t: 

    t.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the thick shell.

    Arguments

  • flag (Flag)

    Flag to clear on the thick shell

    Returns

    No return value

    Example

    To clear flag f for thick shell t: 

    t.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the thick shell. The target include of the copied thick shell 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

    Tshell object

    Return type

    Tshell

    Example

    To copy thick shell t into thick shell z: 

    var z = t.Copy();

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

    Description

    Starts an interactive editing panel to create a thick shell

    Arguments

  • Model (Model)

    Model that the thick shell 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

    Tshell object (or null if not made).

    Return type

    Tshell

    Example

    To start creating a thick shell in model m: 

    var t = Tshell.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a thick shell.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the thick shell

    Returns

    No return value

    Example

    To detach comment c from the thick shell t: 

    t.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 thick shell t: 

    t.Edit();

    ElemCut(Database cross section label[integer])

    Description

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

    Arguments

  • Database cross section label (integer)

    The label of the database cross section.

    Returns

    Object with the following properties:

    Name Type Description
    face1 Array of reals An array containing the x1,y1,z1,x2,y2,z2 coordinates of the cut line on the face 1. Null if no cut on this face.
    face2 Array of reals An array containing the x1,y1,z1,x2,y2,z2 coordinates of the cut line on the face 2. Null if no cut on this face.
    face3 Array of reals An array containing the x1,y1,z1,x2,y2,z2 coordinates of the cut line on the face 3. Null if no cut on this face.
    face4 Array of reals An array containing the x1,y1,z1,x2,y2,z2 coordinates of the cut line on the face 4. Null if no cut on this face.
    face5 Array of reals An array containing the x1,y1,z1,x2,y2,z2 coordinates of the cut line on the face 5. Null if no cut on this face.
    face6 Array of reals An array containing the x1,y1,z1,x2,y2,z2 coordinates of the cut line on the face 6. Null if no cut on this face.

    Return type

    object

    Example

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

    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 thick shell. 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 thick shell t: 

    t.Error("My custom error");

    ExtractColour()

    Description

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

    Arguments

    No arguments

    Returns

    colour value (integer)

    Return type

    Number

    Example

    To return the colour used for drawing thick shell t: 

    var colour = t.ExtractColour();

    FindTshellInBox(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 Tshell objects for the thick shells within a box. Please note this function provides a list of all thick shells that could potentially be in the box (using computationally cheap bounding box comparison) it is not a rigorous test of whether the thick shellis actually in the box. This may include tshells 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 tshell is fully contained. but this may not capture all the tshells you want to process.

    Arguments

  • Model (Model)

    Model designated model

  • xmin (real)

    Minimum bound in global x

  • xmax (real)

    Maximum bound in global x

  • ymin (real)

    Minimum bound in global y

  • ymax (real)

    Maximum bound in global y

  • zmin (real)

    Minimum bound in global z

  • zmax (real)

    Maximum bound in global z

  • flag (optional) (integer)

    Optional flag to restrict thick shells considered, if 0 all tshells considered

  • excl (optional) (integer)

    Optional flag ( 0) Apply inclusive selection ( 1) Apply exclusive selection inclusive selection means elements intersect box exclusive selection means elements contained in box

  • vis_only (optional) (integer)

    Optional flag to consider visible elements only (1), if (0) all elements considered

    Returns

    Array of Tshell objects

    Return type

    Array

    Example

    To get an array of Tshell objects for flagged thick shells within defined box (inclusive selection) 

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

    First(Model[Model]) [static]

    Description

    Returns the first thick shell in the model.

    Arguments

  • Model (Model)

    Model to get first thick shell in

    Returns

    Tshell object (or null if there are no thick shells in the model).

    Return type

    Tshell

    Example

    To get the first thick shell in model m: 

    var t = Tshell.First(m);

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

    Description

    Returns the first free thick shell label in the model. Also see Tshell.LastFreeLabel(), Tshell.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

    Model to get first free thick shell label in

  • layer (optional) (Include number)

    Include file (0 for the main file) to search for labels in (Equivalent to First free in layer in editing panels). If omitted the whole model will be used (Equivalent to First free in editing panels).

    Returns

    Tshell label.

    Return type

    Number

    Example

    To get the first free thick shell label in model m: 

    var label = Tshell.FirstFreeLabel(m);

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

    Description

    Flags all of the thick shells in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all thick shells will be flagged in

  • flag (Flag)

    Flag to set on the thick shells

    Returns

    No return value

    Example

    To flag all of the thick shells with flag f in model m: 

    Tshell.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the thick shell is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the thick shell

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if thick shell t has flag f set on it: 

    if (t.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all thick shells are in

  • func (function)

    Function to call for each thick shell

  • 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 thick shells in model m: 

    Tshell.ForEach(m, test);
function test(t)
{
// t is Tshell object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get thick shells from

  • property (optional) (string)

    Name for property to get for all thick shells in the model

    Returns

    Array of Tshell objects or properties

    Return type

    Array

    Example

    To make an array of Tshell objects for all of the thick shells in model m: 

    var a = Tshell.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a thick shell.

    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 thick shell t: 

    var comm_array = t.GetComments();

    GetCompositeData(ipt[integer])

    Description

    Returns the composite data for an integration point in *ELEMENT_TSHELL_COMPOSITE.

    Arguments

  • ipt (integer)

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

    Returns

    An array of numbers containing the material id, thickness and beta angle.

    Return type

    Number

    Example

    To get the composite data for the 3rd integration point for thick shell t: 

    if (t.composite && s.nip >= 3)
{
    var ipt_data = t.GetCompositeData(2);
}

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

    Description

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

    Arguments

  • Model (Model)

    Model to get thick shells from

  • flag (Flag)

    Flag set on the thick shells that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged thick shells in the model

    Returns

    Array of Tshell objects or properties

    Return type

    Array

    Example

    To make an array of Tshell objects for all of the thick shells in model m flagged with f: 

    var t = Tshell.GetFlagged(m, f);

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

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

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

    Description

    Returns the Tshell object for a thick shell ID.

    Arguments

  • Model (Model)

    Model to find the thick shell in

  • number (integer)

    number of the thick shell you want the Tshell object for

    Returns

    Tshell object (or null if thick shell does not exist).

    Return type

    Tshell

    Example

    To get the Tshell object for thick shell 100 in model m 

    var t = Tshell.GetFromID(m, 100);

    GetNodeIDs()

    Description

    Returns the labels of the nodes on the thick shell as an array. See also Tshell.GetNodes()

    Arguments

    No arguments

    Returns

    Array of node labels (integers)

    Return type

    Number

    Example

    To return the node labels of thick shell t as an array 

    var nodes = t.GetNodeIDs();

    GetNodes()

    Description

    Returns the nodes on the thick shell as an array of Node objects. See also Tshell.GetNodeIDs()

    Arguments

    No arguments

    Returns

    Array of Node objects

    Return type

    Array

    Example

    To return the nodes of thick shell t as an array 

    var nodes = t.GetNodes();

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    thick shell property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if Tshell property t.example is a parameter: 

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

    To check if Tshell property t.example is a parameter by using the GetParameter method: 

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

    Jacobian()

    Description

    Calculates the jacobian for the thick shell

    Arguments

    No arguments

    Returns

    real

    Return type

    Number

    Example

    To calculate the jacobian for thick shell t: 

    var jacobian = s.Jacobian();

    Keyword()

    Description

    Returns the keyword for this thick shell (*ELEMENT_TSHELL or *ELEMENT_TSHELL_COMPOSITE). Note that a carriage return is not added. See also Tshell.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for thick shell t: 

    var key = t.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for thick shell t: 

    var cards = t.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last thick shell in the model.

    Arguments

  • Model (Model)

    Model to get last thick shell in

    Returns

    Tshell object (or null if there are no thick shells in the model).

    Return type

    Tshell

    Example

    To get the last thick shell in model m: 

    var t = Tshell.Last(m);

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

    Description

    Returns the last free thick shell label in the model. Also see Tshell.FirstFreeLabel(), Tshell.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get last free thick shell label in

  • layer (optional) (Include number)

    Include file (0 for the main file) to search for labels in (Equivalent to Highest free in layer in editing panels). If omitted the whole model will be used.

    Returns

    Tshell label.

    Return type

    Number

    Example

    To get the last free thick shell label in model m: 

    var label = Tshell.LastFreeLabel(m);

    Next()

    Description

    Returns the next thick shell in the model.

    Arguments

    No arguments

    Returns

    Tshell object (or null if there are no more thick shells in the model).

    Return type

    Tshell

    Example

    To get the thick shell in model m after thick shell t: 

    var t = t.Next();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get next free thick shell label in

  • layer (optional) (Include number)

    Include file (0 for the main file) to search for labels in (Equivalent to Highest+1 in layer in editing panels). If omitted the whole model will be used (Equivalent to Highest+1 in editing panels).

    Returns

    Tshell label.

    Return type

    Number

    Example

    To get the next free thick shell label in model m: 

    var label = Tshell.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 thick shell.

    Arguments

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

    If the argument is a Model then only thick shells from that model can be picked. If the argument is a Flag then only thick shells that are flagged with limit can be selected. If omitted, or null, any thick shells from any model can be selected. from any model.

  • modal (optional) (boolean)

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

  • button text (optional) (string)

    By default the window with the prompt will have a button labelled 'Cancel' which if pressed will cancel the pick and return null. If you want to change the text on the button use this argument. If omitted 'Cancel' will be used.

    Returns

    Tshell object (or null if not picked)

    Return type

    Tshell

    Example

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

    var t = Tshell.Pick('Pick thick shell from screen', m);

    Previous()

    Description

    Returns the previous thick shell in the model.

    Arguments

    No arguments

    Returns

    Tshell object (or null if there are no more thick shells in the model).

    Return type

    Tshell

    Example

    To get the thick shell in model m before thick shell t: 

    var t = t.Previous();

    RemoveCompositeData(ipt[integer])

    Description

    Removes the composite data for an integration point in *ELEMENT_TSHELL_COMPOSITE.

    Arguments

  • ipt (integer)

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

    Returns

    No return value.

    Example

    To remove the composite data for the 3rd integration point for thick shell t: 

    t.RemoveCompositeData(2);

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

    Description

    Renumbers all of the thick shells in the model.

    Arguments

  • Model (Model)

    Model that all thick shells will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Tshell.RenumberAll(m, 1000000);

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

    Description

    Renumbers all of the flagged thick shells in the model.

    Arguments

  • Model (Model)

    Model that all the flagged thick shells will be renumbered in

  • flag (Flag)

    Flag set on the thick shells that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

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

    Tshell.RenumberFlagged(m, f, 1000000);

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

    Description

    Allows the user to select thick shells using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting thick shells

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

    If the argument is a Model then only thick shells from that model can be selected. If the argument is a Flag then only thick shells that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any thick shells 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 thick shells selected or null if menu cancelled

    Return type

    Number

    Example

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

    Tshell.Select(f, 'Select thick shells', m);

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

    Tshell.Select(f, 'Select thick shells', l);

    SetCompositeData(ipt[integer], mid[integer], thick[real], beta[real])

    Description

    Sets the composite data for an integration point in *ELEMENT_TSHELL_COMPOSITE.

    Arguments

  • ipt (integer)

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

  • mid (integer)

    Material ID for the integration point.

  • thick (real)

    Thickness of the integration point.

  • beta (real)

    Material angle of the integration point.

    Returns

    No return value.

    Example

    To set the composite data for the 3rd integration point to mat 1, thickness 0.5 and angle 45, for thick shell t: 

    t.SetCompositeData(2, 1, 0.5, 45);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the thick shell.

    Arguments

  • flag (Flag)

    Flag to set on the thick shell

    Returns

    No return value

    Example

    To set flag f for thick shell t: 

    t.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the thick shell is sketched. If omitted redraw is true. If you want to sketch several thick shells and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To sketch thick shell t: 

    t.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged thick shells will be sketched in

  • flag (Flag)

    Flag set on the thick shells that you want to sketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the thick shells are sketched. If omitted redraw is true. If you want to sketch flagged thick shells several times and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To sketch all thick shells flagged with flag in model m: 

    Tshell.SketchFlagged(m, flag);

    Timestep()

    Description

    Calculates the timestep for the thick shell

    Arguments

    No arguments

    Returns

    real

    Return type

    Number

    Example

    To calculate the timestep for thick shell t: 

    var timestep = t.Timestep();

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

    Description

    Returns the total number of thick shells in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of thick shells

    Return type

    Number

    Example

    To get the total number of thick shells in model m: 

    var total = Tshell.Total(m);

    Unblank()

    Description

    Unblanks the thick shell

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank thick shell t: 

    t.Unblank();

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

    Description

    Unblanks all of the thick shells in the model.

    Arguments

  • Model (Model)

    Model that all thick shells will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To unblank all of the thick shells in model m: 

    Tshell.UnblankAll(m);

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

    Description

    Unblanks all of the flagged thick shells in the model.

    Arguments

  • Model (Model)

    Model that the flagged thick shells will be unblanked in

  • flag (Flag)

    Flag set on the thick shells that you want to unblank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

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

    Tshell.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the thick shells in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all thick shells will be unset in

  • flag (Flag)

    Flag to unset on the thick shells

    Returns

    No return value

    Example

    To unset the flag f on all the thick shells in model m: 

    Tshell.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the thick shell.

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the thick shell is unsketched. If omitted redraw is true. If you want to unsketch several thick shells and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch thick shell t: 

    t.Unsketch();

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

    Description

    Unsketches all thick shells.

    Arguments

  • Model (Model)

    Model that all thick shells will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not after the thick shells are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch all thick shells in model m: 

    Tshell.UnsketchAll(m);

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

    Description

    Unsketches all flagged thick shells in the model.

    Arguments

  • Model (Model)

    Model that all thick shells will be unsketched in

  • flag (Flag)

    Flag set on the thick shells that you want to unsketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the thick shells are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch all thick shells flagged with flag in model m: 

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

    Arguments

    No arguments

    Returns

    Tshell object.

    Return type

    Tshell

    Example

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

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

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

    Description

    Adds a warning for thick shell. 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 thick shell t: 

    t.Warning("My custom warning");

    Warpage()

    Description

    Calculates the warpage for the thick shell

    Arguments

    No arguments

    Returns

    real

    Return type

    Number

    Example

    To calculate the warpage for thick shell t: 

    var warpage = s.Warpage();

    Xrefs()

    Description

    Returns the cross references for this thick shell.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for thick shell t: 

    var xrefs = t.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for thick shell t in keyword format 

    var str = t.toString();