IGAIntegrationShellReduce class

The IGAIntegrationShellReduce class gives you access to IGA integration shell reduce 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

IGAIntegrationShellReduce properties

Name Type Description
exists (read only) logical true if IGA Integration Shell Reduce exists, false if referred to but not defined.
id (read only) integer ID of the IGA integration shell reduce. Only used in PRIMER.
include integer The Include file number that the IGA Integration Shell Reduce is in.
model (read only) integer The Model number that the IGA Integration Shell Reduce is in.
nrdr int Reduced degree in the r-direction.
nrds int Reduced degree in the s-direction.
patchid integer PATCH ID defined in *IGA_SHELL.

Detailed Description

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

Constructor

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

Description

Create a new IGAIntegrationShellReduce object.

Arguments

  • Model (Model)

    Model that IGA integration shell reduce will be created in

  • details (object)

    Details for creating the IGAIntegrationShellReduce

    Object has the following properties:

    Name Type Description
    nrdr (optional) int Reduced degree in the r-direction.
    nrds (optional) int Reduced degree in the s-direction.
    patchid integer PATCH ID defined in *IGA_SHELL.

    Returns

    IGAIntegrationShellReduce object

    Return type

    IGAIntegrationShellReduce

    Example

    To create a new IGA integration shell reduce in model m for shell patch 10: 

    var igish = new IGAIntegrationShellReduce(m, {patchid: 10});

    To create a new IGA integration shell reduce in model m for shell patch 20 with nrdr and nrds 1 and 2 respectively: 

    var igish = new IGAIntegrationShellReduce(m, {patchid: 20, nrdr: 1, nrds: 2});

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a IGA Integration Shell Reduce.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the IGA Integration Shell Reduce

    Returns

    No return value

    Example

    To associate comment c to the IGA Integration Shell Reduce igish: 

    igish.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 Integration Shell Reduce igish: 

    igish.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the IGA Integration Shell Reduce.

    Arguments

  • flag (Flag)

    Flag to clear on the IGA Integration Shell Reduce

    Returns

    No return value

    Example

    To clear flag f for IGA Integration Shell Reduce igish: 

    igish.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    IGAIntegrationShellReduce object

    Return type

    IGAIntegrationShellReduce

    Example

    To copy IGA Integration Shell Reduce igish into IGA Integration Shell Reduce z: 

    var z = igish.Copy();

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

    Description

    Starts an interactive editing panel to create a IGA Integration Shell Reduce

    Arguments

  • Model (Model)

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

    IGAIntegrationShellReduce object (or null if not made).

    Return type

    IGAIntegrationShellReduce

    Example

    To start creating a IGA Integration Shell Reduce in model m: 

    var igish = IGAIntegrationShellReduce.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a IGA Integration Shell Reduce.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the IGA Integration Shell Reduce

    Returns

    No return value

    Example

    To detach comment c from the IGA Integration Shell Reduce igish: 

    igish.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 Integration Shell Reduce igish: 

    igish.Edit();

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

    Description

    Adds an error for IGA Integration Shell Reduce. 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 Integration Shell Reduce igish: 

    igish.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first IGA Integration Shell Reduce in the model.

    Arguments

  • Model (Model)

    Model to get first IGA Integration Shell Reduce in

    Returns

    IGAIntegrationShellReduce object (or null if there are no IGA Integration Shell Reduces in the model).

    Return type

    IGAIntegrationShellReduce

    Example

    To get the first IGA Integration Shell Reduce in model m: 

    var igish = IGAIntegrationShellReduce.First(m);

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

    Description

    Flags all of the IGA Integration Shell Reduces in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all IGA Integration Shell Reduces will be flagged in

  • flag (Flag)

    Flag to set on the IGA Integration Shell Reduces

    Returns

    No return value

    Example

    To flag all of the IGA Integration Shell Reduces with flag f in model m: 

    IGAIntegrationShellReduce.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the IGA Integration Shell Reduce is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the IGA Integration Shell Reduce

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if IGA Integration Shell Reduce igish has flag f set on it: 

    if (igish.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all IGA Integration Shell Reduces are in

  • func (function)

    Function to call for each IGA Integration Shell Reduce

  • 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 Integration Shell Reduces in model m: 

    IGAIntegrationShellReduce.ForEach(m, test);
function test(igish)
{
// igish is IGAIntegrationShellReduce object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get IGA Integration Shell Reduces from

  • property (optional) (string)

    Name for property to get for all IGA Integration Shell Reduces in the model

    Returns

    Array of IGAIntegrationShellReduce objects or properties

    Return type

    Array

    Example

    To make an array of IGAIntegrationShellReduce objects for all of the IGA Integration Shell Reduces in model m: 

    var a = IGAIntegrationShellReduce.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a IGA Integration Shell Reduce.

    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 Integration Shell Reduce igish: 

    var comm_array = igish.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get IGA Integration Shell Reduces from

  • flag (Flag)

    Flag set on the IGA Integration Shell Reduces that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged IGA Integration Shell Reduces in the model

    Returns

    Array of IGAIntegrationShellReduce objects or properties

    Return type

    Array

    Example

    To make an array of IGAIntegrationShellReduce objects for all of the IGA Integration Shell Reduces in model m flagged with f: 

    var igish = IGAIntegrationShellReduce.GetFlagged(m, f);

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

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

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

    Description

    Returns the IGAIntegrationShellReduce object for a IGA Integration Shell Reduce ID.

    Arguments

  • Model (Model)

    Model to find the IGA Integration Shell Reduce in

  • number (integer)

    number of the IGA Integration Shell Reduce you want the IGAIntegrationShellReduce object for

    Returns

    IGAIntegrationShellReduce object (or null if IGA Integration Shell Reduce does not exist).

    Return type

    IGAIntegrationShellReduce

    Example

    To get the IGAIntegrationShellReduce object for IGA Integration Shell Reduce 100 in model m 

    var igish = IGAIntegrationShellReduce.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    IGA Integration Shell Reduce property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if IGAIntegrationShellReduce property igish.example is a parameter: 

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

    To check if IGAIntegrationShellReduce property igish.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for IGA integration shell reduce igs: 

    var key = igs.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for IGA integration shell reduce igs: 

    var cards = igs.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last IGA Integration Shell Reduce in the model.

    Arguments

  • Model (Model)

    Model to get last IGA Integration Shell Reduce in

    Returns

    IGAIntegrationShellReduce object (or null if there are no IGA Integration Shell Reduces in the model).

    Return type

    IGAIntegrationShellReduce

    Example

    To get the last IGA Integration Shell Reduce in model m: 

    var igish = IGAIntegrationShellReduce.Last(m);

    Next()

    Description

    Returns the next IGA Integration Shell Reduce in the model.

    Arguments

    No arguments

    Returns

    IGAIntegrationShellReduce object (or null if there are no more IGA Integration Shell Reduces in the model).

    Return type

    IGAIntegrationShellReduce

    Example

    To get the IGA Integration Shell Reduce in model m after IGA Integration Shell Reduce igish: 

    var igish = igish.Next();

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

    Description

    Allows the user to pick a IGA Integration Shell Reduce.

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

    IGAIntegrationShellReduce object (or null if not picked)

    Return type

    IGAIntegrationShellReduce

    Example

    To pick a IGA Integration Shell Reduce from model m giving the prompt 'Pick IGA Integration Shell Reduce from screen': 

    var igish = IGAIntegrationShellReduce.Pick('Pick IGA Integration Shell Reduce from screen', m);

    Previous()

    Description

    Returns the previous IGA Integration Shell Reduce in the model.

    Arguments

    No arguments

    Returns

    IGAIntegrationShellReduce object (or null if there are no more IGA Integration Shell Reduces in the model).

    Return type

    IGAIntegrationShellReduce

    Example

    To get the IGA Integration Shell Reduce in model m before IGA Integration Shell Reduce igish: 

    var igish = igish.Previous();

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

    Description

    Allows the user to select IGA Integration Shell Reduces using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting IGA Integration Shell Reduces

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

    Return type

    Number

    Example

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

    IGAIntegrationShellReduce.Select(f, 'Select IGA Integration Shell Reduces', m);

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

    IGAIntegrationShellReduce.Select(f, 'Select IGA Integration Shell Reduces', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the IGA Integration Shell Reduce.

    Arguments

  • flag (Flag)

    Flag to set on the IGA Integration Shell Reduce

    Returns

    No return value

    Example

    To set flag f for IGA Integration Shell Reduce igish: 

    igish.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch IGA Integration Shell Reduce igish: 

    igish.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged IGA Integration Shell Reduces will be sketched in

  • flag (Flag)

    Flag set on the IGA Integration Shell Reduces that you want to sketch

  • redraw (optional) (boolean)

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

    IGAIntegrationShellReduce.SketchFlagged(m, flag);

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

    Description

    Returns the total number of IGA Integration Shell Reduces in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of IGA Integration Shell Reduces

    Return type

    Number

    Example

    To get the total number of IGA Integration Shell Reduces in model m: 

    var total = IGAIntegrationShellReduce.Total(m);

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

    Description

    Unsets a defined flag on all of the IGA Integration Shell Reduces in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all IGA Integration Shell Reduces will be unset in

  • flag (Flag)

    Flag to unset on the IGA Integration Shell Reduces

    Returns

    No return value

    Example

    To unset the flag f on all the IGA Integration Shell Reduces in model m: 

    IGAIntegrationShellReduce.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the IGA Integration Shell Reduce.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch IGA Integration Shell Reduce igish: 

    igish.Unsketch();

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

    Description

    Unsketches all IGA Integration Shell Reduces.

    Arguments

  • Model (Model)

    Model that all IGA Integration Shell Reduces will be unblanked in

  • redraw (optional) (boolean)

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

    IGAIntegrationShellReduce.UnsketchAll(m);

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

    Description

    Unsketches all flagged IGA Integration Shell Reduces in the model.

    Arguments

  • Model (Model)

    Model that all IGA Integration Shell Reduces will be unsketched in

  • flag (Flag)

    Flag set on the IGA Integration Shell Reduces that you want to unsketch

  • redraw (optional) (boolean)

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

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

    IGAIntegrationShellReduce object.

    Return type

    IGAIntegrationShellReduce

    Example

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

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

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

    Description

    Adds a warning for IGA Integration Shell Reduce. 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 Integration Shell Reduce igish: 

    igish.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this IGA Integration Shell Reduce.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for IGA Integration Shell Reduce igish: 

    var xrefs = igish.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for IGA integration shell reduce igs in keyword format 

    var s = igs.toString();