Oasys.PRIMER.PrescribedAccelerometerRigid class¶

Properties¶

property PrescribedAccelerometerRigid.exists(read only): boolean¶

true if prescribed accelerometer rigid exists, false if referred to but not defined

property PrescribedAccelerometerRigid.include: integer¶

The Include file number that the prescribed accelerometer rigid is in

property PrescribedAccelerometerRigid.model(read only): integer¶

The Model number that the prescribed accelerometer rigid is in

property PrescribedAccelerometerRigid.nrow(read only): integer¶

Number of accelerometer cards

property PrescribedAccelerometerRigid.pid: integer¶

Part ID for rigid body whose motion is prescribed

property PrescribedAccelerometerRigid.solv: integer¶

Solver type: 1 for Gaussian elimination or 2 for linear regression

Constructor¶

classmethod PrescribedAccelerometerRigid(model, pid, solv=Oasys.gRPC.defaultArg)¶
Create a new PrescribedAccelerometerRigid object

Parameters:

model (Model) – Model that prescribed accelerometer rigid will be created in

pid (integer) – Part ID for rigid body whose motion is prescribed

solv (integer) – Optional. Solver type

Returns:

PrescribedAccelerometerRigid object

Return type:

dict

Example

To create a new prescribed accelerometer rigid in model m with part ID 10 and solver type 2 (linear regression):
par = Oasys.PRIMER.PrescribedAccelerometerRigid(m, 10, 2)

Static methods¶

classmethod PrescribedAccelerometerRigid.Create(model, modal=Oasys.gRPC.defaultArg)¶
Starts an interactive editing panel to create a boundary prescribed accelerometer rigid definition

Parameters:

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

PrescribedAccelerometerRigid object (or None if not made)

Return type:

dict

Example

To start creating a boundary prescribed accelerometer rigid definition in model m:
par = Oasys.PRIMER.PrescribedAccelerometerRigid.Create(m)
classmethod PrescribedAccelerometerRigid.First(model)¶
Returns the first prescribed accelerometer rigid in the model

Parameters:

model (Model) – Model to get first prescribed accelerometer rigid in

Returns:

PrescribedAccelerometerRigid object (or None if there are no prescribed accelerometer rigids in the model)

Return type:

PrescribedAccelerometerRigid

Example

To get the first prescribed accelerometer rigid in model m:
par = Oasys.PRIMER.PrescribedAccelerometerRigid.First(m)
classmethod PrescribedAccelerometerRigid.FlagAll(model, flag)¶
Flags all of the prescribed accelerometer rigids in the model with a defined flag

Parameters:

model (Model) – Model that all prescribed accelerometer rigids will be flagged in

flag (Flag) – Flag to set on the prescribed accelerometer rigids

Returns:

No return value

Return type:

None

Example

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

Parameters:

model (Model) – Model to get prescribed accelerometer rigids from

Returns:

List of PrescribedAccelerometerRigid objects

Return type:

list

Example

To make a list of PrescribedAccelerometerRigid objects for all of the prescribed accelerometer rigids in model m
par = Oasys.PRIMER.PrescribedAccelerometerRigid.GetAll(m)
classmethod PrescribedAccelerometerRigid.GetFlagged(model, flag)¶
Returns a list of PrescribedAccelerometerRigid objects for all of the flagged prescribed accelerometer rigids in a model in PRIMER

Parameters:

model (Model) – Model to get prescribed accelerometer rigids from

flag (Flag) – Flag set on the prescribed accelerometer rigids that you want to retrieve

Returns:

List of PrescribedAccelerometerRigid objects

Return type:

list

Example

To make a list of PrescribedAccelerometerRigid objects for all of the prescribed accelerometer rigids in model m flagged with f
par = Oasys.PRIMER.PrescribedAccelerometerRigid.GetFlagged(m, f)
classmethod PrescribedAccelerometerRigid.GetFromID(model, number)¶
Returns the PrescribedAccelerometerRigid object for a prescribed accelerometer rigid ID

Parameters:

model (Model) – Model to find the prescribed accelerometer rigid in

number (integer) – number of the prescribed accelerometer rigid you want the PrescribedAccelerometerRigid object for

Returns:

PrescribedAccelerometerRigid object (or None if prescribed accelerometer rigid does not exist)

Return type:

PrescribedAccelerometerRigid

Example

To get the PrescribedAccelerometerRigid object for prescribed accelerometer rigid 100 in model m
par = Oasys.PRIMER.PrescribedAccelerometerRigid.GetFromID(m, 100)
classmethod PrescribedAccelerometerRigid.Last(model)¶
Returns the last prescribed accelerometer rigid in the model

Parameters:

model (Model) – Model to get last prescribed accelerometer rigid in

Returns:

PrescribedAccelerometerRigid object (or None if there are no prescribed accelerometer rigids in the model)

Return type:

PrescribedAccelerometerRigid

Example

To get the last prescribed accelerometer rigid in model m:
par = Oasys.PRIMER.PrescribedAccelerometerRigid.Last(m)
classmethod PrescribedAccelerometerRigid.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)¶
Allows the user to select prescribed accelerometer rigids using standard PRIMER object menus

Parameters:

flag (Flag) – Flag to use when selecting prescribed accelerometer rigids

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

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

Return type:

int

Example

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

Parameters:

model (Model) – Model to get total for

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

Returns:

number of prescribed accelerometer rigids

Return type:

int

Example

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

Parameters:

model (Model) – Model that the defined flag for all prescribed accelerometer rigids will be unset in

flag (Flag) – Flag to unset on the prescribed accelerometer rigids

Returns:

No return value

Return type:

None

Example

To unset the flag f on all the prescribed accelerometer rigids in model m:
Oasys.PRIMER.PrescribedAccelerometerRigid.UnflagAll(m, f)

Instance methods¶

PrescribedAccelerometerRigid.AssociateComment(comment)¶
Associates a comment with a prescribed accelerometer rigid

Parameters:

comment (Comment) – Comment that will be attached to the prescribed accelerometer rigid

Returns:

No return value

Return type:

None

Example

To associate comment c to the prescribed accelerometer rigid par:
par.AssociateComment(c)
PrescribedAccelerometerRigid.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 prescribed accelerometer rigid par:
par.Browse()
PrescribedAccelerometerRigid.ClearFlag(flag)¶
Clears a flag on the prescribed accelerometer rigid

Parameters:

flag (Flag) – Flag to clear on the prescribed accelerometer rigid

Returns:

No return value

Return type:

None

Example

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

PrescribedAccelerometerRigid object

Return type:

PrescribedAccelerometerRigid

Example

To copy prescribed accelerometer rigid par into prescribed accelerometer rigid z:
z = par.Copy()
PrescribedAccelerometerRigid.DetachComment(comment)¶
Detaches a comment from a prescribed accelerometer rigid

Parameters:

comment (Comment) – Comment that will be detached from the prescribed accelerometer rigid

Returns:

No return value

Return type:

None

Example

To detach comment c from the prescribed accelerometer rigid par:
par.DetachComment(c)
PrescribedAccelerometerRigid.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 prescribed accelerometer rigid par:
par.Edit()
PrescribedAccelerometerRigid.Flagged(flag)¶
Checks if the prescribed accelerometer rigid is flagged or not

Parameters:

flag (Flag) – Flag to test on the prescribed accelerometer rigid

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if prescribed accelerometer rigid par has flag f set on it:
if par.Flagged(f):
    do_something..
PrescribedAccelerometerRigid.GetComments()¶
Extracts the comments associated to a prescribed accelerometer rigid

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 prescribed accelerometer rigid par:
comm_list = par.GetComments()
PrescribedAccelerometerRigid.GetParameter(prop)¶
Checks if a PrescribedAccelerometerRigid 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 PrescribedAccelerometerRigid.ViewParameters() method and ‘method chaining’ (see the examples below)

Parameters:

prop (string) – prescribed accelerometer rigid property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

dict

Example

To check if PrescribedAccelerometerRigid property par.example is a parameter:
Oasys.PRIMER.Options.property_parameter_names = True
if par.GetParameter(par.example):
    do_something...
Oasys.PRIMER.Options.property_parameter_names = False
To check if PrescribedAccelerometerRigid property par.example is a parameter by using the GetParameter method:
if par.ViewParameters().GetParameter(par.example):
    do_something..
PrescribedAccelerometerRigid.GetRow(row)¶
Returns the data for a row in the prescribed accelerometer rigid

Parameters:

row (integer) – The row you want the data for. Note row indices start at 0

Returns:

A list of numbers containing the row variables NID, CID, LCIDX, LCIDY and LCIDZ

Return type:

list

Example

To get the data for the 2nd row in prescribed accelerometer rigid par:
data = par.GetRow(1)
PrescribedAccelerometerRigid.Keyword()¶
Returns the keyword for this prescribed accelerometer rigid. Note that a carriage return is not added. See also PrescribedAccelerometerRigid.KeywordCards()

Returns:

string containing the keyword

Return type:

str

Example

To get the keyword for prescribed accelerometer rigid par:
key = par.Keyword()
PrescribedAccelerometerRigid.KeywordCards()¶
Returns the keyword cards for the prescribed accelerometer rigid. Note that a carriage return is not added. See also PrescribedAccelerometerRigid.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for prescribed accelerometer rigid par:
cards = par.KeywordCards()
PrescribedAccelerometerRigid.Next()¶
Returns the next prescribed accelerometer rigid in the model

Returns:

PrescribedAccelerometerRigid object (or None if there are no more prescribed accelerometer rigids in the model)

Return type:

PrescribedAccelerometerRigid

Example

To get the prescribed accelerometer rigid in model m after prescribed accelerometer rigid par:
par = par.Next()
PrescribedAccelerometerRigid.Previous()¶
Returns the previous prescribed accelerometer rigid in the model

Returns:

PrescribedAccelerometerRigid object (or None if there are no more prescribed accelerometer rigids in the model)

Return type:

PrescribedAccelerometerRigid

Example

To get the prescribed accelerometer rigid in model m before prescribed accelerometer rigid par:
par = par.Previous()
PrescribedAccelerometerRigid.RemoveRow(row)¶
Removes the data for a row in *BOUNDARY_PRESCRIBED_ACCELEROMETER_RIGID

Parameters:

row (integer) – The row you want to remove the data for. Note that row indices start at 0

Returns:

No return value

Return type:

None

Example

To remove the second row of data for prescribed accelerometer rigid par:
par.RemoveRow(1)
PrescribedAccelerometerRigid.SetFlag(flag)¶
Sets a flag on the prescribed accelerometer rigid

Parameters:

flag (Flag) – Flag to set on the prescribed accelerometer rigid

Returns:

No return value

Return type:

None

Example

To set flag f for prescribed accelerometer rigid par:
par.SetFlag(f)
PrescribedAccelerometerRigid.SetRow(row, data)¶
Sets the data for a row in *BOUNDARY_PRESCRIBED_ACCELEROMETER_RIGID

Parameters:

row (integer) – The row you want to set the data for. Note that row indices start at 0

data (List of data) – The data you want to set the row to

Returns:

No return value

Return type:

None

Example

To set the second row of data for prescribed accelerometer rigid par to be node 11, coordinate system 12, and load curves 13, 14, 15:
list_of_data = [11, 12, 13, 14, 15]
par.SetRow(1, list_of_data)
To append a new row of data (using the same list of values):
par.SetRow(par.nrow, list)
PrescribedAccelerometerRigid.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:

PrescribedAccelerometerRigid object

Return type:

dict

Example

To check if PrescribedAccelerometerRigid property par.example is a parameter by using the PrescribedAccelerometerRigid.GetParameter() method:
if par.ViewParameters().GetParameter(par.example):
    do_something..
PrescribedAccelerometerRigid.Xrefs()¶
Returns the cross references for this prescribed accelerometer rigid

Returns:

Xrefs object

Return type:

dict

Example

To get the cross references for prescribed accelerometer rigid par:
xrefs = par.Xrefs()