StressShell class

The StressShell class gives you access to define initial stress 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

StressShell constants

Name Description
StressShell.SET Initial is *INITIAL_STRESS_SHELL_SET.
StressShell.SHELL Initial is *INITIAL_STRESS_SHELL.

StressShell properties

Name Type Description
eid integer Shell Element ID or shell set ID
exists (read only) logical true if initial stress shell exists, false if referred to but not defined.
include integer The Include file number that the initial stress shell is in.
large logical true if large format, false otherwise
model (read only) integer The Model number that the initial stress shell is in.
nhisv integer Number of additional history variables
nplane integer Number of in plane integration points being output
ntensr integer Number of components of tensor data taken from the element history variables stored
nthhsv integer Number of thermal history variables per thermal integration point
nthick integer Number of integration points through the thickness
nthint integer Number of thermal integration points
type constant The Intial stress shell type. Can be StressShell.SHELL or StressShell.SET.

Detailed Description

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

Constructor

new StressShell(Model[Model], type[constant], eid[integer], nplane[integer], nthick[integer], nhisv[integer], ntensr[integer])

Description

Create a new StressShell object.

Arguments

  • Model (Model)

    Model that stress_shell will be created in

  • type (constant)

    Specify the type of initial stress shell (Can be StressShell.SHELL or StressShell.SET)

  • eid (integer)

    Shell Element ID or shell set ID

  • nplane (integer)

    Number of in plane integration points being output

  • nthick (integer)

    Number of integration points through the thickness

  • nhisv (integer)

    Number of additional history variables

  • ntensr (integer)

    Number of components of tensor data taken from the element history variables stored

    Returns

    StressShell object

    Return type

    StressShell

    Example

    To create a new stress_shell in model m, of type SET 

    var s = new StressShell(m, StressShell.SET, 1, 3, 0, 0);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a initial stress shell.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the initial stress shell

    Returns

    No return value

    Example

    To associate comment c to the initial stress shell iss: 

    iss.AssociateComment(c);

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the initial stress shell.

    Arguments

  • flag (Flag)

    Flag to clear on the initial stress shell

    Returns

    No return value

    Example

    To clear flag f for initial stress shell iss: 

    iss.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    StressShell object

    Return type

    StressShell

    Example

    To copy initial stress shell iss into initial stress shell z: 

    var z = iss.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a initial stress shell.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the initial stress shell

    Returns

    No return value

    Example

    To detach comment c from the initial stress shell iss: 

    iss.DetachComment(c);

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

    Description

    Adds an error for initial stress 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 initial stress shell iss: 

    iss.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first initial stress shell in the model.

    Arguments

  • Model (Model)

    Model to get first initial stress shell in

    Returns

    StressShell object (or null if there are no initial stress shells in the model).

    Return type

    StressShell

    Example

    To get the first initial stress shell in model m: 

    var iss = StressShell.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all initial stress shells will be flagged in

  • flag (Flag)

    Flag to set on the initial stress shells

    Returns

    No return value

    Example

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

    StressShell.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the initial stress shell is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the initial stress shell

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if initial stress shell iss has flag f set on it: 

    if (iss.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all initial stress shells are in

  • func (function)

    Function to call for each initial stress 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 initial stress shells in model m: 

    StressShell.ForEach(m, test);
function test(iss)
{
// iss is StressShell object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get initial stress shells from

  • property (optional) (string)

    Name for property to get for all initial stress shells in the model

    Returns

    Array of StressShell objects or properties

    Return type

    Array

    Example

    To make an array of StressShell objects for all of the initial stress shells in model m: 

    var a = StressShell.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a initial stress 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 initial stress shell iss: 

    var comm_array = iss.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get initial stress shells from

  • flag (Flag)

    Flag set on the initial stress shells that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged initial stress shells in the model

    Returns

    Array of StressShell objects or properties

    Return type

    Array

    Example

    To make an array of StressShell objects for all of the initial stress shells in model m flagged with f: 

    var iss = StressShell.GetFlagged(m, f);

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

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

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

    Description

    Returns the StressShell object for a initial stress shell ID.

    Arguments

  • Model (Model)

    Model to find the initial stress shell in

  • number (integer)

    number of the initial stress shell you want the StressShell object for

    Returns

    StressShell object (or null if initial stress shell does not exist).

    Return type

    StressShell

    Example

    To get the StressShell object for initial stress shell 100 in model m 

    var iss = StressShell.GetFromID(m, 100);

    GetHisvData()   [deprecated]

    This function is deprecated in version 11.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

    Description

    Please use StressShell.GetIntegrationPoint() instead.

    Arguments

    No arguments

    Returns

    No return value

    GetIntegrationPoint(index[integer])

    Description

    Returns the data for a specific integration point as an array. For each integration point there will be 8 + nhisv + (6 x ntensr) values. There are nplane x nthick integration points.

    Arguments

  • index (integer)

    Index you want the integration point data for. Note that indices start at 0.

    Returns

    An array containing the integration point data.

    Return type

    Array

    Example

    To get the data for the 3rd integration point for initial stress shell iss: 

    var data = iss.GetIntegrationPoint(2);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    initial stress shell property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if StressShell property iss.example is a parameter: 

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

    To check if StressShell property iss.example is a parameter by using the GetParameter method: 

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

    GetStressData()   [deprecated]

    This function is deprecated in version 11.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

    Description

    Please use StressShell.GetIntegrationPoint() instead.

    Arguments

    No arguments

    Returns

    No return value

    GetTensrData()   [deprecated]

    This function is deprecated in version 11.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

    Description

    Please use StressShell.GetIntegrationPoint() instead.

    Arguments

    No arguments

    Returns

    No return value

    GetThermalIntegrationPoint(index[integer])

    Description

    Returns the thermal data for a specific integration point as an array. For each integration point there will be nthhsv values. There are nthint integration points.

    Arguments

  • index (integer)

    Index you want the integration point data for. Note that indices start at 0.

    Returns

    An array containing the integration point data.

    Return type

    Array

    Example

    To get the data for the 3rd thermal integration point for initial stress shell iss: 

    var data = iss.GetThermalIntegrationPoint(2);

    Keyword()

    Description

    Returns the keyword for this initial stress shell (*INITIAL_STRESS_SHELL). Note that a carriage return is not added. See also StressShell.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for stress_shell i: 

    var key = i.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for stress_shell i: 

    var cards = i.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last initial stress shell in the model.

    Arguments

  • Model (Model)

    Model to get last initial stress shell in

    Returns

    StressShell object (or null if there are no initial stress shells in the model).

    Return type

    StressShell

    Example

    To get the last initial stress shell in model m: 

    var iss = StressShell.Last(m);

    Next()

    Description

    Returns the next initial stress shell in the model.

    Arguments

    No arguments

    Returns

    StressShell object (or null if there are no more initial stress shells in the model).

    Return type

    StressShell

    Example

    To get the initial stress shell in model m after initial stress shell iss: 

    var iss = iss.Next();

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

    Description

    Allows the user to pick a initial stress 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 initial stress shells from that model can be picked. If the argument is a Flag then only initial stress shells that are flagged with limit can be selected. If omitted, or null, any initial stress 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

    StressShell object (or null if not picked)

    Return type

    StressShell

    Example

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

    var iss = StressShell.Pick('Pick initial stress shell from screen', m);

    Previous()

    Description

    Returns the previous initial stress shell in the model.

    Arguments

    No arguments

    Returns

    StressShell object (or null if there are no more initial stress shells in the model).

    Return type

    StressShell

    Example

    To get the initial stress shell in model m before initial stress shell iss: 

    var iss = iss.Previous();

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

    Description

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

    Arguments

  • flag (Flag)

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

    Return type

    Number

    Example

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

    StressShell.Select(f, 'Select initial stress shells', m);

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

    StressShell.Select(f, 'Select initial stress shells', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the initial stress shell.

    Arguments

  • flag (Flag)

    Flag to set on the initial stress shell

    Returns

    No return value

    Example

    To set flag f for initial stress shell iss: 

    iss.SetFlag(f);

    SetHisvData()   [deprecated]

    This function is deprecated in version 11.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

    Description

    Please use StressShell.SetIntegrationPoint() instead.

    Arguments

    No arguments

    Returns

    No return value

    SetIntegrationPoint(index[integer], data[Array of data])

    Description

    Set the data for a specific integration point. For each integration point there will be 8 + nhisv + (6 x ntensr) values. There are nplane x nthick integration points.

    Arguments

  • index (integer)

    Index you want the integration point data for. Note that indices start at 0.

  • data (Array of data)

    Array containing the integration point data. The array length should be 8 + nhisv + (6 x ntensr).

    Returns

    No return value.

    Example

    To set the 3rd integration point data for initial stress shell iss to the values in array adata: 

    iss.SetIntegrationPoint(2, adata);

    SetStressData()   [deprecated]

    This function is deprecated in version 11.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

    Description

    Please use StressShell.SetIntegrationPoint() instead.

    Arguments

    No arguments

    Returns

    No return value

    SetTensrData()   [deprecated]

    This function is deprecated in version 11.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

    Description

    Please use StressShell.SetIntegrationPoint() instead.

    Arguments

    No arguments

    Returns

    No return value

    SetThermalIntegrationPoint(index[integer], data[Array of data])

    Description

    Set the thermal data for a specific integration point. For each integration point there will be nthhsv values. There are nthint thermal integration points.

    Arguments

  • index (integer)

    Index you want the thermal integration point data for. Note that indices start at 0.

  • data (Array of data)

    Array containing the thermal integration point data. The array length should be nthhsv.

    Returns

    No return value.

    Example

    To set the 3rd thermal integration point data for initial stress shell iss to the values in array adata: 

    iss.SetThermalIntegrationPoint(2, adata);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch initial stress shell iss: 

    iss.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged initial stress shells will be sketched in

  • flag (Flag)

    Flag set on the initial stress shells that you want to sketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the initial stress shells are sketched. If omitted redraw is true. If you want to sketch flagged initial stress 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 initial stress shells flagged with flag in model m: 

    StressShell.SketchFlagged(m, flag);

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

    Description

    Returns the total number of initial stress shells in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of initial stress shells

    Return type

    Number

    Example

    To get the total number of initial stress shells in model m: 

    var total = StressShell.Total(m);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the initial stress shells

    Returns

    No return value

    Example

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

    StressShell.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the initial stress shell.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch initial stress shell iss: 

    iss.Unsketch();

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

    Description

    Unsketches all initial stress shells.

    Arguments

  • Model (Model)

    Model that all initial stress shells will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not after the initial stress 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 initial stress shells in model m: 

    StressShell.UnsketchAll(m);

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

    Description

    Unsketches all flagged initial stress shells in the model.

    Arguments

  • Model (Model)

    Model that all initial stress shells will be unsketched in

  • flag (Flag)

    Flag set on the initial stress shells that you want to unsketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the initial stress 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 initial stress shells flagged with flag in model m: 

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

    StressShell object.

    Return type

    StressShell

    Example

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

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

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

    Description

    Adds a warning for initial stress 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 initial stress shell iss: 

    iss.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this initial stress shell.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for initial stress shell iss: 

    var xrefs = iss.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for stress_shell i in keyword format 

    var s = i.toString();