StrainSolid class

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

StrainSolid constants

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

StrainSolid properties

Name Type Description
eid integer Solid Element ID or solid set ID
epsxx real Define the xxth strain component in the global cartesian system.
epsxy real Define the xyth strain component in the global cartesian system.
epsyy real Define the yyth strain component in the global cartesian system.
epsyz real Define the yzth strain component in the global cartesian system.
epszx real Define the zxth strain component in the global cartesian system.
epszz real Define the zzth strain component in the global cartesian system.
exists (read only) logical true if initial strain solid exists, false if referred to but not defined.
include integer The Include file number that the initial strain solid is in.
model (read only) integer The Model number that the initial strain solid is in.
type constant The Intial strain solid type. Can be StrainSolid.SOLID or StrainSolid.SET.

Detailed Description

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

Constructor

new StrainSolid(Model[Model], type[constant], eid[integer], epsxx[real], epsyy[real], epszz[real], epsxy[real], epsyz[real], epszx[real])

Description

Create a new StrainSolid object.

Arguments

  • Model (Model)

    Model that strain_solid will be created in

  • type (constant)

    Specify the type of initial strain solid (Can be StrainSolid.SOLID or StrainSolid.SET)

  • eid (integer)

    Solid Element ID or solid set ID

  • epsxx (real)

    The xxth strain component in the global cartesian system.

  • epsyy (real)

    The yyth strain component in the global cartesian system.

  • epszz (real)

    The zzth strain component in the global cartesian system.

  • epsxy (real)

    The xyth strain component in the global cartesian system.

  • epsyz (real)

    The yzth strain component in the global cartesian system.

  • epszx (real)

    The zxth strain component in the global cartesian system.

    Returns

    StrainSolid object

    Return type

    StrainSolid

    Example

    To create a new strain_solid in model m, of type SET with SOLID_SET id as 1, strain components as 10, 20, 30, 40, 50, 60. 

    var s = new StrainSolid(m, StrainSolid.SET, 1, 10, 20, 30, 40, 50, 60);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a initial strain solid.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the initial strain solid

    Returns

    No return value

    Example

    To associate comment c to the initial strain solid iso: 

    iso.AssociateComment(c);

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the initial strain solid.

    Arguments

  • flag (Flag)

    Flag to clear on the initial strain solid

    Returns

    No return value

    Example

    To clear flag f for initial strain solid iso: 

    iso.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    StrainSolid object

    Return type

    StrainSolid

    Example

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

    var z = iso.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a initial strain solid.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the initial strain solid

    Returns

    No return value

    Example

    To detach comment c from the initial strain solid iso: 

    iso.DetachComment(c);

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

    Description

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

    iso.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first initial strain solid in the model.

    Arguments

  • Model (Model)

    Model to get first initial strain solid in

    Returns

    StrainSolid object (or null if there are no initial strain solids in the model).

    Return type

    StrainSolid

    Example

    To get the first initial strain solid in model m: 

    var iso = StrainSolid.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all initial strain solids will be flagged in

  • flag (Flag)

    Flag to set on the initial strain solids

    Returns

    No return value

    Example

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

    StrainSolid.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the initial strain solid is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the initial strain solid

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if initial strain 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 strain solid in the model.
    Note that ForEach has been designed to make looping over initial strain solids as fast as possible and so has some limitations.
    Firstly, a single temporary StrainSolid object is created and on each function call it is updated with the current initial strain solid data. This means that you should not try to store the StrainSolid object for later use (e.g. in an array) as it is temporary.
    Secondly, you cannot create new initial strain solids inside a ForEach loop.

    Arguments

  • Model (Model)

    Model that all initial strain solids are in

  • func (function)

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

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

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get initial strain solids from

  • property (optional) (string)

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

    Returns

    Array of StrainSolid objects or properties

    Return type

    Array

    Example

    To make an array of StrainSolid objects for all of the initial strain solids in model m: 

    var a = StrainSolid.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a initial strain 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 strain solid iso: 

    var comm_array = iso.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get initial strain solids from

  • flag (Flag)

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

  • property (optional) (string)

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

    Returns

    Array of StrainSolid objects or properties

    Return type

    Array

    Example

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

    var iso = StrainSolid.GetFlagged(m, f);

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

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

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

    Description

    Returns the StrainSolid object for a initial strain solid ID.

    Arguments

  • Model (Model)

    Model to find the initial strain solid in

  • number (integer)

    number of the initial strain solid you want the StrainSolid object for

    Returns

    StrainSolid object (or null if initial strain solid does not exist).

    Return type

    StrainSolid

    Example

    To get the StrainSolid object for initial strain solid 100 in model m 

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

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    initial strain solid property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if StrainSolid 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 StrainSolid property iso.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for strain_solid i: 

    var key = i.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for strain_solid i: 

    var cards = i.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last initial strain solid in the model.

    Arguments

  • Model (Model)

    Model to get last initial strain solid in

    Returns

    StrainSolid object (or null if there are no initial strain solids in the model).

    Return type

    StrainSolid

    Example

    To get the last initial strain solid in model m: 

    var iso = StrainSolid.Last(m);

    Next()

    Description

    Returns the next initial strain solid in the model.

    Arguments

    No arguments

    Returns

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

    Return type

    StrainSolid

    Example

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

    StrainSolid object (or null if not picked)

    Return type

    StrainSolid

    Example

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

    var iso = StrainSolid.Pick('Pick initial strain solid from screen', m);

    Previous()

    Description

    Returns the previous initial strain solid in the model.

    Arguments

    No arguments

    Returns

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

    Return type

    StrainSolid

    Example

    To get the initial strain solid in model m before initial strain 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 strain solids using standard PRIMER object menus.

    Arguments

  • flag (Flag)

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

    Return type

    Number

    Example

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

    StrainSolid.Select(f, 'Select initial strain solids', m);

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

    StrainSolid.Select(f, 'Select initial strain solids', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the initial strain solid.

    Arguments

  • flag (Flag)

    Flag to set on the initial strain solid

    Returns

    No return value

    Example

    To set flag f for initial strain solid iso: 

    iso.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    iso.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

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

  • redraw (optional) (boolean)

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

    StrainSolid.SketchFlagged(m, flag);

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

    Description

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

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of initial strain solids

    Return type

    Number

    Example

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

    var total = StrainSolid.Total(m);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the initial strain solids

    Returns

    No return value

    Example

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

    StrainSolid.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the initial strain solid.

    Arguments

  • redraw (optional) (boolean)

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

    iso.Unsketch();

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

    Description

    Unsketches all initial strain solids.

    Arguments

  • Model (Model)

    Model that all initial strain solids will be unblanked in

  • redraw (optional) (boolean)

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

    StrainSolid.UnsketchAll(m);

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

    Description

    Unsketches all flagged initial strain solids in the model.

    Arguments

  • Model (Model)

    Model that all initial strain solids will be unsketched in

  • flag (Flag)

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

  • redraw (optional) (boolean)

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

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

    StrainSolid object.

    Return type

    StrainSolid

    Example

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

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

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

    Description

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

    iso.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this initial strain solid.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for initial strain solid iso: 

    var xrefs = iso.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for strain_solid i in keyword format 

    var s = i.toString();