Oasys.PRIMER.PrescribedFinalGeometry class

Properties

property PrescribedFinalGeometry.bpfgid: integer

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

property PrescribedFinalGeometry.deathd: float

Default death time

property PrescribedFinalGeometry.exists(read only): boolean

true if boundary prescribed final_geometry exists, false if referred to but not defined

property PrescribedFinalGeometry.id: integer

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

property PrescribedFinalGeometry.include: integer

The Include file number that the boundary prescribed final_geometry is in

property PrescribedFinalGeometry.label: integer

PrescribedFinalGeometry number. Also see the bpfgid property which is an alternative name for this

property PrescribedFinalGeometry.lcidf: integer

Default loadcurve number

property PrescribedFinalGeometry.lines(read only): integer

Number of lines of nodal data on the card

property PrescribedFinalGeometry.model(read only): integer

The Model number that the boundary prescribed final geometry is in

Constructor

classmethod PrescribedFinalGeometry(model, bpfgid)

Create a new PrescribedFinalGeometry object

Parameters:

  • model (Model) – Model that PrescribedFinalGeometry will be created in

  • bpfgid (PrescribedFinalGeometry) – PrescribedFinalGeometry number

Returns:

PrescribedFinalGeometry object

Return type:

dict

Example

To create a new final geometry 99 in model m

b = Oasys.PRIMER.PrescribedFinalGeometry(m, 99)

Static methods

classmethod PrescribedFinalGeometry.BlankAll(model, redraw=Oasys.gRPC.defaultArg)

Blanks all of the boundary prescribed final geometrys in the model

Parameters:

  • model (Model) – Model that all boundary prescribed final geometrys will be blanked in

  • redraw (boolean) – Optional. If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw()

Returns:

No return value

Return type:

None

Example

To blank all of the boundary prescribed final geometrys in model m:

Oasys.PRIMER.PrescribedFinalGeometry.BlankAll(m)
classmethod PrescribedFinalGeometry.BlankFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)

Blanks all of the flagged boundary prescribed final geometrys in the model

Parameters:

  • model (Model) – Model that all the flagged boundary prescribed final geometrys will be blanked in

  • flag (Flag) – Flag set on the boundary prescribed final geometrys that you want to blank

  • redraw (boolean) – Optional. If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw()

Returns:

No return value

Return type:

None

Example

To blank all of the boundary prescribed final geometrys in model m flagged with f:

Oasys.PRIMER.PrescribedFinalGeometry.BlankFlagged(m, f)
classmethod PrescribedFinalGeometry.Create(model, modal=Oasys.gRPC.defaultArg)

Starts an interactive editing panel to create a bpfg

Parameters:

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

PrescribedFinalGeometry object (or None if not made)

Return type:

dict

Example

To start creating a bpfg n in model m:

n = Oasys.PRIMER.PrescribedFinalGeometry.Create(m)
classmethod PrescribedFinalGeometry.First(model)

Returns the first boundary prescribed final geometry in the model

Parameters:

model (Model) – Model to get first boundary prescribed final geometry in

Returns:

PrescribedFinalGeometry object (or None if there are no boundary prescribed final geometrys in the model)

Return type:

PrescribedFinalGeometry

Example

To get the first boundary prescribed final geometry in model m:

b = Oasys.PRIMER.PrescribedFinalGeometry.First(m)
classmethod PrescribedFinalGeometry.FirstFreeLabel(model, layer=Oasys.gRPC.defaultArg)

Returns the first free boundary prescribed final geometry label in the model. Also see PrescribedFinalGeometry.LastFreeLabel(), PrescribedFinalGeometry.NextFreeLabel() and Model.FirstFreeItemLabel()

Parameters:

  • model (Model) – Model to get first free boundary prescribed final geometry 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:

PrescribedFinalGeometry label

Return type:

int

Example

To get the first free boundary prescribed final geometry label in model m:

label = Oasys.PRIMER.PrescribedFinalGeometry.FirstFreeLabel(m)
classmethod PrescribedFinalGeometry.FlagAll(model, flag)

Flags all of the boundary prescribed final geometrys in the model with a defined flag

Parameters:

  • model (Model) – Model that all boundary prescribed final geometrys will be flagged in

  • flag (Flag) – Flag to set on the boundary prescribed final geometrys

Returns:

No return value

Return type:

None

Example

To flag all of the boundary prescribed final geometrys with flag f in model m:

Oasys.PRIMER.PrescribedFinalGeometry.FlagAll(m, f)
classmethod PrescribedFinalGeometry.GetAll(model)

Returns a list of PrescribedFinalGeometry objects for all of the boundary prescribed final geometrys in a model in PRIMER

Parameters:

model (Model) – Model to get boundary prescribed final geometrys from

Returns:

List of PrescribedFinalGeometry objects

Return type:

list

Example

To make a list of PrescribedFinalGeometry objects for all of the boundary prescribed final geometrys in model m

b = Oasys.PRIMER.PrescribedFinalGeometry.GetAll(m)
classmethod PrescribedFinalGeometry.GetFlagged(model, flag)

Returns a list of PrescribedFinalGeometry objects for all of the flagged boundary prescribed final geometrys in a model in PRIMER

Parameters:

  • model (Model) – Model to get boundary prescribed final geometrys from

  • flag (Flag) – Flag set on the boundary prescribed final geometrys that you want to retrieve

Returns:

List of PrescribedFinalGeometry objects

Return type:

list

Example

To make a list of PrescribedFinalGeometry objects for all of the boundary prescribed final geometrys in model m flagged with f

b = Oasys.PRIMER.PrescribedFinalGeometry.GetFlagged(m, f)
classmethod PrescribedFinalGeometry.GetFromID(model, number)

Returns the PrescribedFinalGeometry object for a boundary prescribed final geometry ID

Parameters:

  • model (Model) – Model to find the boundary prescribed final geometry in

  • number (integer) – number of the boundary prescribed final geometry you want the PrescribedFinalGeometry object for

Returns:

PrescribedFinalGeometry object (or None if boundary prescribed final geometry does not exist)

Return type:

PrescribedFinalGeometry

Example

To get the PrescribedFinalGeometry object for boundary prescribed final geometry 100 in model m

b = Oasys.PRIMER.PrescribedFinalGeometry.GetFromID(m, 100)
classmethod PrescribedFinalGeometry.Last(model)

Returns the last boundary prescribed final geometry in the model

Parameters:

model (Model) – Model to get last boundary prescribed final geometry in

Returns:

PrescribedFinalGeometry object (or None if there are no boundary prescribed final geometrys in the model)

Return type:

PrescribedFinalGeometry

Example

To get the last boundary prescribed final geometry in model m:

b = Oasys.PRIMER.PrescribedFinalGeometry.Last(m)
classmethod PrescribedFinalGeometry.LastFreeLabel(model, layer=Oasys.gRPC.defaultArg)

Returns the last free boundary prescribed final geometry label in the model. Also see PrescribedFinalGeometry.FirstFreeLabel(), PrescribedFinalGeometry.NextFreeLabel() and see Model.LastFreeItemLabel()

Parameters:

  • model (Model) – Model to get last free boundary prescribed final geometry 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:

PrescribedFinalGeometry label

Return type:

int

Example

To get the last free boundary prescribed final geometry label in model m:

label = Oasys.PRIMER.PrescribedFinalGeometry.LastFreeLabel(m)
classmethod PrescribedFinalGeometry.NextFreeLabel(model, layer=Oasys.gRPC.defaultArg)

Returns the next free (highest+1) boundary prescribed final geometry label in the model. Also see PrescribedFinalGeometry.FirstFreeLabel(), PrescribedFinalGeometry.LastFreeLabel() and Model.NextFreeItemLabel()

Parameters:

  • model (Model) – Model to get next free boundary prescribed final geometry 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:

PrescribedFinalGeometry label

Return type:

int

Example

To get the next free boundary prescribed final geometry label in model m:

label = Oasys.PRIMER.PrescribedFinalGeometry.NextFreeLabel(m)
classmethod PrescribedFinalGeometry.Pick(prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg, button_text=Oasys.gRPC.defaultArg)

Allows the user to pick a boundary prescribed final geometry

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 boundary prescribed final geometrys from that model can be picked. If the argument is a Flag then only boundary prescribed final geometrys that are flagged with limit can be selected. If omitted, or None, any boundary prescribed final geometrys 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:

PrescribedFinalGeometry object (or None if not picked)

Return type:

dict

Example

To pick a boundary prescribed final geometry from model m giving the prompt ‘Pick boundary prescribed final geometry from screen’:

b = Oasys.PRIMER.PrescribedFinalGeometry.Pick('Pick boundary prescribed final geometry from screen', m)
classmethod PrescribedFinalGeometry.RenumberAll(model, start)

Renumbers all of the boundary prescribed final geometrys in the model

Parameters:

  • model (Model) – Model that all boundary prescribed final geometrys will be renumbered in

  • start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the boundary prescribed final geometrys in model m, from 1000000:

Oasys.PRIMER.PrescribedFinalGeometry.RenumberAll(m, 1000000)
classmethod PrescribedFinalGeometry.RenumberFlagged(model, flag, start)

Renumbers all of the flagged boundary prescribed final geometrys in the model

Parameters:

  • model (Model) – Model that all the flagged boundary prescribed final geometrys will be renumbered in

  • flag (Flag) – Flag set on the boundary prescribed final geometrys that you want to renumber

  • start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the boundary prescribed final geometrys in model m flagged with f, from 1000000:

Oasys.PRIMER.PrescribedFinalGeometry.RenumberFlagged(m, f, 1000000)
classmethod PrescribedFinalGeometry.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)

Allows the user to select boundary prescribed final geometrys using standard PRIMER object menus

Parameters:

  • flag (Flag) – Flag to use when selecting boundary prescribed final geometrys

  • prompt (string) – Text to display as a prompt to the user

  • limit (Model or Flag) – Optional. If the argument is a Model then only boundary prescribed final geometrys from that model can be selected. If the argument is a Flag then only boundary prescribed final geometrys that are flagged with limit can be selected (limit should be different to flag). If omitted, or None, any boundary prescribed final geometrys 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 boundary prescribed final geometrys selected or None if menu cancelled

Return type:

int

Example

To select boundary prescribed final geometrys from model m, flagging those selected with flag f, giving the prompt ‘Select boundary prescribed final geometrys’:

Oasys.PRIMER.PrescribedFinalGeometry.Select(f, 'Select boundary prescribed final geometrys', m)

To select boundary prescribed final geometrys, flagging those selected with flag f but limiting selection to boundary prescribed final geometrys flagged with flag l, giving the prompt ‘Select boundary prescribed final geometrys’:

Oasys.PRIMER.PrescribedFinalGeometry.Select(f, 'Select boundary prescribed final geometrys', l)
classmethod PrescribedFinalGeometry.SketchFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)

Sketches all of the flagged boundary prescribed final geometrys in the model. The boundary prescribed final geometrys will be sketched until you either call PrescribedFinalGeometry.Unsketch(), PrescribedFinalGeometry.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

Parameters:

  • model (Model) – Model that all the flagged boundary prescribed final geometrys will be sketched in

  • flag (Flag) – Flag set on the boundary prescribed final geometrys that you want to sketch

  • redraw (boolean) – Optional. If model should be redrawn or not after the boundary prescribed final geometrys are sketched. If omitted redraw is true. If you want to sketch flagged boundary prescribed final geometrys 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 boundary prescribed final geometrys flagged with flag in model m:

Oasys.PRIMER.PrescribedFinalGeometry.SketchFlagged(m, flag)
classmethod PrescribedFinalGeometry.Total(model, exists=Oasys.gRPC.defaultArg)

Returns the total number of boundary prescribed final geometrys in the model

Parameters:

  • model (Model) – Model to get total for

  • exists (boolean) – Optional. true if only existing boundary prescribed final geometrys should be counted. If false or omitted referenced but undefined boundary prescribed final geometrys will also be included in the total

Returns:

number of boundary prescribed final geometrys

Return type:

int

Example

To get the total number of boundary prescribed final geometrys in model m:

total = Oasys.PRIMER.PrescribedFinalGeometry.Total(m)
classmethod PrescribedFinalGeometry.UnblankAll(model, redraw=Oasys.gRPC.defaultArg)

Unblanks all of the boundary prescribed final geometrys in the model

Parameters:

  • model (Model) – Model that all boundary prescribed final geometrys will be unblanked in

  • redraw (boolean) – Optional. If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw()

Returns:

No return value

Return type:

None

Example

To unblank all of the boundary prescribed final geometrys in model m:

Oasys.PRIMER.PrescribedFinalGeometry.UnblankAll(m)
classmethod PrescribedFinalGeometry.UnblankFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)

Unblanks all of the flagged boundary prescribed final geometrys in the model

Parameters:

  • model (Model) – Model that the flagged boundary prescribed final geometrys will be unblanked in

  • flag (Flag) – Flag set on the boundary prescribed final geometrys that you want to unblank

  • redraw (boolean) – Optional. If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw()

Returns:

No return value

Return type:

None

Example

To unblank all of the boundary prescribed final geometrys in model m flagged with f:

Oasys.PRIMER.PrescribedFinalGeometry.UnblankFlagged(m, f)
classmethod PrescribedFinalGeometry.UnflagAll(model, flag)

Unsets a defined flag on all of the boundary prescribed final geometrys in the model

Parameters:

  • model (Model) – Model that the defined flag for all boundary prescribed final geometrys will be unset in

  • flag (Flag) – Flag to unset on the boundary prescribed final geometrys

Returns:

No return value

Return type:

None

Example

To unset the flag f on all the boundary prescribed final geometrys in model m:

Oasys.PRIMER.PrescribedFinalGeometry.UnflagAll(m, f)
classmethod PrescribedFinalGeometry.UnsketchAll(model, redraw=Oasys.gRPC.defaultArg)

Unsketches all boundary prescribed final geometrys

Parameters:

  • model (Model) – Model that all boundary prescribed final geometrys will be unblanked in

  • redraw (boolean) – Optional. If model should be redrawn or not after the boundary prescribed final geometrys 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 boundary prescribed final geometrys in model m:

Oasys.PRIMER.PrescribedFinalGeometry.UnsketchAll(m)
classmethod PrescribedFinalGeometry.UnsketchFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)

Unsketches all flagged boundary prescribed final geometrys in the model

Parameters:

  • model (Model) – Model that all boundary prescribed final geometrys will be unsketched in

  • flag (Flag) – Flag set on the boundary prescribed final geometrys that you want to unsketch

  • redraw (boolean) – Optional. If model should be redrawn or not after the boundary prescribed final geometrys 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 boundary prescribed final geometrys flagged with flag in model m:

Oasys.PRIMER.PrescribedFinalGeometry.UnsketchAll(m, flag)

Instance methods

PrescribedFinalGeometry.AssociateComment(comment)

Associates a comment with a boundary prescribed final geometry

Parameters:

comment (Comment) – Comment that will be attached to the boundary prescribed final geometry

Returns:

No return value

Return type:

None

Example

To associate comment c to the boundary prescribed final geometry b:

b.AssociateComment(c)
PrescribedFinalGeometry.Blank()

Blanks the boundary prescribed final geometry

Returns:

No return value

Return type:

None

Example

To blank boundary prescribed final geometry b:

b.Blank()
PrescribedFinalGeometry.Blanked()

Checks if the boundary prescribed final geometry is blanked or not

Returns:

True if blanked, False if not

Return type:

bool

Example

To check if boundary prescribed final geometry b is blanked:

if b.Blanked():
    do_something..
PrescribedFinalGeometry.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 boundary prescribed final geometry b:

b.Browse()
PrescribedFinalGeometry.ClearFlag(flag)

Clears a flag on the boundary prescribed final geometry

Parameters:

flag (Flag) – Flag to clear on the boundary prescribed final geometry

Returns:

No return value

Return type:

None

Example

To clear flag f for boundary prescribed final geometry b:

b.ClearFlag(f)
PrescribedFinalGeometry.Copy(range=Oasys.gRPC.defaultArg)

Copies the boundary prescribed final geometry. The target include of the copied boundary prescribed final geometry 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:

PrescribedFinalGeometry object

Return type:

PrescribedFinalGeometry

Example

To copy boundary prescribed final geometry b into boundary prescribed final geometry z:

z = b.Copy()
PrescribedFinalGeometry.DetachComment(comment)

Detaches a comment from a boundary prescribed final geometry

Parameters:

comment (Comment) – Comment that will be detached from the boundary prescribed final geometry

Returns:

No return value

Return type:

None

Example

To detach comment c from the boundary prescribed final geometry b:

b.DetachComment(c)
PrescribedFinalGeometry.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 boundary prescribed final geometry b:

b.Edit()
PrescribedFinalGeometry.Flagged(flag)

Checks if the boundary prescribed final geometry is flagged or not

Parameters:

flag (Flag) – Flag to test on the boundary prescribed final geometry

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if boundary prescribed final geometry b has flag f set on it:

if b.Flagged(f):
    do_something..
PrescribedFinalGeometry.GetComments()

Extracts the comments associated to a boundary prescribed final geometry

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 boundary prescribed final geometry b:

comm_list = b.GetComments()
PrescribedFinalGeometry.GetData(index)

Returns data for open-ended cards for a given row number in *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY

Parameters:

index (integer) – Index of open-ended card you want the data for. Note that indices start at 0, not 1.
0 <= index < lines

Returns:

A list containing data (NID, X, Y, Z, LCID, DEATH)

Return type:

list

Example

To get the data for the 3rd open-ended row for boundary prescribed final geometry b:

data = b.GetData(2)
PrescribedFinalGeometry.GetParameter(prop)

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

Parameters:

prop (string) – boundary prescribed final geometry property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

dict

Example

To check if PrescribedFinalGeometry property b.example is a parameter:

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

To check if PrescribedFinalGeometry property b.example is a parameter by using the GetParameter method:

if b.ViewParameters().GetParameter(b.example):
    do_something..
PrescribedFinalGeometry.Keyword()

Returns the keyword for this PrescribedFinalGeometry (*BOUNDARY_PRESCRIBED_FINAL_GEOMETRY). Note that a carriage return is not added. See also PrescribedFinalGeometry.KeywordCards()

Returns:

string containing the keyword

Return type:

str

Example

To get the keyword for PrescribedFinalGeometry bfg:

key = bfg.Keyword()
PrescribedFinalGeometry.KeywordCards()

Returns the keyword cards for the PrescribedFinalGeometry. Note that a carriage return is not added. See also PrescribedFinalGeometry.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for PrescribedFinalGeometry bfg:

cards = bfg.KeywordCards()
PrescribedFinalGeometry.Next()

Returns the next boundary prescribed final geometry in the model

Returns:

PrescribedFinalGeometry object (or None if there are no more boundary prescribed final geometrys in the model)

Return type:

PrescribedFinalGeometry

Example

To get the boundary prescribed final geometry in model m after boundary prescribed final geometry b:

b = b.Next()
PrescribedFinalGeometry.Previous()

Returns the previous boundary prescribed final geometry in the model

Returns:

PrescribedFinalGeometry object (or None if there are no more boundary prescribed final geometrys in the model)

Return type:

PrescribedFinalGeometry

Example

To get the boundary prescribed final geometry in model m before boundary prescribed final geometry b:

b = b.Previous()
PrescribedFinalGeometry.RemoveData(index)

Removes a line of data for a *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY

Parameters:

index (Integer) – The index of the *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY data to remove. Note that indices start at 0, not 1.
0 <= index < lines

Returns:

No return value

Return type:

None

Example

To remove row 2 (indices start with 0) of open-ended cards for *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY b:

b.RemoveData(1)
PrescribedFinalGeometry.SetData(index, nid, x, y, z, lcid=Oasys.gRPC.defaultArg, death=Oasys.gRPC.defaultArg)

Sets a line of data for a *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY

Parameters:

  • index (Integer) – The index of the *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY data to set. Note that indices start at 0, not 1.
    0 <= index <= lines

  • nid (integer) – Node or negative node set number

  • x (float) – X coordinates of final geometry

  • y (float) – Y coordinates of final geometry

  • z (float) – Z coordinates of final geometry

  • lcid (integer) – Optional. Loadcurve number

  • death (float) – Optional. Death time

Returns:

No return value

Return type:

None

Example

To set values for row 2 (indices start with 0) of open-ended cards for *BOUNDARY_PRESCRIBED_FINAL_GEOMETRY b with the following specification: nid, x, y, z, lcid, death are 99, 0.1, 0.2, 0.3, 88, 100.0 respectively

b.SetData(1, 99, 0.1, 0.2, 0.3, 88, 100.0)

To append a new line of data (using the same example values):

b.SetData(b.lines, 99, 0.1, 0.2, 0.3, 88, 100.0)
PrescribedFinalGeometry.SetFlag(flag)

Sets a flag on the boundary prescribed final geometry

Parameters:

flag (Flag) – Flag to set on the boundary prescribed final geometry

Returns:

No return value

Return type:

None

Example

To set flag f for boundary prescribed final geometry b:

b.SetFlag(f)
PrescribedFinalGeometry.Sketch(redraw=Oasys.gRPC.defaultArg)

Sketches the boundary prescribed final geometry. The boundary prescribed final geometry will be sketched until you either call PrescribedFinalGeometry.Unsketch(), PrescribedFinalGeometry.UnsketchAll(), Model.UnsketchAll(), or delete the model

Parameters:

redraw (boolean) – Optional. If model should be redrawn or not after the boundary prescribed final geometry is sketched. If omitted redraw is true. If you want to sketch several boundary prescribed final geometrys 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 boundary prescribed final geometry b:

b.Sketch()
PrescribedFinalGeometry.Unblank()

Unblanks the boundary prescribed final geometry

Returns:

No return value

Return type:

None

Example

To unblank boundary prescribed final geometry b:

b.Unblank()
PrescribedFinalGeometry.Unsketch(redraw=Oasys.gRPC.defaultArg)

Unsketches the boundary prescribed final geometry

Parameters:

redraw (boolean) – Optional. If model should be redrawn or not after the boundary prescribed final geometry is unsketched. If omitted redraw is true. If you want to unsketch several boundary prescribed final geometrys 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 boundary prescribed final geometry b:

b.Unsketch()
PrescribedFinalGeometry.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:

PrescribedFinalGeometry object

Return type:

dict

Example

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

if b.ViewParameters().GetParameter(b.example):
    do_something..
PrescribedFinalGeometry.Xrefs()

Returns the cross references for this boundary prescribed final geometry

Returns:

Xrefs object

Return type:

dict

Example

To get the cross references for boundary prescribed final geometry b:

xrefs = b.Xrefs()