Oasys.PRIMER.IGAFaceUVW class¶

Constants¶

IGAFaceUVW.BASIS_TRANSFORM¶

BASIS_TRANSFORM is *IGA_FACE_UVW_BASIS_TRANSFORM

IGAFaceUVW.NONE¶

NONE is *IGA_FACE_UVW

Properties¶

property IGAFaceUVW.elid: integer¶

Element ID local to a trivariate basis transform. Only for the BASIS_TRANSFORM keyword option

property IGAFaceUVW.entries(read only): integer¶

Number of Boundary representation IDs (brid) or Element IDs (elid) added in IGA_FACE_UVW. Can be used as index to add a new entry

property IGAFaceUVW.exists(read only): boolean¶

true if IGA Face UVW exists, false if referred to but not defined

property IGAFaceUVW.faceid: integer¶

Face ID. Only for the BASIS_TRANSFORM keyword option

property IGAFaceUVW.fid: integer¶

IGAFaceUVW number. Also see the label property which is an alternative name for this

property IGAFaceUVW.fxyzid: integer¶

Physical face ID. *IGA_FACE_XYZ

property IGAFaceUVW.include: integer¶

The Include file number that the IGA Face UVW is in

property IGAFaceUVW.label: integer¶

IGAFaceUVW number. Also see the fid property which is an alternative name for this

property IGAFaceUVW.model(read only): integer¶

The Model number that the IGA Face UVW is in

property IGAFaceUVW.option: constant¶

IGA Face UVW option. IGAFaceUVW.NONE or IGAFaceUVW.BASIS_TRANSFORM

property IGAFaceUVW.patchid: integer¶

Physical bivariate NURBS patch ID or a bivariate Basis Transform patch ID. Ignored for the BASIS_TRANSFORM keyword option

property IGAFaceUVW.sense: integer¶

Sense of orientation with respect to the physical face. Ignored for the BASIS_TRANSFORM keyword option

Constructor¶

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

Parameters:

model (Model) – Model that IGA face uvw will be created in

details (dict) –
Details for creating the IGAFaceUVW

elid (optional):

(integer) Element ID local to a trivariate basis transform

faceid (optional):

(integer) Face ID

fid:

(integer) ID of the IGA Face UVW

fxyzid (optional):

(integer) Physical face ID. *IGA_FACE_XYZ

option:

(constant) IGA Face UVW option. IGAFaceUVW.NONE or IGAFaceUVW.BASIS_TRANSFORM

patchid (optional):

(integer) Physical bivariate NURBS patch ID

sense (optional):

(integer) Sense of orientation with respect to the physical face

Returns:

IGAFaceUVW object

Return type:

IGAFaceUVW

Example

To create a new IGA face uvw in model m using fid 10 and option NONE with fxyzid 11, patchid 12 and sense 1:
igfu = Oasys.PRIMER.IGAFaceUVW(m, {'option':Oasys.PRIMER.IGAFaceUVW.NONE, 'fid':10, 'fxyzid':11, 'patchid':12, 'sense':1})
To create a new IGA face uvw in model m using fid 21 and option BASIS_TRANSFORM with elid 31, faceid 6:
igfu = Oasys.PRIMER.IGAFaceUVW(m, {'option':Oasys.PRIMER.IGAFaceUVW.BASIS_TRANSFORM, 'fid':21, 'elid': 31, 'faceid':6})

Static methods¶

classmethod IGAFaceUVW.Create(model, modal=Oasys.gRPC.defaultArg)¶
Starts an interactive editing panel to create a IGA Face UVW

Parameters:

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

IGAFaceUVW object (or None if not made)

Return type:

IGAFaceUVW

Example

To start creating a IGA Face UVW in model m:
igfu = Oasys.PRIMER.IGAFaceUVW.Create(m)
classmethod IGAFaceUVW.First(model)¶
Returns the first IGA Face UVW in the model

Parameters:

model (Model) – Model to get first IGA Face UVW in

Returns:

IGAFaceUVW object (or None if there are no IGA Face UVWs in the model)

Return type:

IGAFaceUVW

Example

To get the first IGA Face UVW in model m:
igfu = Oasys.PRIMER.IGAFaceUVW.First(m)
classmethod IGAFaceUVW.FirstFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the first free IGA Face UVW label in the model. Also see IGAFaceUVW.LastFreeLabel(), IGAFaceUVW.NextFreeLabel() and Model.FirstFreeItemLabel()

Parameters:

model (Model) – Model to get first free IGA Face UVW label in

layer (Include number) – Optional. Include file (0 for the main file) to search for labels in (Equivalent to First free in layer in editing panels). If omitted the whole model will be used (Equivalent to First free in editing panels)

Returns:

IGAFaceUVW label

Return type:

int

Example

To get the first free IGA Face UVW label in model m:
label = Oasys.PRIMER.IGAFaceUVW.FirstFreeLabel(m)
classmethod IGAFaceUVW.FlagAll(model, flag)¶
Flags all of the IGA Face UVWs in the model with a defined flag

Parameters:

model (Model) – Model that all IGA Face UVWs will be flagged in

flag (Flag) – Flag to set on the IGA Face UVWs

Returns:

No return value

Return type:

None

Example

To flag all of the IGA Face UVWs with flag f in model m:
Oasys.PRIMER.IGAFaceUVW.FlagAll(m, f)
classmethod IGAFaceUVW.GetAll(model, property=Oasys.gRPC.defaultArg)¶
Returns a list of IGAFaceUVW objects or properties for all of the IGA Face UVWs in a model in PRIMER. If the optional property argument is not given then a list of IGAFaceUVW objects is returned. If the property argument is given, that property value for each IGA Face UVW is returned in the list instead of a IGAFaceUVW object

Parameters:

model (Model) – Model to get IGA Face UVWs from

property (string) – Optional. Name for property to get for all IGA Face UVWs in the model

Returns:

List of IGAFaceUVW objects or properties

Return type:

list

Example

To make a list of IGAFaceUVW objects for all of the IGA Face UVWs in model m:
a = Oasys.PRIMER.IGAFaceUVW.GetAll(m)
To return a list containing the value of property ‘foo’ (for example ‘x’ for a node) for each IGA Face UVW in model m:
a = Oasys.PRIMER.IGAFaceUVW.GetAll(m, 'foo')
classmethod IGAFaceUVW.GetFlagged(model, flag, property=Oasys.gRPC.defaultArg)¶
Returns a list of IGAFaceUVW objects for all of the flagged IGA Face UVWs in a model in PRIMER If the optional property argument is not given then a list of IGAFaceUVW objects is returned. If the property argument is given, then that property value for each IGA Face UVW is returned in the list instead of a IGAFaceUVW object

Parameters:

model (Model) – Model to get IGA Face UVWs from

flag (Flag) – Flag set on the IGA Face UVWs that you want to retrieve

property (string) – Optional. Name for property to get for all flagged IGA Face UVWs in the model

Returns:

List of IGAFaceUVW objects or properties

Return type:

list

Example

To make a list of IGAFaceUVW objects for all of the IGA Face UVWs in model m flagged with f:
igfu = Oasys.PRIMER.IGAFaceUVW.GetFlagged(m, f)
To return a list containing the value of property ‘foo’ (for example ‘x’ for a node) for all of the IGA Face UVWs in model m flagged with f:
a = Oasys.PRIMER.IGAFaceUVW.GetFlagged(m, f, 'foo')
classmethod IGAFaceUVW.GetFromID(model, number)¶
Returns the IGAFaceUVW object for a IGA Face UVW ID

Parameters:

model (Model) – Model to find the IGA Face UVW in

number (integer) – number of the IGA Face UVW you want the IGAFaceUVW object for

Returns:

IGAFaceUVW object (or None if IGA Face UVW does not exist)

Return type:

IGAFaceUVW

Example

To get the IGAFaceUVW object for IGA Face UVW 100 in model m
igfu = Oasys.PRIMER.IGAFaceUVW.GetFromID(m, 100)
classmethod IGAFaceUVW.Last(model)¶
Returns the last IGA Face UVW in the model

Parameters:

model (Model) – Model to get last IGA Face UVW in

Returns:

IGAFaceUVW object (or None if there are no IGA Face UVWs in the model)

Return type:

IGAFaceUVW

Example

To get the last IGA Face UVW in model m:
igfu = Oasys.PRIMER.IGAFaceUVW.Last(m)
classmethod IGAFaceUVW.LastFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the last free IGA Face UVW label in the model. Also see IGAFaceUVW.FirstFreeLabel(), IGAFaceUVW.NextFreeLabel() and see Model.LastFreeItemLabel()

Parameters:

model (Model) – Model to get last free IGA Face UVW label in

layer (Include number) – Optional. Include file (0 for the main file) to search for labels in (Equivalent to Highest free in layer in editing panels). If omitted the whole model will be used

Returns:

IGAFaceUVW label

Return type:

int

Example

To get the last free IGA Face UVW label in model m:
label = Oasys.PRIMER.IGAFaceUVW.LastFreeLabel(m)
classmethod IGAFaceUVW.NextFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the next free (highest+1) IGA Face UVW label in the model. Also see IGAFaceUVW.FirstFreeLabel(), IGAFaceUVW.LastFreeLabel() and Model.NextFreeItemLabel()

Parameters:

model (Model) – Model to get next free IGA Face UVW label in

layer (Include number) – Optional. Include file (0 for the main file) to search for labels in (Equivalent to Highest+1 in layer in editing panels). If omitted the whole model will be used (Equivalent to Highest+1 in editing panels)

Returns:

IGAFaceUVW label

Return type:

int

Example

To get the next free IGA Face UVW label in model m:
label = Oasys.PRIMER.IGAFaceUVW.NextFreeLabel(m)
classmethod IGAFaceUVW.RenumberAll(model, start)¶
Renumbers all of the IGA Face UVWs in the model

Parameters:

model (Model) – Model that all IGA Face UVWs will be renumbered in

start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the IGA Face UVWs in model m, from 1000000:
Oasys.PRIMER.IGAFaceUVW.RenumberAll(m, 1000000)
classmethod IGAFaceUVW.RenumberFlagged(model, flag, start)¶
Renumbers all of the flagged IGA Face UVWs in the model

Parameters:

model (Model) – Model that all the flagged IGA Face UVWs will be renumbered in

flag (Flag) – Flag set on the IGA Face UVWs that you want to renumber

start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the IGA Face UVWs in model m flagged with f, from 1000000:
Oasys.PRIMER.IGAFaceUVW.RenumberFlagged(m, f, 1000000)
classmethod IGAFaceUVW.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)¶
Allows the user to select IGA Face UVWs using standard PRIMER object menus

Parameters:

flag (Flag) – Flag to use when selecting IGA Face UVWs

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

Return type:

int

Example

To select IGA Face UVWs from model m, flagging those selected with flag f, giving the prompt ‘Select IGA Face UVWs’:
Oasys.PRIMER.IGAFaceUVW.Select(f, 'Select IGA Face UVWs', m)
To select IGA Face UVWs, flagging those selected with flag f but limiting selection to IGA Face UVWs flagged with flag l, giving the prompt ‘Select IGA Face UVWs’:
Oasys.PRIMER.IGAFaceUVW.Select(f, 'Select IGA Face UVWs', l)
classmethod IGAFaceUVW.SketchFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)¶
Sketches all of the flagged IGA Face UVWs in the model. The IGA Face UVWs will be sketched until you either call IGAFaceUVW.Unsketch(), IGAFaceUVW.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

Parameters:

model (Model) – Model that all the flagged IGA Face UVWs will be sketched in

flag (Flag) – Flag set on the IGA Face UVWs that you want to sketch

redraw (boolean) – Optional. If model should be redrawn or not after the IGA Face UVWs are sketched. If omitted redraw is true. If you want to sketch flagged IGA Face UVWs 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 Face UVWs flagged with flag in model m:
Oasys.PRIMER.IGAFaceUVW.SketchFlagged(m, flag)
classmethod IGAFaceUVW.Total(model, exists=Oasys.gRPC.defaultArg)¶
Returns the total number of IGA Face UVWs in the model

Parameters:

model (Model) – Model to get total for

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

Returns:

number of IGA Face UVWs

Return type:

int

Example

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

Parameters:

model (Model) – Model that the defined flag for all IGA Face UVWs will be unset in

flag (Flag) – Flag to unset on the IGA Face UVWs

Returns:

No return value

Return type:

None

Example

To unset the flag f on all the IGA Face UVWs in model m:
Oasys.PRIMER.IGAFaceUVW.UnflagAll(m, f)
classmethod IGAFaceUVW.UnsketchAll(model, redraw=Oasys.gRPC.defaultArg)¶
Unsketches all IGA Face UVWs

Parameters:

model (Model) – Model that all IGA Face UVWs will be unblanked in

redraw (boolean) – Optional. If model should be redrawn or not after the IGA Face UVWs 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 Face UVWs in model m:
Oasys.PRIMER.IGAFaceUVW.UnsketchAll(m)
classmethod IGAFaceUVW.UnsketchFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)¶
Unsketches all flagged IGA Face UVWs in the model

Parameters:

model (Model) – Model that all IGA Face UVWs will be unsketched in

flag (Flag) – Flag set on the IGA Face UVWs that you want to unsketch

redraw (boolean) – Optional. If model should be redrawn or not after the IGA Face UVWs 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 Face UVWs flagged with flag in model m:
Oasys.PRIMER.IGAFaceUVW.UnsketchAll(m, flag)

Instance methods¶

IGAFaceUVW.AssociateComment(comment)¶
Associates a comment with a IGA Face UVW

Parameters:

comment (Comment) – Comment that will be attached to the IGA Face UVW

Returns:

No return value

Return type:

None

Example

To associate comment c to the IGA Face UVW igfu:
igfu.AssociateComment(c)
IGAFaceUVW.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 Face UVW igfu:
igfu.Browse()
IGAFaceUVW.ClearFlag(flag)¶
Clears a flag on the IGA Face UVW

Parameters:

flag (Flag) – Flag to clear on the IGA Face UVW

Returns:

No return value

Return type:

None

Example

To clear flag f for IGA Face UVW igfu:
igfu.ClearFlag(f)
IGAFaceUVW.Copy(range=Oasys.gRPC.defaultArg)¶
Copies the IGA Face UVW. The target include of the copied IGA Face UVW 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:

IGAFaceUVW object

Return type:

IGAFaceUVW

Example

To copy IGA Face UVW igfu into IGA Face UVW z:
z = igfu.Copy()
IGAFaceUVW.DetachComment(comment)¶
Detaches a comment from a IGA Face UVW

Parameters:

comment (Comment) – Comment that will be detached from the IGA Face UVW

Returns:

No return value

Return type:

None

Example

To detach comment c from the IGA Face UVW igfu:
igfu.DetachComment(c)
IGAFaceUVW.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 Face UVW igfu:
igfu.Edit()
IGAFaceUVW.Flagged(flag)¶
Checks if the IGA Face UVW is flagged or not

Parameters:

flag (Flag) – Flag to test on the IGA Face UVW

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if IGA Face UVW igfu has flag f set on it:
if igfu.Flagged(f):
    do_something..
IGAFaceUVW.GetComments()¶
Extracts the comments associated to a IGA Face UVW

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 Face UVW igfu:
comm_list = igfu.GetComments()
IGAFaceUVW.GetData(index)¶
Returns the data for brid in *IGA_FACE_UVW. Only valid for option IGAFaceUVW.NONE

Parameters:

index (integer) – Index you want the data for. Note that indices start at 0

Returns:

The ID of boundary representation or basis transform element depending on option

Return type:

int

Example

To get the 3rd data entry in IGA face uvw igfu:
data = igfu.GetData(2)
IGAFaceUVW.GetParameter(prop)¶
Checks if a IGAFaceUVW 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 IGAFaceUVW.ViewParameters() method and ‘method chaining’ (see the examples below)

Parameters:

prop (string) – IGA Face UVW property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

Parameter

Example

To check if IGAFaceUVW property igfu.example is a parameter:
Oasys.PRIMER.Options.property_parameter_names = True
if igfu.GetParameter(igfu.example):
    do_something...
Oasys.PRIMER.Options.property_parameter_names = False
To check if IGAFaceUVW property igfu.example is a parameter by using the GetParameter method:
if igfu.ViewParameters().GetParameter(igfu.example):
    do_something..
IGAFaceUVW.Keyword()¶
Returns the keyword for this IGA face uvw (*IGA_FACE_UVW). Note that a carriage return is not added. See also IGAFaceUVW.KeywordCards()

Returns:

string containing the keyword

Return type:

str

Example

To get the keyword for IGA face uvw igfu:
key = igfu.Keyword()
IGAFaceUVW.KeywordCards()¶
Returns the keyword cards for the IGA face uvw. Note that a carriage return is not added. See also IGAFaceUVW.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for IGA face uvw igfu:
cards = igfu.KeywordCards()
IGAFaceUVW.Next()¶
Returns the next IGA Face UVW in the model

Returns:

IGAFaceUVW object (or None if there are no more IGA Face UVWs in the model)

Return type:

IGAFaceUVW

Example

To get the IGA Face UVW in model m after IGA Face UVW igfu:
igfu = igfu.Next()
IGAFaceUVW.Previous()¶
Returns the previous IGA Face UVW in the model

Returns:

IGAFaceUVW object (or None if there are no more IGA Face UVWs in the model)

Return type:

IGAFaceUVW

Example

To get the IGA Face UVW in model m before IGA Face UVW igfu:
igfu = igfu.Previous()
IGAFaceUVW.RemoveData(index)¶
Removes brid/elid for an index in *IGA_FACE_UVW. Only valid for option IGAFaceUVW.NONE

Parameters:

index (integer) – The index you want to delete brid/elid for. Note that indices start at 0, not 1

Returns:

No return value

Return type:

None

Example

To delete the brid/elid for the 3rd index for *IGA_FACE_UVW in model m:
if igfu.entries >= 3:
    igfu.RemoveData(2)
IGAFaceUVW.SetData(index, brid)¶
Sets brid for *IGA_FACE_UVW. Only valid for option IGAFaceUVW.NONE

Parameters:

index (integer) – Index you want to set the brid/elid for. Note that indices start at 0

brid (integer) – The ID of 1 dimensional boundary representation

Returns:

No return value

Return type:

None

Example

To add an entry to the *IGA_FACE_UVW igfu with id 10 by using “entries” property to get the next available index:
i = igfu.entries
igfu.SetData(i, 10)
To change an entry in 3rd field for *IGA_FACE_UVW igfu with id 30:
igfu.SetData(2, 30)
IGAFaceUVW.SetFlag(flag)¶
Sets a flag on the IGA Face UVW

Parameters:

flag (Flag) – Flag to set on the IGA Face UVW

Returns:

No return value

Return type:

None

Example

To set flag f for IGA Face UVW igfu:
igfu.SetFlag(f)
IGAFaceUVW.Sketch(redraw=Oasys.gRPC.defaultArg)¶
Sketches the IGA Face UVW. The IGA Face UVW will be sketched until you either call IGAFaceUVW.Unsketch(), IGAFaceUVW.UnsketchAll(), Model.UnsketchAll(), or delete the model

Parameters:

redraw (boolean) – Optional. If model should be redrawn or not after the IGA Face UVW is sketched. If omitted redraw is true. If you want to sketch several IGA Face UVWs 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 Face UVW igfu:
igfu.Sketch()
IGAFaceUVW.Unsketch(redraw=Oasys.gRPC.defaultArg)¶
Unsketches the IGA Face UVW

Parameters:

redraw (boolean) – Optional. If model should be redrawn or not after the IGA Face UVW is unsketched. If omitted redraw is true. If you want to unsketch several IGA Face UVWs 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 Face UVW igfu:
igfu.Unsketch()
IGAFaceUVW.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:

IGAFaceUVW object

Return type:

IGAFaceUVW

Example

To check if IGAFaceUVW property igfu.example is a parameter by using the IGAFaceUVW.GetParameter() method:
if igfu.ViewParameters().GetParameter(igfu.example):
    do_something..
IGAFaceUVW.Xrefs()¶
Returns the cross references for this IGA Face UVW

Returns:

Xrefs object

Return type:

Xrefs

Example

To get the cross references for IGA Face UVW igfu:
xrefs = igfu.Xrefs()