Oasys.PRIMER.IGATiedEdge class

Properties

property IGATiedEdge.exists(read only): boolean

true if IGA Tied Edge To Edge exists, false if referred to but not defined

property IGATiedEdge.form: integer

Coupling formulation

property IGATiedEdge.id: integer

Apply coupling to entities reference by this ID along topologically connected edges

property IGATiedEdge.include: integer

The Include file number that the IGA Tied Edge To Edge is in

property IGATiedEdge.label(read only): integer

ID of the IGA tied edge to edge. Only used in PRIMER

property IGATiedEdge.model(read only): integer

The Model number that the IGA Tied Edge To Edge is in

property IGATiedEdge.sfd: float

Scaling factor for displacement penalty stiffness

property IGATiedEdge.sfr: float

Scaling factor for rotational penalty stiffness

property IGATiedEdge.sft: float

Scaling factor for thin constraint penalty stiffness (rotation free elements)

property IGATiedEdge.type: integer

Type of ID

Constructor

classmethod IGATiedEdge(model, details=Oasys.gRPC.defaultArg)

Create a new IGATiedEdge object

Parameters:

• model (Model) – Model that IGA tied edge to edge will be created in

• details (dict) –

  Optional. Details for creating the IGATiedEdge

  form (optional):

  (integer) Coupling formulation

  id (optional):

  (integer) Apply coupling to entities referenced by the ID field along topologically connected edges

  sfd (optional):

  (float) Scaling factor for displacement penalty stiffness

  sfr (optional):

  (float) Scaling factor for rotational penalty stiffness

  sft (optional):

  (float) Scaling factor for thin constraint penalty stiffness (rotation free elements)

  type(optional):

  (integer) Type of ID

Returns:

IGATiedEdge object

Return type:

IGATiedEdge

Example

To create a new IGA tied edge to edge in model m with id 1, type 0, form 0, sfd 2.2, sfr 3.3 and sft 4.4:

igte = Oasys.PRIMER.IGATiedEdge(m, {'id': 1, 'type': 0, 'form': 0, 'sfd':2, 'sfr': 3, 'sft': 4})

Static methods

classmethod IGATiedEdge.Create(model, modal=Oasys.gRPC.defaultArg)

Starts an interactive editing panel to create a IGA Tied Edge To Edge

Parameters:

• model (Model) – Model that the IGA Tied Edge To Edge 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:

IGATiedEdge object (or None if not made)

Return type:

IGATiedEdge

Example

To start creating a IGA Tied Edge To Edge in model m:

igte = Oasys.PRIMER.IGATiedEdge.Create(m)

classmethod IGATiedEdge.First(model)

Returns the first IGA Tied Edge To Edge in the model

Parameters:

model (Model) – Model to get first IGA Tied Edge To Edge in

Returns:

IGATiedEdge object (or None if there are no IGA Tied Edge To Edges in the model)

Return type:

IGATiedEdge

Example

To get the first IGA Tied Edge To Edge in model m:

igte = Oasys.PRIMER.IGATiedEdge.First(m)

classmethod IGATiedEdge.FlagAll(model, flag)

Flags all of the IGA Tied Edge To Edges in the model with a defined flag

Parameters:

• model (Model) – Model that all IGA Tied Edge To Edges will be flagged in

• flag (Flag) – Flag to set on the IGA Tied Edge To Edges

Returns:

No return value

Return type:

None

Example

To flag all of the IGA Tied Edge To Edges with flag f in model m:

Oasys.PRIMER.IGATiedEdge.FlagAll(m, f)

classmethod IGATiedEdge.GetAll(model, property=Oasys.gRPC.defaultArg)

Returns a list of IGATiedEdge objects or properties for all of the IGA Tied Edge To Edges in a model in PRIMER. If the optional property argument is not given then a list of IGATiedEdge objects is returned. If the property argument is given, that property value for each IGA Tied Edge To Edge is returned in the list instead of a IGATiedEdge object

Parameters:

• model (Model) – Model to get IGA Tied Edge To Edges from

• property (string) – Optional. Name for property to get for all IGA Tied Edge To Edges in the model

Returns:

List of IGATiedEdge objects or properties

Return type:

list

Example

To make a list of IGATiedEdge objects for all of the IGA Tied Edge To Edges in model m:

a = Oasys.PRIMER.IGATiedEdge.GetAll(m)

To return a list containing the value of property ‘foo’ (for example ‘x’ for a node) for each IGA Tied Edge To Edge in model m:

a = Oasys.PRIMER.IGATiedEdge.GetAll(m, 'foo')

classmethod IGATiedEdge.GetFlagged(model, flag, property=Oasys.gRPC.defaultArg)

Returns a list of IGATiedEdge objects for all of the flagged IGA Tied Edge To Edges in a model in PRIMER If the optional property argument is not given then a list of IGATiedEdge objects is returned. If the property argument is given, then that property value for each IGA Tied Edge To Edge is returned in the list instead of a IGATiedEdge object

Parameters:

• model (Model) – Model to get IGA Tied Edge To Edges from

• flag (Flag) – Flag set on the IGA Tied Edge To Edges that you want to retrieve

• property (string) – Optional. Name for property to get for all flagged IGA Tied Edge To Edges in the model

Returns:

List of IGATiedEdge objects or properties

Return type:

list

Example

To make a list of IGATiedEdge objects for all of the IGA Tied Edge To Edges in model m flagged with f:

igte = Oasys.PRIMER.IGATiedEdge.GetFlagged(m, f)

To return a list containing the value of property ‘foo’ (for example ‘x’ for a node) for all of the IGA Tied Edge To Edges in model m flagged with f:

a = Oasys.PRIMER.IGATiedEdge.GetFlagged(m, f, 'foo')

classmethod IGATiedEdge.GetFromID(model, number)

Returns the IGATiedEdge object for a IGA Tied Edge To Edge ID

Parameters:

• model (Model) – Model to find the IGA Tied Edge To Edge in

• number (integer) – number of the IGA Tied Edge To Edge you want the IGATiedEdge object for

Returns:

IGATiedEdge object (or None if IGA Tied Edge To Edge does not exist)

Return type:

IGATiedEdge

Example

To get the IGATiedEdge object for IGA Tied Edge To Edge 100 in model m

igte = Oasys.PRIMER.IGATiedEdge.GetFromID(m, 100)

classmethod IGATiedEdge.Last(model)

Returns the last IGA Tied Edge To Edge in the model

Parameters:

model (Model) – Model to get last IGA Tied Edge To Edge in

Returns:

IGATiedEdge object (or None if there are no IGA Tied Edge To Edges in the model)

Return type:

IGATiedEdge

Example

To get the last IGA Tied Edge To Edge in model m:

igte = Oasys.PRIMER.IGATiedEdge.Last(m)

classmethod IGATiedEdge.Pick(prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg, button_text=Oasys.gRPC.defaultArg)

Allows the user to pick a IGA Tied Edge To Edge

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 Tied Edge To Edges from that model can be picked. If the argument is a Flag then only IGA Tied Edge To Edges that are flagged with limit can be selected. If omitted, or None, any IGA Tied Edge To Edges 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:

IGATiedEdge object (or None if not picked)

Return type:

IGATiedEdge

Example

To pick a IGA Tied Edge To Edge from model m giving the prompt ‘Pick IGA Tied Edge To Edge from screen’:

igte = Oasys.PRIMER.IGATiedEdge.Pick('Pick IGA Tied Edge To Edge from screen', m)

classmethod IGATiedEdge.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)

Allows the user to select IGA Tied Edge To Edges using standard PRIMER object menus

Parameters:

• flag (Flag) – Flag to use when selecting IGA Tied Edge To Edges

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

Return type:

int

Example

To select IGA Tied Edge To Edges from model m, flagging those selected with flag f, giving the prompt ‘Select IGA Tied Edge To Edges’:

Oasys.PRIMER.IGATiedEdge.Select(f, 'Select IGA Tied Edge To Edges', m)

To select IGA Tied Edge To Edges, flagging those selected with flag f but limiting selection to IGA Tied Edge To Edges flagged with flag l, giving the prompt ‘Select IGA Tied Edge To Edges’:

Oasys.PRIMER.IGATiedEdge.Select(f, 'Select IGA Tied Edge To Edges', l)

classmethod IGATiedEdge.Total(model, exists=Oasys.gRPC.defaultArg)

Returns the total number of IGA Tied Edge To Edges in the model

Parameters:

• model (Model) – Model to get total for

• exists (boolean) – Optional. true if only existing IGA Tied Edge To Edges should be counted. If false or omitted referenced but undefined IGA Tied Edge To Edges will also be included in the total

Returns:

number of IGA Tied Edge To Edges

Return type:

int

Example

To get the total number of IGA Tied Edge To Edges in model m:

total = Oasys.PRIMER.IGATiedEdge.Total(m)

classmethod IGATiedEdge.UnflagAll(model, flag)

Unsets a defined flag on all of the IGA Tied Edge To Edges in the model

Parameters:

• model (Model) – Model that the defined flag for all IGA Tied Edge To Edges will be unset in

• flag (Flag) – Flag to unset on the IGA Tied Edge To Edges

Returns:

No return value

Return type:

None

Example

To unset the flag f on all the IGA Tied Edge To Edges in model m:

Oasys.PRIMER.IGATiedEdge.UnflagAll(m, f)

Instance methods

IGATiedEdge.AssociateComment(comment)

Associates a comment with a IGA Tied Edge To Edge

Parameters:

comment (Comment) – Comment that will be attached to the IGA Tied Edge To Edge

Returns:

No return value

Return type:

None

Example

To associate comment c to the IGA Tied Edge To Edge igte:

igte.AssociateComment(c)

IGATiedEdge.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 Tied Edge To Edge igte:

igte.Browse()

IGATiedEdge.ClearFlag(flag)

Clears a flag on the IGA Tied Edge To Edge

Parameters:

flag (Flag) – Flag to clear on the IGA Tied Edge To Edge

Returns:

No return value

Return type:

None

Example

To clear flag f for IGA Tied Edge To Edge igte:

igte.ClearFlag(f)

IGATiedEdge.Copy(range=Oasys.gRPC.defaultArg)

Copies the IGA Tied Edge To Edge. The target include of the copied IGA Tied Edge To Edge 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:

IGATiedEdge object

Return type:

IGATiedEdge

Example

To copy IGA Tied Edge To Edge igte into IGA Tied Edge To Edge z:

z = igte.Copy()

IGATiedEdge.DetachComment(comment)

Detaches a comment from a IGA Tied Edge To Edge

Parameters:

comment (Comment) – Comment that will be detached from the IGA Tied Edge To Edge

Returns:

No return value

Return type:

None

Example

To detach comment c from the IGA Tied Edge To Edge igte:

igte.DetachComment(c)

IGATiedEdge.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 Tied Edge To Edge igte:

igte.Edit()

IGATiedEdge.Flagged(flag)

Checks if the IGA Tied Edge To Edge is flagged or not

Parameters:

flag (Flag) – Flag to test on the IGA Tied Edge To Edge

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if IGA Tied Edge To Edge igte has flag f set on it:

if igte.Flagged(f):
    do_something..

IGATiedEdge.GetComments()

Extracts the comments associated to a IGA Tied Edge To Edge

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 Tied Edge To Edge igte:

comm_list = igte.GetComments()

IGATiedEdge.GetParameter(prop)

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

Parameters:

prop (string) – IGA Tied Edge To Edge property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

Parameter

Example

To check if IGATiedEdge property igte.example is a parameter:

Oasys.PRIMER.Options.property_parameter_names = True
if igte.GetParameter(igte.example):
    do_something...
Oasys.PRIMER.Options.property_parameter_names = False

To check if IGATiedEdge property igte.example is a parameter by using the GetParameter method:

if igte.ViewParameters().GetParameter(igte.example):
    do_something..

IGATiedEdge.Keyword()

Returns the keyword for this IGA tied edge to edge (*IGA_TIED_EDGE_TO_EDGE). Note that a carriage return is not added See also IGATiedEdge.KeywordCards()

Returns:

string containing the keyword

Return type:

str

Example

To ge the keyword for IGA tied edge to edge igte:

key = igte.Keyword()

IGATiedEdge.KeywordCards()

Returns the keyword cards for the IGA tied edge to edge. Note that a carriage return is not added See also IGATiedEdge.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for IGA tied edge to edge igte:

cards = igte.KeywordCards()

cards = igte.KeywordCards()

IGATiedEdge.Next()

Returns the next IGA Tied Edge To Edge in the model

Returns:

IGATiedEdge object (or None if there are no more IGA Tied Edge To Edges in the model)

Return type:

IGATiedEdge

Example

To get the IGA Tied Edge To Edge in model m after IGA Tied Edge To Edge igte:

igte = igte.Next()

IGATiedEdge.Previous()

Returns the previous IGA Tied Edge To Edge in the model

Returns:

IGATiedEdge object (or None if there are no more IGA Tied Edge To Edges in the model)

Return type:

IGATiedEdge

Example

To get the IGA Tied Edge To Edge in model m before IGA Tied Edge To Edge igte:

igte = igte.Previous()

IGATiedEdge.SetFlag(flag)

Sets a flag on the IGA Tied Edge To Edge

Parameters:

flag (Flag) – Flag to set on the IGA Tied Edge To Edge

Returns:

No return value

Return type:

None

Example

To set flag f for IGA Tied Edge To Edge igte:

igte.SetFlag(f)

IGATiedEdge.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:

IGATiedEdge object

Return type:

IGATiedEdge

Example

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

if igte.ViewParameters().GetParameter(igte.example):
    do_something..

IGATiedEdge.Xrefs()

Returns the cross references for this IGA Tied Edge To Edge

Returns:

Xrefs object

Return type:

Xrefs

Example

To get the cross references for IGA Tied Edge To Edge igte:

xrefs = igte.Xrefs()