IGAShell class

The IGAShell class gives you access to IGA 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

IGAShell properties

Name Type Description
exists (read only) logical true if IGA Shell exists, false if referred to but not defined.
id (read only) integer ID of the IGA shell. Only used in PRIMER.
idfne integer Element ID of the first IGA element.
include integer The Include file number that the IGA Shell is in.
model (read only) integer The Model number that the IGA Shell is in.
nisr real Interpolation elements in the local r-direction.
niss real Interpolation elements in the local s-direction.
pid integer Part ID.
sid integer Isogeometric Shell (patch) ID.

Detailed Description

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

Constructor

new IGAShell(Model[Model], details[object])

Description

Create a new IGAShell object.

Arguments

  • Model (Model)

    Model that IGA shell will be created in

  • details (object)

    Details for creating the IGAShell

    Object has the following properties:

    Name Type Description
    idfne (optional) integer Element ID of the first IGA element.
    nisr (optional) real Interpolation elements in the local r-direction.
    niss (optional) real Interpolation elements in the local s-direction.
    pid integer Part ID.
    sid integer Isogeometric Shell (patch) ID.

    Returns

    IGAShell object

    Return type

    IGAShell

    Example

    To create a new IGA shell in model m using sid 10, part id 100: 

    var igsh = new IGAShell(m, {sid: 10, pid: 100});

    To create a new IGA shell in model m using sid 20, part id 200 with nisr as 3.3, niss as 4.4 and idfne as 50: 

    var igsh = new IGAShell(m, {sid: 20, pid: 200, nisr: 3.3, niss: 4.4, idfne: 50});

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a IGA Shell.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the IGA Shell

    Returns

    No return value

    Example

    To associate comment c to the IGA Shell igsh: 

    igsh.AssociateComment(c);

    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 IGA Shell igsh: 

    igsh.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the IGA Shell.

    Arguments

  • flag (Flag)

    Flag to clear on the IGA Shell

    Returns

    No return value

    Example

    To clear flag f for IGA Shell igsh: 

    igsh.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    IGAShell object

    Return type

    IGAShell

    Example

    To copy IGA Shell igsh into IGA Shell z: 

    var z = igsh.Copy();

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

    Description

    Starts an interactive editing panel to create a IGA Shell

    Arguments

  • Model (Model)

    Model that the IGA 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

    IGAShell object (or null if not made).

    Return type

    IGAShell

    Example

    To start creating a IGA Shell in model m: 

    var igsh = IGAShell.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a IGA Shell.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the IGA Shell

    Returns

    No return value

    Example

    To detach comment c from the IGA Shell igsh: 

    igsh.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 IGA Shell igsh: 

    igsh.Edit();

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

    Description

    Adds an error for IGA 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 IGA Shell igsh: 

    igsh.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first IGA Shell in the model.

    Arguments

  • Model (Model)

    Model to get first IGA Shell in

    Returns

    IGAShell object (or null if there are no IGA Shells in the model).

    Return type

    IGAShell

    Example

    To get the first IGA Shell in model m: 

    var igsh = IGAShell.First(m);

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

    Description

    Flags all of the IGA Shells in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all IGA Shells will be flagged in

  • flag (Flag)

    Flag to set on the IGA Shells

    Returns

    No return value

    Example

    To flag all of the IGA Shells with flag f in model m: 

    IGAShell.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the IGA Shell is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the IGA Shell

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if IGA Shell igsh has flag f set on it: 

    if (igsh.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all IGA Shells are in

  • func (function)

    Function to call for each IGA 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 IGA Shells in model m: 

    IGAShell.ForEach(m, test);
function test(igsh)
{
// igsh is IGAShell object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get IGA Shells from

  • property (optional) (string)

    Name for property to get for all IGA Shells in the model

    Returns

    Array of IGAShell objects or properties

    Return type

    Array

    Example

    To make an array of IGAShell objects for all of the IGA Shells in model m: 

    var a = IGAShell.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a IGA 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 IGA Shell igsh: 

    var comm_array = igsh.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get IGA Shells from

  • flag (Flag)

    Flag set on the IGA Shells that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged IGA Shells in the model

    Returns

    Array of IGAShell objects or properties

    Return type

    Array

    Example

    To make an array of IGAShell objects for all of the IGA Shells in model m flagged with f: 

    var igsh = IGAShell.GetFlagged(m, f);

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

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

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

    Description

    Returns the IGAShell object for a IGA Shell ID.

    Arguments

  • Model (Model)

    Model to find the IGA Shell in

  • number (integer)

    number of the IGA Shell you want the IGAShell object for

    Returns

    IGAShell object (or null if IGA Shell does not exist).

    Return type

    IGAShell

    Example

    To get the IGAShell object for IGA Shell 100 in model m 

    var igsh = IGAShell.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    IGA Shell property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if IGAShell property igsh.example is a parameter: 

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

    To check if IGAShell property igsh.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this IGA shell (*IGA_SHELL). Note that a carriage return is not added. See also IGAShell.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for IGA shell igs: 

    var key = igs.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for IGA shell igs: 

    var cards = igs.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last IGA Shell in the model.

    Arguments

  • Model (Model)

    Model to get last IGA Shell in

    Returns

    IGAShell object (or null if there are no IGA Shells in the model).

    Return type

    IGAShell

    Example

    To get the last IGA Shell in model m: 

    var igsh = IGAShell.Last(m);

    Next()

    Description

    Returns the next IGA Shell in the model.

    Arguments

    No arguments

    Returns

    IGAShell object (or null if there are no more IGA Shells in the model).

    Return type

    IGAShell

    Example

    To get the IGA Shell in model m after IGA Shell igsh: 

    var igsh = igsh.Next();

    Previous()

    Description

    Returns the previous IGA Shell in the model.

    Arguments

    No arguments

    Returns

    IGAShell object (or null if there are no more IGA Shells in the model).

    Return type

    IGAShell

    Example

    To get the IGA Shell in model m before IGA Shell igsh: 

    var igsh = igsh.Previous();

    RedrawAll(Model[Model]) [static]

    Description

    Redraws all *IGA_SHELLs whose graphics are out of date in a specified model

    Arguments

  • Model (Model)

    Model to redraw IGA SHELLs in

    Returns

    No return value

    Example

    Redraw all out of date *IGA_SHELLs following a change to an *IGA_SHELL or related IGA entity in model m1: 

    IGAShell.RedrawAll(m1);

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

    Description

    Allows the user to select IGA Shells using standard PRIMER object menus.

    Arguments

  • flag (Flag)

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

    Return type

    Number

    Example

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

    IGAShell.Select(f, 'Select IGA Shells', m);

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

    IGAShell.Select(f, 'Select IGA Shells', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the IGA Shell.

    Arguments

  • flag (Flag)

    Flag to set on the IGA Shell

    Returns

    No return value

    Example

    To set flag f for IGA Shell igsh: 

    igsh.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch IGA Shell igsh: 

    igsh.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged IGA Shells will be sketched in

  • flag (Flag)

    Flag set on the IGA Shells that you want to sketch

  • redraw (optional) (boolean)

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

    IGAShell.SketchFlagged(m, flag);

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

    Description

    Returns the total number of IGA Shells in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of IGA Shells

    Return type

    Number

    Example

    To get the total number of IGA Shells in model m: 

    var total = IGAShell.Total(m);

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

    Description

    Unsets a defined flag on all of the IGA Shells in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all IGA Shells will be unset in

  • flag (Flag)

    Flag to unset on the IGA Shells

    Returns

    No return value

    Example

    To unset the flag f on all the IGA Shells in model m: 

    IGAShell.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the IGA Shell.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch IGA Shell igsh: 

    igsh.Unsketch();

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

    Description

    Unsketches all IGA Shells.

    Arguments

  • Model (Model)

    Model that all IGA Shells will be unblanked in

  • redraw (optional) (boolean)

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

    IGAShell.UnsketchAll(m);

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

    Description

    Unsketches all flagged IGA Shells in the model.

    Arguments

  • Model (Model)

    Model that all IGA Shells will be unsketched in

  • flag (Flag)

    Flag set on the IGA Shells that you want to unsketch

  • redraw (optional) (boolean)

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

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

    IGAShell object.

    Return type

    IGAShell

    Example

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

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

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

    Description

    Adds a warning for IGA 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 IGA Shell igsh: 

    igsh.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this IGA Shell.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for IGA Shell igsh: 

    var xrefs = igsh.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for IGA shell igs in keyword format 

    var s = igs.toString();