StressSolid class

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

StressSolid constants

Name Description
StressSolid.SET Initial is *INITIAL_STRESS_SOLID_SET.
StressSolid.SOLID Initial is *INITIAL_STRESS_SOLID.

StressSolid properties

Name Type Description
eid integer Solid Element ID or solid set ID
exists (read only) logical true if initial stress solid exists, false if referred to but not defined.
ialegp integer *ALE_MULTI-MATERIAL_GROUP or *ALE_STRUCTURED_MULTI-MATERIAL_GROUP id.
include integer The Include file number that the initial stress solid is in.
iveflg integer Initial volume energy flag (only used if large is TRUE). Valid values are 0, 1 and 2 only.
large logical true if large format, false otherwise.
model (read only) integer The Model number that the initial stress solid is in.
nhisv integer Number of additional history variables (only used if large is TRUE).
nint integer Number of integration points (should correspond to the solid element formulation). Valid values for hexadral solid elements are 1, 8 or 14. Valid values for tetrahedral elements are 1, 4 or 5. Valid values for pentraderal elements are 1 or 2.
nthhsv integer Number of thermal history variables per thermal integration point (only used if large is TRUE).
nthint integer Number of thermal integration points (only used if large is TRUE).
type constant The Intial stress solid type. Can be StressSolid.SOLID or StressSolid.SET.

Detailed Description

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

Constructor

new StressSolid(Model[Model], type[constant], eid[integer], nint[integer], nhisv[integer], large[boolean], iveflg[integer])

Description

Create a new StressSolid object.

Arguments

  • Model (Model)

    Model that stress_solid will be created in

  • type (constant)

    Specify the type of initial stress solid (Can be StressSolid.SOLID or StressSolid.SET)

  • eid (integer)

    Solid Element ID or solid set ID

  • nint (integer)

    Number of integration points (should correspond to the solid element formulation). Valid values for hexadral solid elements are 1, 8 or 14. Valid values for tetrahedral elements are 1, 4 or 5. Valid values for pentraderal elements are 1 or 2.

  • nhisv (integer)

    Number of additional history variables (only used if large is TRUE).

  • large (boolean)

    true if large format, false otherwise.

  • iveflg (integer)

    Initial volume energy flag (only used if large is TRUE). Valid values are 0, 1 and 2 only.

    Returns

    StressSolid object

    Return type

    StressSolid

    Example

    To create a new stress_solid in model m, of type SET with SOLID_SET id as 1, number of integration points as 3 and number of history variables as 4. 

    var s = new StressSolid(m, StressSolid.SET, 1, 3, 4, true);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a initial stress solid.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the initial stress solid

    Returns

    No return value

    Example

    To associate comment c to the initial stress solid iso: 

    iso.AssociateComment(c);

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the initial stress solid.

    Arguments

  • flag (Flag)

    Flag to clear on the initial stress solid

    Returns

    No return value

    Example

    To clear flag f for initial stress solid iso: 

    iso.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    StressSolid object

    Return type

    StressSolid

    Example

    To copy initial stress solid iso into initial stress solid z: 

    var z = iso.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a initial stress solid.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the initial stress solid

    Returns

    No return value

    Example

    To detach comment c from the initial stress solid iso: 

    iso.DetachComment(c);

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

    Description

    Adds an error for initial stress solid. 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 solid iso: 

    iso.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first initial stress solid in the model.

    Arguments

  • Model (Model)

    Model to get first initial stress solid in

    Returns

    StressSolid object (or null if there are no initial stress solids in the model).

    Return type

    StressSolid

    Example

    To get the first initial stress solid in model m: 

    var iso = StressSolid.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all initial stress solids will be flagged in

  • flag (Flag)

    Flag to set on the initial stress solids

    Returns

    No return value

    Example

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

    StressSolid.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the initial stress solid is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the initial stress solid

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if initial stress solid iso has flag f set on it: 

    if (iso.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all initial stress solids are in

  • func (function)

    Function to call for each initial stress solid

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

    StressSolid.ForEach(m, test);
function test(iso)
{
// iso is StressSolid object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get initial stress solids from

  • property (optional) (string)

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

    Returns

    Array of StressSolid objects or properties

    Return type

    Array

    Example

    To make an array of StressSolid objects for all of the initial stress solids in model m: 

    var a = StressSolid.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a initial stress solid.

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

    var comm_array = iso.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get initial stress solids from

  • flag (Flag)

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

  • property (optional) (string)

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

    Returns

    Array of StressSolid objects or properties

    Return type

    Array

    Example

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

    var iso = StressSolid.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 solids in model m flagged with f: 

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

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

    Description

    Returns the StressSolid object for a initial stress solid ID.

    Arguments

  • Model (Model)

    Model to find the initial stress solid in

  • number (integer)

    number of the initial stress solid you want the StressSolid object for

    Returns

    StressSolid object (or null if initial stress solid does not exist).

    Return type

    StressSolid

    Example

    To get the StressSolid object for initial stress solid 100 in model m 

    var iso = StressSolid.GetFromID(m, 100);

    GetIntegrationPoint(index[integer])

    Description

    Returns the data for a specific integration point as an array. For each integration point there will be 7 values if large is FALSE. For each integration point there will be (7 + nhisv) values if large is TRUE. There are nint 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 solid iso: 

    var data = iso.GetIntegrationPoint(2);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    initial stress solid property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if StressSolid property iso.example is a parameter: 

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

    To check if StressSolid property iso.example is a parameter by using the GetParameter method: 

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

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

    var data = iso.GetThermalIntegrationPoint(2);

    Keyword()

    Description

    Returns the keyword for this initial stress solid (*INITIAL_STRESS_SOLID). Note that a carriage return is not added. See also StressSolid.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for stress_solid i: 

    var key = i.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for stress_solid i: 

    var cards = i.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last initial stress solid in the model.

    Arguments

  • Model (Model)

    Model to get last initial stress solid in

    Returns

    StressSolid object (or null if there are no initial stress solids in the model).

    Return type

    StressSolid

    Example

    To get the last initial stress solid in model m: 

    var iso = StressSolid.Last(m);

    Next()

    Description

    Returns the next initial stress solid in the model.

    Arguments

    No arguments

    Returns

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

    Return type

    StressSolid

    Example

    To get the initial stress solid in model m after initial stress solid iso: 

    var iso = iso.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 solid.

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

    StressSolid object (or null if not picked)

    Return type

    StressSolid

    Example

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

    var iso = StressSolid.Pick('Pick initial stress solid from screen', m);

    Previous()

    Description

    Returns the previous initial stress solid in the model.

    Arguments

    No arguments

    Returns

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

    Return type

    StressSolid

    Example

    To get the initial stress solid in model m before initial stress solid iso: 

    var iso = iso.Previous();

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting initial stress solids

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

    Return type

    Number

    Example

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

    StressSolid.Select(f, 'Select initial stress solids', m);

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

    StressSolid.Select(f, 'Select initial stress solids', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the initial stress solid.

    Arguments

  • flag (Flag)

    Flag to set on the initial stress solid

    Returns

    No return value

    Example

    To set flag f for initial stress solid iso: 

    iso.SetFlag(f);

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

    Description

    Set the data for a specific integration point. For each integration point there will be 7 values if large is FALSE. For each integration point there will be (7 + nhisv) values if large is TRUE. There are nint 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 7 if large is FALSE. The array length should be (7 + nhisv) if large is TRUE.

    Returns

    No return value.

    Example

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

    iso.SetIntegrationPoint(2, adata);

    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 solid iso to the values in array adata: 

    iso.SetThermalIntegrationPoint(2, adata);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the initial stress solid is sketched. If omitted redraw is true. If you want to sketch several initial stress solids 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 solid iso: 

    iso.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

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

  • redraw (optional) (boolean)

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

    StressSolid.SketchFlagged(m, flag);

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

    Description

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

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of initial stress solids

    Return type

    Number

    Example

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

    var total = StressSolid.Total(m);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the initial stress solids

    Returns

    No return value

    Example

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

    StressSolid.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the initial stress solid.

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the initial stress solid is unsketched. If omitted redraw is true. If you want to unsketch several initial stress solids 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 solid iso: 

    iso.Unsketch();

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

    Description

    Unsketches all initial stress solids.

    Arguments

  • Model (Model)

    Model that all initial stress solids will be unblanked in

  • redraw (optional) (boolean)

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

    StressSolid.UnsketchAll(m);

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

    Description

    Unsketches all flagged initial stress solids in the model.

    Arguments

  • Model (Model)

    Model that all initial stress solids will be unsketched in

  • flag (Flag)

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

  • redraw (optional) (boolean)

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

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

    StressSolid object.

    Return type

    StressSolid

    Example

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

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

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

    Description

    Adds a warning for initial stress solid. 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 solid iso: 

    iso.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this initial stress solid.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for initial stress solid iso: 

    var xrefs = iso.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for stress_solid i in keyword format 

    var s = i.toString();