Oasys.PRIMER.IGAIntegrationSolidReduce class¶

Properties¶

property IGAIntegrationSolidReduce.exists(read only): boolean¶

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

property IGAIntegrationSolidReduce.id(read only): integer¶

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

property IGAIntegrationSolidReduce.include: integer¶

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

property IGAIntegrationSolidReduce.model(read only): integer¶

The Model number that the IGA Integration Solid Reduce is in

property IGAIntegrationSolidReduce.nrdr: int¶

Reduced degree in the r-direction

property IGAIntegrationSolidReduce.nrds: int¶

Reduced degree in the s-direction

property IGAIntegrationSolidReduce.nrdt: int¶

Reduced degree in the t-direction

property IGAIntegrationSolidReduce.patchid: integer¶

PATCH ID defined in *IGA_SOLID

Constructor¶

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

Parameters:

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

details (dict) –
Details for creating the IGAIntegrationSolidReduce

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

Static methods¶

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

Parameters:

model (Model) – Model that the IGA Integration Solid 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:

IGAIntegrationSolidReduce object (or None if not made)

Return type:

IGAIntegrationSolidReduce

Example

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

Parameters:

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

Returns:

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

Parameters:

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

Return type:

None

Example

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

Parameters:

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

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

Returns:

List of IGAIntegrationSolidReduce objects or properties

Return type:

list

Example

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

Parameters:

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

Returns:

List of IGAIntegrationSolidReduce objects or properties

Return type:

list

Example

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

Parameters:

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

Parameters:

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

Returns:

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

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

Parameters:

flag (Flag) – Flag to use when selecting IGA Integration Solid 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 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 None, any IGA Integration Solid 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 Solid Reduces selected or None if menu cancelled

Return type:

int

Example

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

Parameters:

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

Return type:

None

Example

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

Parameters:

model (Model) – Model to get total for

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

int

Example

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

Parameters:

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

Return type:

None

Example

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

Parameters:

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

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

Return type:

None

Example

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

Parameters:

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

Return type:

None

Example

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

Instance methods¶

IGAIntegrationSolidReduce.AssociateComment(comment)¶
Associates a comment with a IGA Integration Solid Reduce

Parameters:

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

Returns:

No return value

Return type:

None

Example

To associate comment c to the IGA Integration Solid Reduce igiso:
igiso.AssociateComment(c)
IGAIntegrationSolidReduce.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 Solid Reduce igiso:
igiso.Browse()
IGAIntegrationSolidReduce.ClearFlag(flag)¶
Clears a flag on the IGA Integration Solid Reduce

Parameters:

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

Returns:

No return value

Return type:

None

Example

To clear flag f for IGA Integration Solid Reduce igiso:
igiso.ClearFlag(f)
IGAIntegrationSolidReduce.Copy(range=Oasys.gRPC.defaultArg)¶
Copies the IGA Integration Solid Reduce. The target include of the copied IGA Integration Solid 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:

IGAIntegrationSolidReduce object

Return type:

IGAIntegrationSolidReduce

Example

To copy IGA Integration Solid Reduce igiso into IGA Integration Solid Reduce z:
z = igiso.Copy()
IGAIntegrationSolidReduce.DetachComment(comment)¶
Detaches a comment from a IGA Integration Solid Reduce

Parameters:

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

Returns:

No return value

Return type:

None

Example

To detach comment c from the IGA Integration Solid Reduce igiso:
igiso.DetachComment(c)
IGAIntegrationSolidReduce.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 Solid Reduce igiso:
igiso.Edit()
IGAIntegrationSolidReduce.Flagged(flag)¶
Checks if the IGA Integration Solid Reduce is flagged or not

Parameters:

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

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if IGA Integration Solid Reduce igiso has flag f set on it:
if igiso.Flagged(f):
    do_something..
IGAIntegrationSolidReduce.GetComments()¶
Extracts the comments associated to a IGA Integration Solid 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 Solid Reduce igiso:
comm_list = igiso.GetComments()
IGAIntegrationSolidReduce.GetParameter(prop)¶
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)

Parameters:

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

Returns:

Parameter object if property is a parameter, None if not

Return type:

Parameter

Example

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

Returns:

string containing the keyword

Return type:

str

Example

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

Returns:

string containing the cards

Return type:

str

Example

To get the cards for IGA integration solid reduce igs:
cards = igs.KeywordCards()
IGAIntegrationSolidReduce.Next()¶
Returns the next IGA Integration Solid Reduce in the model

Returns:

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

Returns:

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

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

Return type:

None

Example

To sketch IGA Integration Solid Reduce igiso:
igiso.Sketch()
IGAIntegrationSolidReduce.Unsketch(redraw=Oasys.gRPC.defaultArg)¶
Unsketches the IGA Integration Solid Reduce

Parameters:

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

Return type:

None

Example

To unsketch IGA Integration Solid Reduce igiso:
igiso.Unsketch()
IGAIntegrationSolidReduce.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:

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

Returns:

Xrefs object

Return type:

Xrefs

Example

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