Oasys.PRIMER.IGAIntegrationShellReduce class¶

Properties¶

property IGAIntegrationShellReduce.exists(read only): boolean¶

true if IGA Integration Shell Reduce exists, false if referred to but not defined

property IGAIntegrationShellReduce.id(read only): integer¶

ID of the IGA integration shell reduce. Only used in PRIMER

property IGAIntegrationShellReduce.include: integer¶

The Include file number that the IGA Integration Shell Reduce is in

property IGAIntegrationShellReduce.model(read only): integer¶

The Model number that the IGA Integration Shell Reduce is in

property IGAIntegrationShellReduce.nrdr: int¶

Reduced degree in the r-direction

property IGAIntegrationShellReduce.nrds: int¶

Reduced degree in the s-direction

property IGAIntegrationShellReduce.patchid: integer¶

PATCH ID defined in *IGA_SHELL

Constructor¶

classmethod IGAIntegrationShellReduce(model, details)¶
Create a new IGAIntegrationShellReduce object

Parameters:

model (Model) – Model that IGA integration shell reduce will be created in

details (dict) –
Details for creating the IGAIntegrationShellReduce

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:
igish = Oasys.PRIMER.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:
igish = Oasys.PRIMER.IGAIntegrationShellReduce((m, {'patchid': 20, 'nrdr': 1, 'nrds': 2})

Static methods¶

classmethod IGAIntegrationShellReduce.Create(model, modal=Oasys.gRPC.defaultArg)¶
Starts an interactive editing panel to create a IGA Integration Shell Reduce

Parameters:

model (Model) – Model that the IGA Integration Shell Reduce will be created in

modal (boolean) – Optional. 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 None if not made)

Return type:

IGAIntegrationShellReduce

Example

To start creating a IGA Integration Shell Reduce in model m:
igish = Oasys.PRIMER.IGAIntegrationShellReduce.Create(m)
classmethod IGAIntegrationShellReduce.First(model)¶
Returns the first IGA Integration Shell Reduce in the model

Parameters:

model (Model) – Model to get first IGA Integration Shell Reduce in

Returns:

IGAIntegrationShellReduce object (or None 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:
igish = Oasys.PRIMER.IGAIntegrationShellReduce.First(m)
classmethod IGAIntegrationShellReduce.FlagAll(model, flag)¶
Flags all of the IGA Integration Shell Reduces in the model with a defined flag

Parameters:

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

Return type:

None

Example

To flag all of the IGA Integration Shell Reduces with flag f in model m:
Oasys.PRIMER.IGAIntegrationShellReduce.FlagAll(m, f)
classmethod IGAIntegrationShellReduce.GetAll(model, property=Oasys.gRPC.defaultArg)¶
Returns a list 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 a list of IGAIntegrationShellReduce objects is returned. If the property argument is given, that property value for each IGA Integration Shell Reduce is returned in the list instead of a IGAIntegrationShellReduce object

Parameters:

model (Model) – Model to get IGA Integration Shell Reduces from

property (string) – Optional. Name for property to get for all IGA Integration Shell Reduces in the model

Returns:

List of IGAIntegrationShellReduce objects or properties

Return type:

list

Example

To make a list of IGAIntegrationShellReduce objects for all of the IGA Integration Shell Reduces in model m:
a = Oasys.PRIMER.IGAIntegrationShellReduce.GetAll(m)
To return a list containing the value of property ‘foo’ (for example ‘x’ for a node) for each IGA Integration Shell Reduce in model m:
a = Oasys.PRIMER.IGAIntegrationShellReduce.GetAll(m, 'foo')
classmethod IGAIntegrationShellReduce.GetFlagged(model, flag, property=Oasys.gRPC.defaultArg)¶
Returns a list 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 a list 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 list instead of a IGAIntegrationShellReduce object

Parameters:

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 (string) – Optional. Name for property to get for all flagged IGA Integration Shell Reduces in the model

Returns:

List of IGAIntegrationShellReduce objects or properties

Return type:

list

Example

To make a list of IGAIntegrationShellReduce objects for all of the IGA Integration Shell Reduces in model m flagged with f:
igish = Oasys.PRIMER.IGAIntegrationShellReduce.GetFlagged(m, f)
To return a list 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:
a = Oasys.PRIMER.IGAIntegrationShellReduce.GetFlagged(m, f, 'foo')
classmethod IGAIntegrationShellReduce.GetFromID(model, number)¶
Returns the IGAIntegrationShellReduce object for a IGA Integration Shell Reduce ID

Parameters:

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 None 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
igish = Oasys.PRIMER.IGAIntegrationShellReduce.GetFromID(m, 100)
classmethod IGAIntegrationShellReduce.Last(model)¶
Returns the last IGA Integration Shell Reduce in the model

Parameters:

model (Model) – Model to get last IGA Integration Shell Reduce in

Returns:

IGAIntegrationShellReduce object (or None 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:
igish = Oasys.PRIMER.IGAIntegrationShellReduce.Last(m)
classmethod IGAIntegrationShellReduce.Pick(prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg, button_text=Oasys.gRPC.defaultArg)¶
Allows the user to pick a IGA Integration Shell Reduce

Parameters:

prompt (string) – Text to display as a prompt to the user

limit (Model or Flag) – Optional. 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 None, any IGA Integration Shell Reduces from any model can be selected. from any model

modal (boolean) – Optional. 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 (string) – Optional. By default the window with the prompt will have a button labelled ‘Cancel’ which if pressed will cancel the pick and return None. If you want to change the text on the button use this argument. If omitted ‘Cancel’ will be used

Returns:

IGAIntegrationShellReduce object (or None 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’:
igish = Oasys.PRIMER.IGAIntegrationShellReduce.Pick('Pick IGA Integration Shell Reduce from screen', m)
classmethod IGAIntegrationShellReduce.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)¶
Allows the user to select IGA Integration Shell Reduces using standard PRIMER object menus

Parameters:

flag (Flag) – Flag to use when selecting IGA Integration Shell Reduces

prompt (string) – Text to display as a prompt to the user

limit (Model or Flag) – Optional. 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 None, any IGA Integration Shell Reduces can be selected. from any model

modal (boolean) – Optional. 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 None if menu cancelled

Return type:

int

Example

To select IGA Integration Shell Reduces from model m, flagging those selected with flag f, giving the prompt ‘Select IGA Integration Shell Reduces’:
Oasys.PRIMER.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’:
Oasys.PRIMER.IGAIntegrationShellReduce.Select(f, 'Select IGA Integration Shell Reduces', l)
classmethod IGAIntegrationShellReduce.SketchFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)¶
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

Parameters:

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 (boolean) – Optional. 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

Return type:

None

Example

To sketch all IGA Integration Shell Reduces flagged with flag in model m:
Oasys.PRIMER.IGAIntegrationShellReduce.SketchFlagged(m, flag)
classmethod IGAIntegrationShellReduce.Total(model, exists=Oasys.gRPC.defaultArg)¶
Returns the total number of IGA Integration Shell Reduces in the model

Parameters:

model (Model) – Model to get total for

exists (boolean) – Optional. 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:

int

Example

To get the total number of IGA Integration Shell Reduces in model m:
total = Oasys.PRIMER.IGAIntegrationShellReduce.Total(m)
classmethod IGAIntegrationShellReduce.UnflagAll(model, flag)¶
Unsets a defined flag on all of the IGA Integration Shell Reduces in the model

Parameters:

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

Return type:

None

Example

To unset the flag f on all the IGA Integration Shell Reduces in model m:
Oasys.PRIMER.IGAIntegrationShellReduce.UnflagAll(m, f)
classmethod IGAIntegrationShellReduce.UnsketchAll(model, redraw=Oasys.gRPC.defaultArg)¶
Unsketches all IGA Integration Shell Reduces

Parameters:

model (Model) – Model that all IGA Integration Shell Reduces will be unblanked in

redraw (boolean) – Optional. 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

Return type:

None

Example

To unsketch all IGA Integration Shell Reduces in model m:
Oasys.PRIMER.IGAIntegrationShellReduce.UnsketchAll(m)
classmethod IGAIntegrationShellReduce.UnsketchFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)¶
Unsketches all flagged IGA Integration Shell Reduces in the model

Parameters:

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 (boolean) – Optional. 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

Return type:

None

Example

To unsketch all IGA Integration Shell Reduces flagged with flag in model m:
Oasys.PRIMER.IGAIntegrationShellReduce.UnsketchAll(m, flag)

Instance methods¶

IGAIntegrationShellReduce.AssociateComment(comment)¶
Associates a comment with a IGA Integration Shell Reduce

Parameters:

comment (Comment) – Comment that will be attached to the IGA Integration Shell Reduce

Returns:

No return value

Return type:

None

Example

To associate comment c to the IGA Integration Shell Reduce igish:
igish.AssociateComment(c)
IGAIntegrationShellReduce.Browse(modal=Oasys.gRPC.defaultArg)¶
Starts an edit panel in Browse mode

Parameters:

modal (boolean) – Optional. 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

Return type:

None

Example

To Browse IGA Integration Shell Reduce igish:
igish.Browse()
IGAIntegrationShellReduce.ClearFlag(flag)¶
Clears a flag on the IGA Integration Shell Reduce

Parameters:

flag (Flag) – Flag to clear on the IGA Integration Shell Reduce

Returns:

No return value

Return type:

None

Example

To clear flag f for IGA Integration Shell Reduce igish:
igish.ClearFlag(f)
IGAIntegrationShellReduce.Copy(range=Oasys.gRPC.defaultArg)¶
Copies the IGA Integration Shell Reduce. The target include of the copied IGA Integration Shell Reduce can be set using Options.copy_target_include

Parameters:

range (boolean) – Optional. 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:
z = igish.Copy()
IGAIntegrationShellReduce.DetachComment(comment)¶
Detaches a comment from a IGA Integration Shell Reduce

Parameters:

comment (Comment) – Comment that will be detached from the IGA Integration Shell Reduce

Returns:

No return value

Return type:

None

Example

To detach comment c from the IGA Integration Shell Reduce igish:
igish.DetachComment(c)
IGAIntegrationShellReduce.Edit(modal=Oasys.gRPC.defaultArg)¶
Starts an interactive editing panel

Parameters:

modal (boolean) – Optional. 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

Return type:

None

Example

To Edit IGA Integration Shell Reduce igish:
igish.Edit()
IGAIntegrationShellReduce.Flagged(flag)¶
Checks if the IGA Integration Shell Reduce is flagged or not

Parameters:

flag (Flag) – Flag to test on the IGA Integration Shell Reduce

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if IGA Integration Shell Reduce igish has flag f set on it:
if igish.Flagged(f):
    do_something..
IGAIntegrationShellReduce.GetComments()¶
Extracts the comments associated to a IGA Integration Shell Reduce

Returns:

List of Comment objects (or None if there are no comments associated to the node)

Return type:

list

Example

To get the list of comments associated to the IGA Integration Shell Reduce igish:
comm_list = igish.GetComments()
IGAIntegrationShellReduce.GetParameter(prop)¶
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)

Parameters:

prop (string) – IGA Integration Shell Reduce property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

Parameter

Example

To check if IGAIntegrationShellReduce property igish.example is a parameter:
Oasys.PRIMER.Options.property_parameter_names = True
if igish.GetParameter(igish.example):
    do_something...
Oasys.PRIMER.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..
IGAIntegrationShellReduce.Keyword()¶
Returns the keyword for this IGA integration shell reduce (*IGA_SHELL). Note that a carriage return is not added. See also IGAIntegrationShellReduce.KeywordCards()

Returns:

string containing the keyword

Return type:

str

Example

To get the keyword for IGA integration shell reduce igs:
key = igs.Keyword()
IGAIntegrationShellReduce.KeywordCards()¶
Returns the keyword cards for the IGA integration shell reduce. Note that a carriage return is not added. See also IGAIntegrationShellReduce.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for IGA integration shell reduce igs:
cards = igs.KeywordCards()
IGAIntegrationShellReduce.Next()¶
Returns the next IGA Integration Shell Reduce in the model

Returns:

IGAIntegrationShellReduce object (or None 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:
igish = igish.Next()
IGAIntegrationShellReduce.Previous()¶
Returns the previous IGA Integration Shell Reduce in the model

Returns:

IGAIntegrationShellReduce object (or None 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:
igish = igish.Previous()
IGAIntegrationShellReduce.SetFlag(flag)¶
Sets a flag on the IGA Integration Shell Reduce

Parameters:

flag (Flag) – Flag to set on the IGA Integration Shell Reduce

Returns:

No return value

Return type:

None

Example

To set flag f for IGA Integration Shell Reduce igish:
igish.SetFlag(f)
IGAIntegrationShellReduce.Sketch(redraw=Oasys.gRPC.defaultArg)¶
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

Parameters:

redraw (boolean) – Optional. 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

Return type:

None

Example

To sketch IGA Integration Shell Reduce igish:
igish.Sketch()
IGAIntegrationShellReduce.Unsketch(redraw=Oasys.gRPC.defaultArg)¶
Unsketches the IGA Integration Shell Reduce

Parameters:

redraw (boolean) – Optional. 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

Return type:

None

Example

To unsketch IGA Integration Shell Reduce igish:
igish.Unsketch()
IGAIntegrationShellReduce.ViewParameters()¶
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

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..
IGAIntegrationShellReduce.Xrefs()¶
Returns the cross references for this IGA Integration Shell Reduce

Returns:

Xrefs object

Return type:

Xrefs

Example

To get the cross references for IGA Integration Shell Reduce igish:
xrefs = igish.Xrefs()