IGAIntegrationSolidReduce class

The IGAIntegrationSolidReduce class gives you access to IGA integration solid 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

IGAIntegrationSolidReduce properties

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

Detailed Description

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

Constructor

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

Description

Create a new IGAIntegrationSolidReduce object.

Arguments

  • Model (Model)

    Model that IGA integration solid reduce will be created in

  • details (object)

    Details for creating the IGAIntegrationSolidReduce

    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.
    nrdt (optional) int Reduced degree in the t-direction.
    patchid integer PATCH ID defined in *IGA_SOLID.

    Returns

    IGAIntegrationSolidReduce object

    Return type

    IGAIntegrationSolidReduce

    Example

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

    var igiso = new IGAIntegrationSolidReduce(m, {patchid: 10});

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

    var igiso = new IGAIntegrationSolidReduce(m, {patchid: 20, nrdr: 1, nrds: 2, nrdt: 2});

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a IGA Integration Solid Reduce.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the IGA Integration Solid Reduce

    Returns

    No return value

    Example

    To associate comment c to the IGA Integration Solid Reduce igiso: 

    igiso.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 Solid Reduce igiso: 

    igiso.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the IGA Integration Solid Reduce.

    Arguments

  • flag (Flag)

    Flag to clear on the IGA Integration Solid Reduce

    Returns

    No return value

    Example

    To clear flag f for IGA Integration Solid Reduce igiso: 

    igiso.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    IGAIntegrationSolidReduce object

    Return type

    IGAIntegrationSolidReduce

    Example

    To copy IGA Integration Solid Reduce igiso into IGA Integration Solid Reduce z: 

    var z = igiso.Copy();

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

    Description

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

    Arguments

  • Model (Model)

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

    IGAIntegrationSolidReduce object (or null if not made).

    Return type

    IGAIntegrationSolidReduce

    Example

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

    var igiso = IGAIntegrationSolidReduce.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a IGA Integration Solid Reduce.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the IGA Integration Solid Reduce

    Returns

    No return value

    Example

    To detach comment c from the IGA Integration Solid Reduce igiso: 

    igiso.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 Solid Reduce igiso: 

    igiso.Edit();

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

    Description

    Adds an error for IGA Integration Solid 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 Solid Reduce igiso: 

    igiso.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first IGA Integration Solid Reduce in the model.

    Arguments

  • Model (Model)

    Model to get first IGA Integration Solid Reduce in

    Returns

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

    Return type

    IGAIntegrationSolidReduce

    Example

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

    var igiso = IGAIntegrationSolidReduce.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all IGA Integration Solid Reduces will be flagged in

  • flag (Flag)

    Flag to set on the IGA Integration Solid Reduces

    Returns

    No return value

    Example

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

    IGAIntegrationSolidReduce.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

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

    Arguments

  • flag (Flag)

    Flag to test on the IGA Integration Solid Reduce

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if IGA Integration Solid Reduce igiso has flag f set on it: 

    if (igiso.Flagged(f) ) do_something...

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

    Description

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

    Arguments

  • Model (Model)

    Model that all IGA Integration Solid Reduces are in

  • func (function)

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

    IGAIntegrationSolidReduce.ForEach(m, test);
function test(igiso)
{
// igiso is IGAIntegrationSolidReduce object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get IGA Integration Solid Reduces from

  • property (optional) (string)

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

    Returns

    Array of IGAIntegrationSolidReduce objects or properties

    Return type

    Array

    Example

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

    var a = IGAIntegrationSolidReduce.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a IGA Integration Solid 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 Solid Reduce igiso: 

    var comm_array = igiso.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get IGA Integration Solid Reduces from

  • flag (Flag)

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

  • property (optional) (string)

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

    Returns

    Array of IGAIntegrationSolidReduce objects or properties

    Return type

    Array

    Example

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

    var igiso = IGAIntegrationSolidReduce.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 Solid Reduces in model m flagged with f: 

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

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

    Description

    Returns the IGAIntegrationSolidReduce object for a IGA Integration Solid Reduce ID.

    Arguments

  • Model (Model)

    Model to find the IGA Integration Solid Reduce in

  • number (integer)

    number of the IGA Integration Solid Reduce you want the IGAIntegrationSolidReduce object for

    Returns

    IGAIntegrationSolidReduce object (or null if IGA Integration Solid Reduce does not exist).

    Return type

    IGAIntegrationSolidReduce

    Example

    To get the IGAIntegrationSolidReduce object for IGA Integration Solid Reduce 100 in model m 

    var igiso = IGAIntegrationSolidReduce.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    IGA Integration Solid Reduce property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if IGAIntegrationSolidReduce property igiso.example is a parameter: 

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

    To check if IGAIntegrationSolidReduce property igiso.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this IGA integration solid reduce (*IGA_SOLID). Note that a carriage return is not added. See also IGAIntegrationSolidReduce.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for IGA integration solid reduce igs: 

    var key = igs.Keyword();

    KeywordCards()

    Description

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

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for IGA integration solid reduce igs: 

    var cards = igs.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last IGA Integration Solid Reduce in the model.

    Arguments

  • Model (Model)

    Model to get last IGA Integration Solid Reduce in

    Returns

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

    Return type

    IGAIntegrationSolidReduce

    Example

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

    var igiso = IGAIntegrationSolidReduce.Last(m);

    Next()

    Description

    Returns the next IGA Integration Solid Reduce in the model.

    Arguments

    No arguments

    Returns

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

    Return type

    IGAIntegrationSolidReduce

    Example

    To get the IGA Integration Solid Reduce in model m after IGA Integration Solid Reduce igiso: 

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

    IGAIntegrationSolidReduce object (or null if not picked)

    Return type

    IGAIntegrationSolidReduce

    Example

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

    var igiso = IGAIntegrationSolidReduce.Pick('Pick IGA Integration Solid Reduce from screen', m);

    Previous()

    Description

    Returns the previous IGA Integration Solid Reduce in the model.

    Arguments

    No arguments

    Returns

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

    Return type

    IGAIntegrationSolidReduce

    Example

    To get the IGA Integration Solid Reduce in model m before IGA Integration Solid Reduce igiso: 

    var igiso = igiso.Previous();

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

    Description

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

    Arguments

  • flag (Flag)

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

    Return type

    Number

    Example

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

    IGAIntegrationSolidReduce.Select(f, 'Select IGA Integration Solid Reduces', m);

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

    IGAIntegrationSolidReduce.Select(f, 'Select IGA Integration Solid Reduces', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the IGA Integration Solid Reduce.

    Arguments

  • flag (Flag)

    Flag to set on the IGA Integration Solid Reduce

    Returns

    No return value

    Example

    To set flag f for IGA Integration Solid Reduce igiso: 

    igiso.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the IGA Integration Solid Reduce is sketched. If omitted redraw is true. If you want to sketch several IGA Integration Solid 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 Solid Reduce igiso: 

    igiso.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

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

  • redraw (optional) (boolean)

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

    IGAIntegrationSolidReduce.SketchFlagged(m, flag);

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

    Description

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

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of IGA Integration Solid Reduces

    Return type

    Number

    Example

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

    var total = IGAIntegrationSolidReduce.Total(m);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the IGA Integration Solid Reduces

    Returns

    No return value

    Example

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

    IGAIntegrationSolidReduce.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the IGA Integration Solid Reduce.

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the IGA Integration Solid Reduce is unsketched. If omitted redraw is true. If you want to unsketch several IGA Integration Solid 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 Solid Reduce igiso: 

    igiso.Unsketch();

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

    Description

    Unsketches all IGA Integration Solid Reduces.

    Arguments

  • Model (Model)

    Model that all IGA Integration Solid Reduces will be unblanked in

  • redraw (optional) (boolean)

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

    IGAIntegrationSolidReduce.UnsketchAll(m);

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

    Description

    Unsketches all flagged IGA Integration Solid Reduces in the model.

    Arguments

  • Model (Model)

    Model that all IGA Integration Solid Reduces will be unsketched in

  • flag (Flag)

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

  • redraw (optional) (boolean)

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

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

    IGAIntegrationSolidReduce object.

    Return type

    IGAIntegrationSolidReduce

    Example

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

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

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

    Description

    Adds a warning for IGA Integration Solid 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 Solid Reduce igiso: 

    igiso.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this IGA Integration Solid Reduce.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for IGA Integration Solid Reduce igiso: 

    var xrefs = igiso.Xrefs();

    toString()

    Description

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

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

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

    var s = igs.toString();