Oasys.PRIMER.Termination class¶

Constants¶

Direction for Degrees of Freedom (field: dof)¶

Termination.DOF_X¶

Degree of freedom in X direction for Force magnitude. Used for Termination.CONTACT

Termination.DOF_Y¶

Degree of freedom in Y direction for Force magnitude. Used for Termination.CONTACT

Termination.DOF_Z¶

Degree of freedom in Z direction for Force magnitude. Used for Termination.CONTACT

Global Direction for Stop Criterion (field: stop)¶

Termination.STOP_MAG¶

Stop if displacement magnitude is exceeded. Used for Termination.BODY or Termination.NODE

Termination.STOP_X¶

Stop criterion is in Global X direction. Used for Termination.BODY or Termination.NODE

Termination.STOP_Y¶

Stop criterion is in Global Y direction. Used for Termination.BODY or Termination.NODE

Termination.STOP_Z¶

Stop criterion is in Global X direction. Used for Termination.BODY or Termination.NODE

Type of Keyword¶

Termination.BODY¶

TERMINATION is *TERMINATION_BODY

Termination.CONTACT¶

TERMINATION is *TERMINATION_CONTACT

Termination.CURVE¶

TERMINATION is *TERMINATION_CURVE

Termination.DELETED_SHELLS¶

TERMINATION is *TERMINATION_DELETED_SHELLS

Termination.DELETED_SHELLS_SET¶

TERMINATION is *TERMINATION_DELETED_SHELLS_SET

Termination.DELETED_SOLIDS¶

TERMINATION is *TERMINATION_DELETED_SOLIDS

Termination.DELETED_SOLIDS_SET¶

TERMINATION is *TERMINATION_DELETED_SOLIDS_SET

Termination.NODE¶

TERMINATION is *TERMINATION_NODE

Termination.SENSOR¶

TERMINATION is *TERMINATION_SENSOR

Properties¶

property Termination.actTime: float¶

Activation time value. Used for Termination.CONTACT or Termination.CURVE

property Termination.dof: integer¶

Directions to consider for Force Magnitude. Valid values are: Termination.DOF_X or Termination.DOF_Y or Termination.DOF_Z. Used for Termination.CONTACT

property Termination.duration: float¶

Time duration of None resultant force prior to termination. Used for Termination.CONTACT

property Termination.exists(read only): boolean¶

true if termination exists, false if referred to but not defined

property Termination.id: integer¶

Can be Part or NRBC ID based on ptype value for Termination.BODY, OR Contact ID for Termination.CONTACT, OR Node ID for Termination.NODE, OR Curve ID for Termination.CURVE, OR Part for Termination.DELETED_SHELLS or Termination.DELETED_SOLIDS, OR Part Set ID for Termination.DELETED_SHELLS_SET or Termination.DELETED_SOLIDS_SET, OR Sensor Switch ID for Termination.SENSOR

property Termination.include: integer¶

The Include file number that the termination is in

property Termination.maxc: float¶

Maximum (most positive) displacement. If value is 0.0, it is set to 1.0e21. Value should be more than minc. Used for Termination.BODY or Termination.NODE

property Termination.minc: float¶

Minimum (most negative) displacement. If value is 0.0, it is set to -1.0e21. Value should be less than maxc. Used for Termination.BODY or Termination.NODE

property Termination.model(read only): integer¶

The Model number that the termination is in

property Termination.numDeletedElems: integer¶

Number of elements that must be deleted for the specified Part ID’s, before an error termination occurs. Used for Termination.DELETED_SHELLS_SET or Termination.DELETED_SOLIDS_SET

property Termination.ptype(read only): integer¶

Gives the type of Part for Termination.BODY. Values can be 0 for Part or 1 for NRBC

property Termination.stop: integer¶

Stop Criterion. Valid values are: Termination.STOP_X or Termination.STOP_Y or Termination.STOP_Z or Termination.STOP_MAG. Used for Termination.BODY or Termination.NODE

property Termination.threshold: float¶

Any measured force magnitude below or equal to this specified threshold is taken as a None force. Used for Termination.CONTACT

property Termination.type(read only): integer¶

Gives the type of *TERMINATION keyword

Constructor¶

classmethod Termination(model, type, id)¶
Create a new Termination object

Parameters:

model (Model) – Model that termination will be created in

type (constant) – Specify the type of Termination (Can be Termination.BODY or Termination.CONTACT or Termination.CURVE or Termination.DELETED_SHELLS or Termination.DELETED_SOLIDS or Termination.NODE or Termination.SENSOR)

id (integer) – Can be Part ID for Termination.BODY or Termination.DELETED_SHELLS or Termination.DELETED_SOLIDS, OR Contact ID for Termination.CONTACT, OR Node ID for Termination.NODE, OR Curve ID for Termination.CURVE, OR Part Set ID for Termination.DELETED_SHELLS_SET or Termination.DELETED_SOLIDS_SET, OR Sensor Switch ID for Termination.SENSOR

Returns:

Termination object

Return type:

dict

Example

To create a new termination in model m, type BODY, part id 100:
term = Oasys.PRIMER.Termination(m, Oasys.PRIMER.Termination.BODY, 100)

Static methods¶

classmethod Termination.Create(model, modal=Oasys.gRPC.defaultArg)¶
Starts an interactive editing panel to create an Termination definition

Parameters:

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

Termination object (or None if not made)

Return type:

dict

Example

To start creating an termination in model m:
term = Oasys.PRIMER.Termination.Create(m)
classmethod Termination.First(model)¶
Returns the first termination in the model

Parameters:

model (Model) – Model to get first termination in

Returns:

Termination object (or None if there are no terminations in the model)

Return type:

Termination

Example

To get the first termination in model m:
term = Oasys.PRIMER.Termination.First(m)
classmethod Termination.FlagAll(model, flag)¶
Flags all of the terminations in the model with a defined flag

Parameters:

model (Model) – Model that all terminations will be flagged in

flag (Flag) – Flag to set on the terminations

Returns:

No return value

Return type:

None

Example

To flag all of the terminations with flag f in model m:
Oasys.PRIMER.Termination.FlagAll(m, f)
classmethod Termination.GetAll(model)¶
Returns a list of Termination objects for all of the terminations in a model in PRIMER

Parameters:

model (Model) – Model to get terminations from

Returns:

List of Termination objects

Return type:

list

Example

To make a list of Termination objects for all of the terminations in model m
term = Oasys.PRIMER.Termination.GetAll(m)
classmethod Termination.GetFlagged(model, flag)¶
Returns a list of Termination objects for all of the flagged terminations in a model in PRIMER

Parameters:

model (Model) – Model to get terminations from

flag (Flag) – Flag set on the terminations that you want to retrieve

Returns:

List of Termination objects

Return type:

list

Example

To make a list of Termination objects for all of the terminations in model m flagged with f
term = Oasys.PRIMER.Termination.GetFlagged(m, f)
classmethod Termination.GetFromID(model, number)¶
Returns the Termination object for a termination ID

Parameters:

model (Model) – Model to find the termination in

number (integer) – number of the termination you want the Termination object for

Returns:

Termination object (or None if termination does not exist)

Return type:

Termination

Example

To get the Termination object for termination 100 in model m
term = Oasys.PRIMER.Termination.GetFromID(m, 100)
classmethod Termination.Last(model)¶
Returns the last termination in the model

Parameters:

model (Model) – Model to get last termination in

Returns:

Termination object (or None if there are no terminations in the model)

Return type:

Termination

Example

To get the last termination in model m:
term = Oasys.PRIMER.Termination.Last(m)
classmethod Termination.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)¶
Allows the user to select terminations using standard PRIMER object menus

Parameters:

flag (Flag) – Flag to use when selecting terminations

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

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

Return type:

int

Example

To select terminations from model m, flagging those selected with flag f, giving the prompt ‘Select terminations’:
Oasys.PRIMER.Termination.Select(f, 'Select terminations', m)
To select terminations, flagging those selected with flag f but limiting selection to terminations flagged with flag l, giving the prompt ‘Select terminations’:
Oasys.PRIMER.Termination.Select(f, 'Select terminations', l)
classmethod Termination.Total(model, exists=Oasys.gRPC.defaultArg)¶
Returns the total number of terminations in the model

Parameters:

model (Model) – Model to get total for

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

Returns:

number of terminations

Return type:

int

Example

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

Parameters:

model (Model) – Model that the defined flag for all terminations will be unset in

flag (Flag) – Flag to unset on the terminations

Returns:

No return value

Return type:

None

Example

To unset the flag f on all the terminations in model m:
Oasys.PRIMER.Termination.UnflagAll(m, f)

Instance methods¶

Termination.AssociateComment(comment)¶
Associates a comment with a termination

Parameters:

comment (Comment) – Comment that will be attached to the termination

Returns:

No return value

Return type:

None

Example

To associate comment c to the termination term:
term.AssociateComment(c)
Termination.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 termination term:
term.Browse()
Termination.ClearFlag(flag)¶
Clears a flag on the termination

Parameters:

flag (Flag) – Flag to clear on the termination

Returns:

No return value

Return type:

None

Example

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

Termination object

Return type:

Termination

Example

To copy termination term into termination z:
z = term.Copy()
Termination.DetachComment(comment)¶
Detaches a comment from a termination

Parameters:

comment (Comment) – Comment that will be detached from the termination

Returns:

No return value

Return type:

None

Example

To detach comment c from the termination term:
term.DetachComment(c)
Termination.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 termination term:
term.Edit()
Termination.Flagged(flag)¶
Checks if the termination is flagged or not

Parameters:

flag (Flag) – Flag to test on the termination

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if termination term has flag f set on it:
if term.Flagged(f):
    do_something..
Termination.GetComments()¶
Extracts the comments associated to a termination

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 termination term:
comm_list = term.GetComments()
Termination.GetParameter(prop)¶
Checks if a Termination 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 Termination.ViewParameters() method and ‘method chaining’ (see the examples below)

Parameters:

prop (string) – termination property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

dict

Example

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

Returns:

string containing the keyword

Return type:

str

Example

To get the keyword for Termination termination:
key = Oasys.PRIMER.Termination.Keyword()
Termination.KeywordCards()¶
Returns the keyword cards for the Termination. Note that a carriage return is not added. See also Termination.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for Termination termination:
cards = Oasys.PRIMER.Termination.KeywordCards()
Termination.Next()¶
Returns the next termination in the model

Returns:

Termination object (or None if there are no more terminations in the model)

Return type:

Termination

Example

To get the termination in model m after termination term:
term = term.Next()
Termination.Previous()¶
Returns the previous termination in the model

Returns:

Termination object (or None if there are no more terminations in the model)

Return type:

Termination

Example

To get the termination in model m before termination term:
term = term.Previous()
Termination.SetFlag(flag)¶
Sets a flag on the termination

Parameters:

flag (Flag) – Flag to set on the termination

Returns:

No return value

Return type:

None

Example

To set flag f for termination term:
term.SetFlag(f)
Termination.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:

Termination object

Return type:

dict

Example

To check if Termination property term.example is a parameter by using the Termination.GetParameter() method:
if term.ViewParameters().GetParameter(term.example):
    do_something..
Termination.Xrefs()¶
Returns the cross references for this termination

Returns:

Xrefs object

Return type:

dict

Example

To get the cross references for termination term:
xrefs = term.Xrefs()