Oasys.PRIMER.IGAFaceXYZ class¶

Constants¶

IGAFaceXYZ.BASIS_TRANSFORM¶

BASIS_TRANSFORM is *IGA_FACE_XYZ_BASIS_TRANSFORM

IGAFaceXYZ.NONE¶

NONE is *IGA_FACE_XYZ

Properties¶

property IGAFaceXYZ.entries(read only): integer¶

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

property IGAFaceXYZ.esid: integer¶

Parametric edge set ID. *SET_IGA_EDGE_UVW

property IGAFaceXYZ.exists(read only): boolean¶

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

property IGAFaceXYZ.fid: integer¶

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

property IGAFaceXYZ.include: integer¶

The Include file number that the IGA Face XYZ is in

property IGAFaceXYZ.label: integer¶

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

property IGAFaceXYZ.model(read only): integer¶

The Model number that the IGA Face XYZ is in

property IGAFaceXYZ.option: constant¶

IGA Face XYZ option. IGAFaceXYZ.NONE or IGAFaceXYZ.BASIS_TRANSFORM

property IGAFaceXYZ.ori: integer¶

Orientation with respect to the physical bivariate NURBS

property IGAFaceXYZ.patchid: integer¶

Physical bivariate NURBS patch ID or a bivariate Basis Transform patch ID

property IGAFaceXYZ.psid: integer¶

Parametric point set ID. *SET_IGA_POINT_UVW

Constructor¶

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

Parameters:

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

details (dict) –
Details for creating the IGAFaceXYZ

esid (optional):

(integer) Parametric edge set ID. *SET_IGA_EDGE_UVW

fid:

(integer) ID of the IGA Face XYZ

option:

(constant) IGA Face XYZ option. IGAFaceXYZ.NONE or IGAFaceXYZ.BASIS_TRANSFORM

ori (optional):

(integer) Orientation with respect to the physical bivariate NURBS

patchid (optional):

(integer) Physical bivariate NURBS patch ID or a bivariate basis transform patch ID

psid (optional):

(integer) Parametric point set ID. *SET_IGA_POINT_UVW

Returns:

IGAFaceXYZ object

Return type:

IGAFaceXYZ

Example

To create a new IGA face xyz in model m using fid 10 with option NONE:
igfx = Oasys.PRIMER.IGAFaceXYZ(m, {'option':Oasys.PRIMER.IGAFaceXYZ.NONE, 'fid':10})
To create a new IGA face xyz in model m using fid 21 and option BASIS_TRANSFORM with patch 22, ori 23, psid 24 and esid 25:
igfx = Oasys.PRIMER.IGAFaceXYZ(m, {'option':Oasys.PRIMER.IGAFaceXYZ.BASIS_TRANSFORM, 'fid':21, 'patchid': 22, 'ori':23, 'psid':24, 'esid':25})

Static methods¶

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

Parameters:

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

IGAFaceXYZ object (or None if not made)

Return type:

IGAFaceXYZ

Example

To start creating a IGA Face XYZ in model m:
igfx = Oasys.PRIMER.IGAFaceXYZ.Create(m)
classmethod IGAFaceXYZ.First(model)¶
Returns the first IGA Face XYZ in the model

Parameters:

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

Returns:

IGAFaceXYZ object (or None if there are no IGA Face XYZs in the model)

Return type:

IGAFaceXYZ

Example

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

Parameters:

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

IGAFaceXYZ label

Return type:

int

Example

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

Parameters:

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

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

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

Returns:

List of IGAFaceXYZ objects or properties

Return type:

list

Example

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

Parameters:

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

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

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

Returns:

List of IGAFaceXYZ objects or properties

Return type:

list

Example

To make a list of IGAFaceXYZ objects for all of the IGA Face XYZs in model m flagged with f:
igfx = Oasys.PRIMER.IGAFaceXYZ.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 XYZs in model m flagged with f:
a = Oasys.PRIMER.IGAFaceXYZ.GetFlagged(m, f, 'foo')
classmethod IGAFaceXYZ.GetFromID(model, number)¶
Returns the IGAFaceXYZ object for a IGA Face XYZ ID

Parameters:

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

number (integer) – number of the IGA Face XYZ you want the IGAFaceXYZ object for

Returns:

IGAFaceXYZ object (or None if IGA Face XYZ does not exist)

Return type:

IGAFaceXYZ

Example

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

Parameters:

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

Returns:

IGAFaceXYZ object (or None if there are no IGA Face XYZs in the model)

Return type:

IGAFaceXYZ

Example

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

Parameters:

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

IGAFaceXYZ label

Return type:

int

Example

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

Parameters:

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

IGAFaceXYZ label

Return type:

int

Example

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

Parameters:

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

Parameters:

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

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

Parameters:

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

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

Return type:

int

Example

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

Parameters:

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

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

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

Parameters:

model (Model) – Model to get total for

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

Returns:

number of IGA Face XYZs

Return type:

int

Example

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

Parameters:

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

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

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

Parameters:

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

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

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

Instance methods¶

IGAFaceXYZ.AssociateComment(comment)¶
Associates a comment with a IGA Face XYZ

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

IGAFaceXYZ object

Return type:

IGAFaceXYZ

Example

To copy IGA Face XYZ igfx into IGA Face XYZ z:
z = igfx.Copy()
IGAFaceXYZ.DetachComment(comment)¶
Detaches a comment from a IGA Face XYZ

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

Returns:

True if flagged, False if not

Return type:

bool

Example

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

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 XYZ igfx:
comm_list = igfx.GetComments()
IGAFaceXYZ.GetData(index)¶
Returns the data for brid/elid based on option in *IGA_FACE_XYZ

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 xyz igfx:
data = igfx.GetData(2)
IGAFaceXYZ.GetParameter(prop)¶
Checks if a IGAFaceXYZ 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 IGAFaceXYZ.ViewParameters() method and ‘method chaining’ (see the examples below)

Parameters:

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

Returns:

Parameter object if property is a parameter, None if not

Return type:

Parameter

Example

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

Returns:

string containing the keyword

Return type:

str

Example

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

Returns:

string containing the cards

Return type:

str

Example

To get the cards for IGA face xyz igfx:
cards = igfx.KeywordCards()
IGAFaceXYZ.Next()¶
Returns the next IGA Face XYZ in the model

Returns:

IGAFaceXYZ object (or None if there are no more IGA Face XYZs in the model)

Return type:

IGAFaceXYZ

Example

To get the IGA Face XYZ in model m after IGA Face XYZ igfx:
igfx = igfx.Next()
IGAFaceXYZ.Previous()¶
Returns the previous IGA Face XYZ in the model

Returns:

IGAFaceXYZ object (or None if there are no more IGA Face XYZs in the model)

Return type:

IGAFaceXYZ

Example

To get the IGA Face XYZ in model m before IGA Face XYZ igfx:
igfx = igfx.Previous()
IGAFaceXYZ.RemoveData(index)¶
Removes brid/elid for an index in *IGA_FACE_XYZ

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_XYZ in model m:
if igfx.entries >= 3:
    igfx.RemoveData(2)
IGAFaceXYZ.SetData(index, brid)¶
Sets brid/elid based on option for an *IGA_FACE_XYZ

Parameters:

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

brid (integer) – The ID of boundary representation or basis transform element depending on option

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

Parameters:

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

IGAFaceXYZ object

Return type:

IGAFaceXYZ

Example

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

Returns:

Xrefs object

Return type:

Xrefs

Example

To get the cross references for IGA Face XYZ igfx:
xrefs = igfx.Xrefs()