Oasys.PRIMER.FreqVibration class¶

Constants¶

FreqVibration.FATIGUE¶

FreqVibration option for *FREQUENCY_DOMAIN_RANDOM_VIBRATION_FATIGUE

FreqVibration.VIBRATION¶

FreqVibration option for *FREQUENCY_DOMAIN_RANDOM_VIBRATION

Properties¶

property FreqVibration.dampf: float¶

Modal damping coefficient

property FreqVibration.dmpmas: float¶

Mass proportional damping constant in Rayleigh damping

property FreqVibration.dmpstf: float¶

Stiffness proportional damping constant in Rayleigh damping

property FreqVibration.dmptyp: integer¶

Tytpe of Damping

property FreqVibration.exists(read only): boolean¶

true if *FREQUENCY_DOMAIN_RANDOM_VIBRATION exists, false if referred to but not defined

property FreqVibration.fnmax: float¶

The maximum natural frequency in modal superposition method (optional)

property FreqVibration.fnmin: float¶

The minimum natural frequency in modal superposition method (optional)

property FreqVibration.icoarse: integer¶

Option for PSD curve coarsening

property FreqVibration.include: integer¶

The Include file number that the *FREQUENCY_DOMAIN_RANDOM_VIBRATION is in

property FreqVibration.inftg: integer¶

Flag for including initial damage ratio

property FreqVibration.ipanelu: integer¶

Number of strips in U-direction (used only for vaflag = 5,6,7)

property FreqVibration.ipanelv: integer¶

Number of strips in V-direction (used only for vaflag = 5,6,7)

property FreqVibration.label(read only): integer¶

The label the *FREQUENCY_DOMAIN_RANDOM_VIBRATION has in PRIMER

property FreqVibration.lcdam: integer¶

Load Curve ID defining mode dependent modal damping coefficient

property FreqVibration.lctyp: integer¶

Type of load curve defining modal damping coefficient

property FreqVibration.ldflag: integer¶

Type of loading curves

property FreqVibration.ldtyp: Integer¶

Excitation load type

property FreqVibration.mdmax: integer¶

The last mode in modal superposition method (optional)

property FreqVibration.mdmin: integer¶

The first mode in modal superposition method (optional)

property FreqVibration.method: integer¶

Method for modal response analysis

property FreqVibration.mftg: integer¶

Method for random fatigue analysis

property FreqVibration.model(read only): integer¶

The Model number that the *FREQUENCY_DOMAIN_RANDOM_VIBRATION is in

property FreqVibration.napsd: integer¶

Number of auto PSD load definition

property FreqVibration.ncpsd: integer¶

Number of cross PSD load definition

property FreqVibration.nftg: integer¶

Field specifying the number of S-N curves to be defined

property FreqVibration.option: constant¶

The *FREQUENCY_DOMAIN_RANDOM_VIBRATION option. Can be FreqVibration.VIBRATION, FreqVibration.FATIGUE

property FreqVibration.pref: float¶

Reference pressure

property FreqVibration.restrm: integer¶

Restart option

property FreqVibration.restrt: integer¶

Restart option

property FreqVibration.strsf: float¶

Stress scale factor to accommodate different ordinates in S-N curve (not used if nftg = -999)

property FreqVibration.strtyp: integer¶

Stress type of S-N curve in fatigue analysis

property FreqVibration.tcoarse: float¶

Tolerance for slope change percentage for removing intermediate points from PSD curve for icoarse = 2

property FreqVibration.temper: float¶

Temperature

property FreqVibration.texpos: float¶

Exposure time

property FreqVibration.umlt: float¶

Multiplier for converting g to [length unit]/[time unit]^2 (used only for UNIT = -1)

property FreqVibration.unit: integer¶

Flag for acceleration unit conversion

property FreqVibration.vaflag: integer¶

Loading type

property FreqVibration.vapsd: integer¶

Flag for PSD output

property FreqVibration.varms: integer¶

Flag for RMS output

Constructor¶

classmethod FreqVibration(model, option)¶
Create a new FreqVibration object

Parameters:

model (Model) – Model that *FREQUENCY_DOMAIN_RANDOM_VIBRATION will be created in

option (constant) – Specify the type of *FREQUENCY_DOMAIN_RANDOM_VIBRATION. Can be FreqVibration.VIBRATION, FreqVibration.FATIGUE

Returns:

FreqVibration object

Return type:

dict

Example

To create a new *FREQUENCY_DOMAIN_RANDOM_VIBRATION in model m, of type FATIGUE
f = Oasys.PRIMER.FreqVibration(m, Oasys.PRIMER.FreqVibration.FATIGUE)

Static methods¶

classmethod FreqVibration.Create(model, modal=Oasys.gRPC.defaultArg)¶
Starts an interactive editing panel to create a *FREQUENCY_DOMAIN_RANDOM_VIBRATION card

Parameters:

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

FreqVibration object (or None if not made)

Return type:

dict

Example

To start creating a *FREQUENCY_DOMAIN_RANDOM_VIBRATION card in model m:
f = Oasys.PRIMER.FreqVibration.Create(m)
classmethod FreqVibration.First(model)¶
Returns the first *FREQUENCY_DOMAIN_RANDOM_VIBRATION in the model

Parameters:

model (Model) – Model to get first *FREQUENCY_DOMAIN_RANDOM_VIBRATION in

Returns:

FreqVibration object (or None if there are no *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs in the model)

Return type:

FreqVibration

Example

To get the first *FREQUENCY_DOMAIN_RANDOM_VIBRATION in model m:
f = Oasys.PRIMER.FreqVibration.First(m)
classmethod FreqVibration.FlagAll(model, flag)¶
Flags all of the *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs in the model with a defined flag

Parameters:

model (Model) – Model that all *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs will be flagged in

flag (Flag) – Flag to set on the *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs

Returns:

No return value

Return type:

None

Example

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

Parameters:

model (Model) – Model to get *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs from

Returns:

List of FreqVibration objects

Return type:

list

Example

To make a list of FreqVibration objects for all of the *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs in model m
f = Oasys.PRIMER.FreqVibration.GetAll(m)
classmethod FreqVibration.GetAutoPsdLoadData(index)¶
Returns the Auto PSD load data for a specific Auto PSD Load definition as a list. For each Auto PSD load definition there will be 8 values. There are napsd Auto PSD load definitions.

Parameters:

index (integer) – Index you want the Auto PSD load data for. Note that indices start at 0

Returns:

A list containing the Auto PSD load data (values: sid[integer], stype[integer], dof[integer], ldpsd[integer], ldvel[integer], ldflw[integer], ldspn[integer], cid[integer]). The list length will be 8

Return type:

list

Example

To get the data for the 3rd Auto PSD load data for *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
apsd_data = f.GetAutoPsdLoadData(2)
classmethod FreqVibration.GetCrossPsdLoadData(index)¶
Returns the Cross PSD load data for a specific Cross PSD Load definition as a list. For each Cross PSD load definition there will be 5 values. There are ncpsd Cross PSD load definitions.

Parameters:

index (integer) – Index you want the Cross PSD load data for. Note that indices start at 0

Returns:

A list containing the Cross PSD load data (values: load_i[integer], load_j[integer], lctyp2[integer], ldpsd1[integer], ldpsd2[integer]). The list length will be 5

Return type:

list

Example

To get the data for the 3rd Cross PSD load data for *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
cpsd_data = f.GetCrossPsdLoadData(2)
classmethod FreqVibration.GetFlagged(model, flag)¶
Returns a list of FreqVibration objects for all of the flagged *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs in a model in PRIMER

Parameters:

model (Model) – Model to get *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs from

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

Returns:

List of FreqVibration objects

Return type:

list

Example

To make a list of FreqVibration objects for all of the *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs in model m flagged with f
f = Oasys.PRIMER.FreqVibration.GetFlagged(m, f)
classmethod FreqVibration.GetFromID(model, number)¶
Returns the FreqVibration object for a *FREQUENCY_DOMAIN_RANDOM_VIBRATION ID

Parameters:

model (Model) – Model to find the *FREQUENCY_DOMAIN_RANDOM_VIBRATION in

number (integer) – number of the *FREQUENCY_DOMAIN_RANDOM_VIBRATION you want the FreqVibration object for

Returns:

FreqVibration object (or None if *FREQUENCY_DOMAIN_RANDOM_VIBRATION does not exist)

Return type:

FreqVibration

Example

To get the FreqVibration object for *FREQUENCY_DOMAIN_RANDOM_VIBRATION 100 in model m
f = Oasys.PRIMER.FreqVibration.GetFromID(m, 100)
classmethod FreqVibration.GetInftgData(index)¶
Returns the path and filename of a binary database for fatigue information from a specific initial damage card. There are inftg filenames. This method is only applicable when option is FreqVibration.FATIGUE.

Parameters:

index (integer) – Index of an initial damage card that you want the filename from. Note that indices start at 0

Returns:

Return value from an initial damage card (values: filename[string])

Return type:

str

Example

To get the filename from the 2nd initial damage card for *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
fdata = f.GetInftgData(1)
classmethod FreqVibration.GetSNCurveData(index)¶
Returns the data of a specific zone for fatigue analysis as a list. For each zone there will be 8 values. There are nftg zone definitions for fatigue analysis. This method is only applicable when option is FreqVibration.FATIGUE.

Parameters:

index (integer) – Index you want the zone data for. Note that indices start at 0

Returns:

An list containing the zone data (values: pid[integer], lcid[integer], ptype[integer], ltype[integer], a[float], b[float], sthres[float], snlimt[integer]). The array length will be 8.

Return type:

int

Example

To get the data for the 4th zone for *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
sndata = f.GetSNCurveData(3)
classmethod FreqVibration.Last(model)¶
Returns the last *FREQUENCY_DOMAIN_RANDOM_VIBRATION in the model

Parameters:

model (Model) – Model to get last *FREQUENCY_DOMAIN_RANDOM_VIBRATION in

Returns:

FreqVibration object (or None if there are no *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs in the model)

Return type:

FreqVibration

Example

To get the last *FREQUENCY_DOMAIN_RANDOM_VIBRATION in model m:
f = Oasys.PRIMER.FreqVibration.Last(m)
classmethod FreqVibration.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)¶
Allows the user to select *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs using standard PRIMER object menus

Parameters:

flag (Flag) – Flag to use when selecting *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs

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

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

Return type:

int

Example

To select *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs from model m, flagging those selected with flag f, giving the prompt ‘Select *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs’:
Oasys.PRIMER.FreqVibration.Select(f, 'Select \*FREQUENCY_DOMAIN_RANDOM_VIBRATIONs', m)
To select *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs, flagging those selected with flag f but limiting selection to *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs flagged with flag l, giving the prompt ‘Select *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs’:
Oasys.PRIMER.FreqVibration.Select(f, 'Select \*FREQUENCY_DOMAIN_RANDOM_VIBRATIONs', l)
classmethod FreqVibration.SetAutoPsdLoadData(index, data)¶
Set the data for a specific Auto PSD load card. For each Auto PSD load card there will be 8 values. There are napsd Auto PSD load cards.

Parameters:

index (integer) – Index you want to set Auto PSD load data for. Note that indices start at 0

data (List of data) – An list containing the Auto PSD load data (values: sid[integer], stype[integer], dof[integer], ldpsd[integer], ldvel[integer], ldflw[integer], ldspn[integer], cid[integer]). The array length should be 8

Returns:

No return value

Return type:

None

Example

To set the 3rd Auto PSD load data for *FREQUENCY_DOMAIN_RANDOM_VIBRATION f to the values in list adata:
f.SetAutoPsdLoadData(2, adata)
classmethod FreqVibration.SetCrossPsdLoadData(index, data)¶
Set the data for a specific Cross PSD load card. For each Cross PSD load card there will be 5 values. There are ncpsd Cross PSD load cards.

Parameters:

index (integer) – Index you want to set Cross PSD load data for. Note that indices start at 0

data (List of data) – An list containing the Cross PSD load data (values: load_i[integer], load_j[integer], lctyp2[integer], ldpsd1[integer], ldpsd2[integer]). The array length should be 5

Returns:

No return value

Return type:

None

Example

To set the 4th Cross PSD load data for *FREQUENCY_DOMAIN_RANDOM_VIBRATION f to the values in list cdata:
f.SetCrossPsdLoadData(2, cdata)
classmethod FreqVibration.SetInftgData(index, filename)¶
Set the filename data for an existing binary database for fatigue infromation for a specific initial damage card. There are inftg filenames. This method is only applicable when option is FreqVibration.FATIGUE.

Parameters:

index (integer) – Index of an initial damage card that you want the filename for. Note that indices start at 0

filename (string) – Path and name of existing binary database fro fatigue information

Returns:

No return value

Return type:

None

Example

To set the file name for the 2nd initial damage card of *FREQUENCY_DOMAIN_RANDOM_VIBRATION f to have filename “d3ftg”:
f.SetInftgData(1, "d3ftg")
classmethod FreqVibration.SetSNCurveData(index, data)¶
Set the data for a specific zone for fatigue analysis. For each zone there will be 8 values. There are nftg zone definitions for fatigue analysis. This method is only applicable when option is FreqVibration.FATIGUE

Parameters:

index (integer) – Index you want to set the fatigue analysis zone data for. Note that indices start at 0

data (List of data) – An list containing the zone data (values: pid[integer], lcid[integer], ptype[integer], ltype[integer], a[float], b[float], sthres[float], snlimt[integer]). The array length will be 8

Returns:

No return value

Return type:

None

Example

To set the data for 4th fatigue analysis zone in *FREQUENCY_DOMAIN_RANDOM_VIBRATION f to the values in list sndata:
f.SetSNCurveData(3, sndata)
classmethod FreqVibration.Total(model, exists=Oasys.gRPC.defaultArg)¶
Returns the total number of *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs in the model

Parameters:

model (Model) – Model to get total for

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

Returns:

number of *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs

Return type:

int

Example

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

Parameters:

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

flag (Flag) – Flag to unset on the *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs

Returns:

No return value

Return type:

None

Example

To unset the flag f on all the *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs in model m:
Oasys.PRIMER.FreqVibration.UnflagAll(m, f)

Instance methods¶

FreqVibration.AddAutoPsdLoadData()¶
Allows user to add a new Auto PSD load card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION. The new card has uninitialised fields and should be updated by FreqVibration.SetAutoPsdLoadData().

Returns:

Index of the new auto PSD load

Return type:

integer

Example

To add a new auto PSD load data card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f.AddAutoPsdLoadData()
FreqVibration.AddCrossPsdLoadData()¶
Allows user to add a new Cross PSD load card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION. The new card has uninitialised fields and should be updated by FreqVibration.SetCrossPsdLoadData().

Returns:

Index of the new cross PSD load

Return type:

integer

Example

To add a new cross PSD load data card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f.AddCrossPsdLoadData()
FreqVibration.AddInftgData()¶
Allows user to add new Initial Damage cards in *FREQUENCY_DOMAIN_RANDOM_VIBRATION. This method is only applicable when option is FreqVibration.FATIGUE. The new cards have uninitialised fields and should be updated by FreqVibration.SetInftgData().

Returns:

Index of the new initial damage card

Return type:

integer

Example

To add a new initial damage card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f.AddInftgData()
FreqVibration.AddSNCurveData()¶
Allows user to add new S-N curve cards in *FREQUENCY_DOMAIN_RANDOM_VIBRATION. This method is only applicable when option is FreqVibration.FATIGUE. The new cards have uninitialised fields and should be updated by FreqVibration.SetSNCurveData().

Returns:

Index of the new S-N curve card

Return type:

integer

Example

To add a new S-N curve card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f.AddSNCurveData()
FreqVibration.AssociateComment(comment)¶
Associates a comment with a *FREQUENCY_DOMAIN_RANDOM_VIBRATION

Parameters:

comment (Comment) – Comment that will be attached to the *FREQUENCY_DOMAIN_RANDOM_VIBRATION

Returns:

No return value

Return type:

None

Example

To associate comment c to the *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f.AssociateComment(c)
FreqVibration.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 *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f.Browse()
FreqVibration.ClearFlag(flag)¶
Clears a flag on the *FREQUENCY_DOMAIN_RANDOM_VIBRATION

Parameters:

flag (Flag) – Flag to clear on the *FREQUENCY_DOMAIN_RANDOM_VIBRATION

Returns:

No return value

Return type:

None

Example

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

FreqVibration object

Return type:

FreqVibration

Example

To copy *FREQUENCY_DOMAIN_RANDOM_VIBRATION f into *FREQUENCY_DOMAIN_RANDOM_VIBRATION z:
z = f.Copy()
FreqVibration.DetachComment(comment)¶
Detaches a comment from a *FREQUENCY_DOMAIN_RANDOM_VIBRATION

Parameters:

comment (Comment) – Comment that will be detached from the *FREQUENCY_DOMAIN_RANDOM_VIBRATION

Returns:

No return value

Return type:

None

Example

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

Parameters:

flag (Flag) – Flag to test on the *FREQUENCY_DOMAIN_RANDOM_VIBRATION

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if *FREQUENCY_DOMAIN_RANDOM_VIBRATION f has flag f set on it:
if f.Flagged(f):
    do_something..
FreqVibration.GetComments()¶
Extracts the comments associated to a *FREQUENCY_DOMAIN_RANDOM_VIBRATION

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

Parameters:

prop (string) – *FREQUENCY_DOMAIN_RANDOM_VIBRATION property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

dict

Example

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

Returns:

string containing the keyword

Return type:

str

Example

To get the keyword for *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
key = f.Keyword()
FreqVibration.KeywordCards()¶
Returns the keyword cards for the *FREQUENCY_DOMAIN_RANDOM_VIBRATION. Note that a carriage return is not added. See also FreqVibration.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
cards = f.KeywordCards()
FreqVibration.Next()¶
Returns the next *FREQUENCY_DOMAIN_RANDOM_VIBRATION in the model

Returns:

FreqVibration object (or None if there are no more *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs in the model)

Return type:

FreqVibration

Example

To get the *FREQUENCY_DOMAIN_RANDOM_VIBRATION in model m after *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f = f.Next()
FreqVibration.Previous()¶
Returns the previous *FREQUENCY_DOMAIN_RANDOM_VIBRATION in the model

Returns:

FreqVibration object (or None if there are no more *FREQUENCY_DOMAIN_RANDOM_VIBRATIONs in the model)

Return type:

FreqVibration

Example

To get the *FREQUENCY_DOMAIN_RANDOM_VIBRATION in model m before *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f = f.Previous()
FreqVibration.RemoveAutoPsdLoadData(index)¶
Allows user to remove a specified Auto PSD load card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION.

Parameters:

index (integer) – Index of the auto PSD load card you want to remove. Note that indices start at 0

Returns:

No return value

Return type:

None

Example

To remove first load card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f.RemoveAutoPsdLoadData(0)
FreqVibration.RemoveCrossPsdLoadData(index)¶
Allows user to remove a specified Cross PSD load card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION.

Parameters:

index (integer) – Index of the cross PSD load card you want to remove. Note that indices start at 0

Returns:

No return value

Return type:

None

Example

To remove third load card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f.RemoveCrossPsdLoadData(2)
FreqVibration.RemoveInftgData(index)¶
Allows user to remove a specified Initial Damage card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION. This method is only applicable when option is FreqVibration.FATIGUE.

Parameters:

index (integer) – Index of the Initrial Damage card you want to remove. Note that indices start at 0

Returns:

No return value

Return type:

None

Example

To remove second Initial Damage card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f.RemoveInftgData(1)
FreqVibration.RemoveSNCurveData(index)¶
Allows user to remove a specified S-N curve card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION. This method is only applicable when option is FreqVibration.FATIGUE.

Parameters:

index (integer) – Index of the S-N curve card you want to remove. Note that indices start at 0

Returns:

No return value

Return type:

None

Example

To remove second S-N curve card in *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f.RemoveSNCurveData(1)
FreqVibration.SetFlag(flag)¶
Sets a flag on the *FREQUENCY_DOMAIN_RANDOM_VIBRATION

Parameters:

flag (Flag) – Flag to set on the *FREQUENCY_DOMAIN_RANDOM_VIBRATION

Returns:

No return value

Return type:

None

Example

To set flag f for *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
f.SetFlag(f)
FreqVibration.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:

FreqVibration object

Return type:

dict

Example

To check if FreqVibration property f.example is a parameter by using the FreqVibration.GetParameter() method:
if f.ViewParameters().GetParameter(f.example):
    do_something..
FreqVibration.Xrefs()¶
Returns the cross references for this *FREQUENCY_DOMAIN_RANDOM_VIBRATION

Returns:

Xrefs object

Return type:

dict

Example

To get the cross references for *FREQUENCY_DOMAIN_RANDOM_VIBRATION f:
xrefs = f.Xrefs()