Oasys.PRIMER.IGAPointUVW class¶

Constants¶

IGAPointUVW.BASIS_TRANSFORM¶

BASIS_TRANSFORM is *IGA_POINT_UVW_BASIS_TRANSFORM

IGAPointUVW.NONE¶

NONE is *IGA_POINT_UVW

Properties¶

property IGAPointUVW.elid: integer¶

Element ID local to a basis transform

property IGAPointUVW.exists(read only): boolean¶

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

property IGAPointUVW.include: integer¶

The Include file number that the IGA Point UVW is in

property IGAPointUVW.label: integer¶

IGAPointUVW number. Also see the pid property which is an alternative name for this

property IGAPointUVW.model(read only): integer¶

The Model number that the IGA Point UVW is in

property IGAPointUVW.nid: integer¶

Node ID

property IGAPointUVW.option: constant¶

IGA Edge UVW option. IGAPointUVW.NONE or IGAPointUVW.BASIS_TRANSFORM

property IGAPointUVW.pid: integer¶

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

property IGAPointUVW.u: float¶

Coordinates in the parametric u-direction

property IGAPointUVW.v: float¶

Coordinates in the parametric v-direction

property IGAPointUVW.w: float¶

Coordinates in the parametric w-direction

Constructor¶

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

Parameters:

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

details (dict) –
Details for creating the IGAPointUVW

nid:

(integer) Node ID

option (optional):

(constant) IGA Point UVW option. IGAPointUVW.NONE or IGAPointUVW.BASIS_TRANSFORM

pid:

(integer) ID of the IGA Point UVW

u (optional):

(float) Coordinates in the parametric u-direction

v (optional):

(float) Coordinates in the parametric v-direction

w (optional):

(float) Coordinates in the parametric w-direction

Returns:

IGAPointUVW object

Return type:

IGAPointUVW

Example

To create a new IGA point uvw in model m using pid 10 and node 100:
igpu = Oasys.PRIMER.IGAPointUVW((m, {'pid': 10, 'nid':100})
To create a new IGA point uvw in model m using pid 20 with node 200 and option BASIS_TRANSFORM and parametric coordinates u, v, w, as 3.3, 4.4, 5.5, elid 15 respectively:
igpu = Oasys.PRIMER.IGAPointUVW((m, {'option':Oasys.PRIMER.IGAPointUVW.BASIS_TRANSFORM, 'pid': 20, 'nid': 200, 'u': 3.3, 'v': 4.4, 'w': 5.5, 'elid':15})

Static methods¶

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

Parameters:

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

IGAPointUVW object (or None if not made)

Return type:

IGAPointUVW

Example

To start creating a IGA Point UVW in model m:
igpu = Oasys.PRIMER.IGAPointUVW.Create(m)
classmethod IGAPointUVW.First(model)¶
Returns the first IGA Point UVW in the model

Parameters:

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

Returns:

IGAPointUVW object (or None if there are no IGA Point UVWs in the model)

Return type:

IGAPointUVW

Example

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

Parameters:

model (Model) – Model to get first free IGA Point 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:

IGAPointUVW label

Return type:

int

Example

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

Parameters:

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

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

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

Returns:

List of IGAPointUVW objects or properties

Return type:

list

Example

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

Parameters:

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

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

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

Returns:

List of IGAPointUVW objects or properties

Return type:

list

Example

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

Parameters:

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

number (integer) – number of the IGA Point UVW you want the IGAPointUVW object for

Returns:

IGAPointUVW object (or None if IGA Point UVW does not exist)

Return type:

IGAPointUVW

Example

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

Parameters:

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

Returns:

IGAPointUVW object (or None if there are no IGA Point UVWs in the model)

Return type:

IGAPointUVW

Example

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

Parameters:

model (Model) – Model to get last free IGA Point 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:

IGAPointUVW label

Return type:

int

Example

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

Parameters:

model (Model) – Model to get next free IGA Point 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:

IGAPointUVW label

Return type:

int

Example

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

Parameters:

model (Model) – Model that all IGA Point 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 Point UVWs in model m, from 1000000:
Oasys.PRIMER.IGAPointUVW.RenumberAll(m, 1000000)
classmethod IGAPointUVW.RenumberFlagged(model, flag, start)¶
Renumbers all of the flagged IGA Point UVWs in the model

Parameters:

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

flag (Flag) – Flag set on the IGA Point 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 Point UVWs in model m flagged with f, from 1000000:
Oasys.PRIMER.IGAPointUVW.RenumberFlagged(m, f, 1000000)
classmethod IGAPointUVW.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)¶
Allows the user to select IGA Point UVWs using standard PRIMER object menus

Parameters:

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

Return type:

int

Example

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

Parameters:

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

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

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

Parameters:

model (Model) – Model to get total for

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

Returns:

number of IGA Point UVWs

Return type:

int

Example

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

Parameters:

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

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

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

Parameters:

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

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

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

Instance methods¶

IGAPointUVW.AssociateComment(comment)¶
Associates a comment with a IGA Point UVW

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

IGAPointUVW object

Return type:

IGAPointUVW

Example

To copy IGA Point UVW igpu into IGA Point UVW z:
z = igpu.Copy()
IGAPointUVW.DetachComment(comment)¶
Detaches a comment from a IGA Point UVW

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if IGA Point UVW igpu has flag f set on it:
if igpu.Flagged(f):
    do_something..
IGAPointUVW.GetComments()¶
Extracts the comments associated to a IGA Point 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 Point UVW igpu:
comm_list = igpu.GetComments()
IGAPointUVW.GetParameter(prop)¶
Checks if a IGAPointUVW 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 IGAPointUVW.ViewParameters() method and ‘method chaining’ (see the examples below)

Parameters:

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

Returns:

Parameter object if property is a parameter, None if not

Return type:

Parameter

Example

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

Returns:

string containing the keyword

Return type:

str

Example

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

Returns:

string containing the cards

Return type:

str

Example

To get the cards for IGA point uvw igpu:
cards = igpu.KeywordCards()
IGAPointUVW.Next()¶
Returns the next IGA Point UVW in the model

Returns:

IGAPointUVW object (or None if there are no more IGA Point UVWs in the model)

Return type:

IGAPointUVW

Example

To get the IGA Point UVW in model m after IGA Point UVW igpu:
igpu = igpu.Next()
IGAPointUVW.Previous()¶
Returns the previous IGA Point UVW in the model

Returns:

IGAPointUVW object (or None if there are no more IGA Point UVWs in the model)

Return type:

IGAPointUVW

Example

To get the IGA Point UVW in model m before IGA Point UVW igpu:
igpu = igpu.Previous()
IGAPointUVW.SetFlag(flag)¶
Sets a flag on the IGA Point UVW

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

Parameters:

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

IGAPointUVW object

Return type:

IGAPointUVW

Example

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

Returns:

Xrefs object

Return type:

Xrefs

Example

To get the cross references for IGA Point UVW igpu:
xrefs = igpu.Xrefs()