FreqSSD class

The FreqSSD class gives you access to *FREQUENCY_DOMAIN_SSD keyword in PRIMER. More...

The PRIMER JavaScript API provides many class constants, properties and methods. For Arup to be able to extend and enhance the API in the future any constant, property or method names beginning with a lowercase or uppercase letter are reserved.
If you need to add your own properties or methods to one of the existing classes then to avoid any potential future conflict you should ensure that the name begins with either an underscore (_) or a dollar sign ($) or the name is prefixed with your own unique identifier.
For example if company 'ABC' need to add a property called 'example' then to avoid any potential future conflict use one of:

_example
$example
ABC_example

Class functions

Create(Model[Model], modal (optional)[boolean])
First(Model[Model])
FlagAll(Model[Model], flag[Flag])
ForEach(Model[Model], func[function], extra (optional)[any])
GetAll(Model[Model], property (optional)[string])
GetFlagged(Model[Model], flag[Flag], property (optional)[string])
GetFromID(Model[Model], number[integer])
Last(Model[Model])
Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean])
Total(Model[Model], exists (optional)[boolean])
UnflagAll(Model[Model], flag[Flag])

Member functions

AddLoadData()
AddSubcaseData()
AssociateComment(Comment[Comment])
Browse(modal (optional)[boolean])
ClearFlag(flag[Flag])
Copy(range (optional)[boolean])
DetachComment(Comment[Comment])
Edit(modal (optional)[boolean])
Error(message[string], details (optional)[string])
Flagged(flag[Flag])
GetComments()
GetErpData(index[integer])
GetLoadData(index[integer])
GetParameter(prop[string])
GetSubcaseData(index[integer])
Keyword()
KeywordCards()
Next()
Previous()
RemoveLoadData(index[integer])
RemoveSubcaseData(index[integer])
SetErpData(index[integer], data[Array of data])
SetFlag(flag[Flag])
SetLoadData(index[integer], data[Array of data])
SetSubcaseData(index[integer], caseid[string], title[string], nload[integer], data[Array of data])
ViewParameters()
Warning(message[string], details (optional)[string])
Xrefs()
toString()

FreqSSD constants

Name	Description
FreqSSD.DIRECT	FreqSSD option for *FREQUENCY_DOMAIN_SSD_DIRECT.
FreqSSD.DIRECT_FD	FreqSSD option for *FREQUENCY_DOMAIN_SSD_DIRECT_FREQUENCY_DEPENDENT.
FreqSSD.ERP	FreqSSD option for *FREQUENCY_DOMAIN_SSD_ERP.
FreqSSD.FATIGUE	FreqSSD option for *FREQUENCY_DOMAIN_SSD_FATIGUE.
FreqSSD.FRF	FreqSSD option for *FREQUENCY_DOMAIN_SSD_FRF.
FreqSSD.SUBCASE	FreqSSD option for *FREQUENCY_DOMAIN_SSD_SUBCASE.

FreqSSD properties

Name	Type	Description
c	real	Sound speed of the fluid (for option FreqSSD.ERP only).
dampf	real	Modal damping coefficient.
dmpflg	integer	Damping flag.
dmpmas	real	Mass proportional damping constant in Rayleigh damping.
dmpstf	real	Stiffness proportional damping constant in Rayleigh damping.
erpref	real	ERP reference value (for option FreqSSD.ERP only).
erprlf	real	ERP radiation loss factor (for option FreqSSD.ERP only).
exists (read only)	logical	true if *FREQUENCY_DOMAIN_SSD exists, false if referred to but not defined.
fnmax	real	The maximum natural frequency in modal superposition method (optional).
fnmin	real	The minimum natural frequency in modal superposition method (optional).
include	integer	The Include file number that the *FREQUENCY_DOMAIN_SSD is in.
istress	integer	Stress computation flag (for option FreqSSD.DIRECT only).
label (read only)	integer	The label the *FREQUENCY_DOMAIN_SSD has in PRIMER.
lcdam	integer	Load Curve ID defining mode dependent modal damping coefficient.
lcflag	integer	Load curve definition flag.
lcftg	integer	Load Curve ID defining duration of excitation for each frequency (for option FreqSSD.FATIGUE only).
lctyp	integer	Type of load curve defining modal damping coefficient.
mdmax	integer	The last mode in modal superposition method (optional).
mdmin	integer	The first mode in modal superposition method (optional).
memory	integer	Memory flag.
model (read only)	integer	The Model number that the *FREQUENCY_DOMAIN_SSD is in.
nerp	integer	Number of ERP panels.
notyp	integer	Type of NOUT.
nout	integer	Part, part set, segment set, or node set ID for response output.
nova	integer	Response output type.
option	constant	The *FREQUENCY_DOMAIN_SSD option. Can be FreqSSD.DIRECT, FreqSSD.DIRECT_FD, FreqSSD.FATIGUE, FreqSSD.FRF, FreqSSD.ERP or FreqSSD.SUBCASE.
radeff	integer	Radiation efficiency computation flag (for option FreqSSD.ERP only).
relatv	integer	Flag for displacement, velocity and acceleration results.
restdp	integer	Restart option.
restmd	integer	Restart option.
ro	real	Fluid density (for option FreqSSD.ERP only).
strtyp	integer	Stress used in fatigue analysis.

Detailed Description

The FreqSSD class allows you to create, modify, edit and manipulate *FREQUENCY_DOMAIN_SSD. See the documentation below for more details.

Constructor

new FreqSSD(Model[Model], option[constant])

Description

Create a new FreqSSD object.

Arguments

Model (Model)

Model that *FREQUENCY_DOMAIN_SSD will be created in.

option (constant)

Specify the type of *FREQUENCY_DOMAIN_SSD. Can be FreqSSD.DIRECT, FreqSSD.DIRECT_FD, FreqSSD.FATIGUE, FreqSSD.FRF, FreqSSD.ERP or FreqSSD.SUBCASE.

Returns

FreqSSD object

Return type

FreqSSD

Example

To create a new *FREQUENCY_DOMAIN_SSD in model m, of type FATIGUE

var f = new FreqSSD(m, FreqSSD.FATIGUE);

Details of functions

AddLoadData()

Description

Allows user to add a new load card in *FREQUENCY_DOMAIN_SSD. This method is only applicable when option is not FreqSSD.SUBCASE.

The new card has uninitialised fields and should be updated by FreqSSD.SetLoadData().

Arguments

No arguments

Returns

Index of the new load

Return type

integer

Example

To add a new load data card in *FREQUENCY_DOMAIN_SSD f:

f.AddLoadData();

AddSubcaseData()

Description

Allows user to add new subcase cards in *FREQUENCY_DOMAIN_SSD. This method is only applicable when option is FreqSSD.SUBCASE.

The new cards have uninitialised fields and should be updated by FreqSSD.SetSubcaseData().

Arguments

No arguments

Returns

Index of the new subcase

Return type

integer

Example

To add a new load data card in *FREQUENCY_DOMAIN_SSD f:

f.AddSubcaseData();

AssociateComment(Comment[Comment])

Description

Associates a comment with a *FREQUENCY_DOMAIN_SSD.

Arguments

Comment (Comment)

Comment that will be attached to the *FREQUENCY_DOMAIN_SSD

Returns

No return value

Example

To associate comment c to the *FREQUENCY_DOMAIN_SSD f:

f.AssociateComment(c);

Browse(modal (optional)[boolean])

Description

Starts an edit panel in Browse mode.

Arguments

modal (optional) (boolean)

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

Example

To Browse *FREQUENCY_DOMAIN_SSD f:

f.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the *FREQUENCY_DOMAIN_SSD.

Arguments

flag (Flag)

Flag to clear on the *FREQUENCY_DOMAIN_SSD

Returns

No return value

Example

To clear flag f for *FREQUENCY_DOMAIN_SSD f:

f.ClearFlag(f);

Copy(range (optional)[boolean])

Description

Copies the *FREQUENCY_DOMAIN_SSD. The target include of the copied *FREQUENCY_DOMAIN_SSD can be set using Options.copy_target_include.

Arguments

range (optional) (boolean)

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

FreqSSD object

Return type

FreqSSD

Example

To copy *FREQUENCY_DOMAIN_SSD f into *FREQUENCY_DOMAIN_SSD z:

var z = f.Copy();

Create(Model[Model], modal (optional)[boolean]) [static]

Description

Starts an interactive editing panel to create a *FREQUENCY_DOMAIN_SSD

Arguments

Model (Model)

Model that the *FREQUENCY_DOMAIN_SSD will be created in.

modal (optional) (boolean)

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

FreqSSD object (or null if not made).

Return type

FreqSSD

Example

To start creating a *FREQUENCY_DOMAIN_SSD in model m:

var f = FreqSSD.Create(m);

DetachComment(Comment[Comment])

Description

Detaches a comment from a *FREQUENCY_DOMAIN_SSD.

Arguments

Comment (Comment)

Comment that will be detached from the *FREQUENCY_DOMAIN_SSD

Returns

No return value

Example

To detach comment c from the *FREQUENCY_DOMAIN_SSD f:

f.DetachComment(c);

Edit(modal (optional)[boolean])

Description

Starts an interactive editing panel.

Arguments

modal (optional) (boolean)

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

Example

To Edit *FREQUENCY_DOMAIN_SSD f:

f.Edit();

Error(message[string], details (optional)[string])

Description

Adds an error for *FREQUENCY_DOMAIN_SSD. For more details on checking see the Check class.

Arguments

message (string)

The error message to give

details (optional) (string)

An optional detailed error message

Returns

No return value

Example

To add an error message "My custom error" for *FREQUENCY_DOMAIN_SSD f:

f.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first *FREQUENCY_DOMAIN_SSD in the model.

Arguments

Model (Model)

Model to get first *FREQUENCY_DOMAIN_SSD in

Returns

FreqSSD object (or null if there are no *FREQUENCY_DOMAIN_SSDs in the model).

Return type

FreqSSD

Example

To get the first *FREQUENCY_DOMAIN_SSD in model m:

var f = FreqSSD.First(m);

FlagAll(Model[Model], flag[Flag]) [static]

Description

Flags all of the *FREQUENCY_DOMAIN_SSDs in the model with a defined flag.

Arguments

Model (Model)

Model that all *FREQUENCY_DOMAIN_SSDs will be flagged in

flag (Flag)

Flag to set on the *FREQUENCY_DOMAIN_SSDs

Returns

No return value

Example

To flag all of the *FREQUENCY_DOMAIN_SSDs with flag f in model m:

FreqSSD.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the *FREQUENCY_DOMAIN_SSD is flagged or not.

Arguments

flag (Flag)

Flag to test on the *FREQUENCY_DOMAIN_SSD

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if *FREQUENCY_DOMAIN_SSD f has flag f set on it:

if (f.Flagged(f) ) do_something...

ForEach(Model[Model], func[function], extra (optional)[any]) [static]

Description

Calls a function for each *FREQUENCY_DOMAIN_SSD in the model.
Note that ForEach has been designed to make looping over *FREQUENCY_DOMAIN_SSDs as fast as possible and so has some limitations.
Firstly, a single temporary FreqSSD object is created and on each function call it is updated with the current *FREQUENCY_DOMAIN_SSD data. This means that you should not try to store the FreqSSD object for later use (e.g. in an array) as it is temporary.
Secondly, you cannot create new *FREQUENCY_DOMAIN_SSDs inside a ForEach loop.

Arguments

Model (Model)

Model that all *FREQUENCY_DOMAIN_SSDs are in

func (function)

Function to call for each *FREQUENCY_DOMAIN_SSD

extra (optional) (any)

An optional extra object/array/string etc that will appended to arguments when calling the function

Returns

No return value

Example

To call function test for all of the *FREQUENCY_DOMAIN_SSDs in model m:

FreqSSD.ForEach(m, test);
function test(f)
{
// f is FreqSSD object
}

To call function test for all of the *FREQUENCY_DOMAIN_SSDs in model m with optional object:

var data = { x:0, y:0 };
FreqSSD.ForEach(m, test, data);
function test(f, extra)
{
// f is FreqSSD object
// extra is data
}

GetAll(Model[Model], property (optional)[string]) [static]

Description

Returns an array of FreqSSD objects or properties for all of the *FREQUENCY_DOMAIN_SSDs in a model in PRIMER. If the optional property argument is not given then an array of FreqSSD objects is returned. If the property argument is given, that property value for each *FREQUENCY_DOMAIN_SSD is returned in the array instead of a FreqSSD object

Arguments

Model (Model)

Model to get *FREQUENCY_DOMAIN_SSDs from

property (optional) (string)

Name for property to get for all *FREQUENCY_DOMAIN_SSDs in the model

Returns

Array of FreqSSD objects or properties

Return type

Array

Example

To make an array of FreqSSD objects for all of the *FREQUENCY_DOMAIN_SSDs in model m:

var a = FreqSSD.GetAll(m);

To return an array containing the value of property 'foo' (for example 'x' for a node) for each *FREQUENCY_DOMAIN_SSD in model m:

var a = FreqSSD.GetAll(m, 'foo');

GetComments()

Description

Extracts the comments associated to a *FREQUENCY_DOMAIN_SSD.

Arguments

No arguments

Returns

Array of Comment objects (or null if there are no comments associated to the node).

Return type

Array

Example

To get the array of comments associated to the *FREQUENCY_DOMAIN_SSD f:

var comm_array = f.GetComments();

GetErpData(index[integer])

Description

Returns the ERP data for a specific ERP part as an array. For each ERP part there will be 2 values. There are nerp ERP parts.

This method is only applicable when option is FreqSSD.ERP.

Arguments

index (integer)

Index you want the ERP data for. Note that indices start at 0.

Returns

An array containing the ERP data (values: pid[integer], ptyp[integer]). The array length will be 2.

Return type

Number

Example

To get the data for the 3rd ERP part for *FREQUENCY_DOMAIN_SSD f:

var edata = f.GetErpData(2);

GetFlagged(Model[Model], flag[Flag], property (optional)[string]) [static]

Description

Returns an array of FreqSSD objects for all of the flagged *FREQUENCY_DOMAIN_SSDs in a model in PRIMER If the optional property argument is not given then an array of FreqSSD objects is returned. If the property argument is given, then that property value for each *FREQUENCY_DOMAIN_SSD is returned in the array instead of a FreqSSD object

Arguments

Model (Model)

Model to get *FREQUENCY_DOMAIN_SSDs from

flag (Flag)

Flag set on the *FREQUENCY_DOMAIN_SSDs that you want to retrieve

property (optional) (string)

Name for property to get for all flagged *FREQUENCY_DOMAIN_SSDs in the model

Returns

Array of FreqSSD objects or properties

Return type

Array

Example

To make an array of FreqSSD objects for all of the *FREQUENCY_DOMAIN_SSDs in model m flagged with f:

var f = FreqSSD.GetFlagged(m, f);

To return an array containing the value of property 'foo' (for example 'x' for a node) for all of the *FREQUENCY_DOMAIN_SSDs in model m flagged with f:

var a = FreqSSD.GetFlagged(m, f, 'foo');

GetFromID(Model[Model], number[integer]) [static]

Description

Returns the FreqSSD object for a *FREQUENCY_DOMAIN_SSD ID.

Arguments

Model (Model)

Model to find the *FREQUENCY_DOMAIN_SSD in

number (integer)

number of the *FREQUENCY_DOMAIN_SSD you want the FreqSSD object for

Returns

FreqSSD object (or null if *FREQUENCY_DOMAIN_SSD does not exist).

Return type

FreqSSD

Example

To get the FreqSSD object for *FREQUENCY_DOMAIN_SSD 100 in model m

var f = FreqSSD.GetFromID(m, 100);

GetLoadData(index[integer])

Description

Returns the data for a specific excitation load as an array. For each load there will be 8 values. There can be as many loads as needed.

This method is only applicable when option is not FreqSSD.SUBCASE.

Arguments

index (integer)

Index you want the load data for. Note that indices start at 0.

Returns

An array containing the load data (values: nid[integer], ntyp[integer], dof[integer], vad[integer], lc1[integer], lc2[integer], sf[real], vid[integer]).

The array length will be 8.

Return type

Number

Example

To get the data for the 4th load for *FREQUENCY_DOMAIN_SSD f:

var ldata = f.GetLoadData(3);

GetParameter(prop[string])

Description

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

Arguments

prop (string)

*FREQUENCY_DOMAIN_SSD property to get parameter for

Returns

Parameter object if property is a parameter, null if not.

Return type

Parameter

Example

To check if FreqSSD property f.example is a parameter:

Options.property_parameter_names = true;
if (f.GetParameter(f.example) ) do_something...
Options.property_parameter_names = false;

To check if FreqSSD property f.example is a parameter by using the GetParameter method:

if (f.ViewParameters().GetParameter(f.example) ) do_something...

GetSubcaseData(index[integer])

Description

Returns the data for a specific subcase as an array. For each subcase there will be 3 + 8 x nload values. There can be as many subcases as needed.

This method is only applicable when option is FreqSSD.SUBCASE.

Arguments

index (integer)

Index you want the subcase data for. Note that indices start at 0.

Returns

An array containing the subcase data (values: caseid[string], title[string], nload[integer], nid[integer], ntyp[integer], dof[integer], vad[integer], lc1[integer], lc2[integer], sf[real], vid[integer], ...)

Where values nid to vid are repeated nload times in the array. The array length will be 3 + 8 x nload.

Return type

Number

Example

To get the data for the 2nd subcase for *FREQUENCY_DOMAIN_SSD f:

var sdata = f.GetSubcaseData(1);

Keyword()

Description

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

Arguments

No arguments

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for *FREQUENCY_DOMAIN_SSD f:

var key = f.Keyword();

KeywordCards()

Description

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

Arguments

No arguments

Returns

string containing the cards.

Return type

String

Example

To get the cards for *FREQUENCY_DOMAIN_SSD f:

var cards = f.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last *FREQUENCY_DOMAIN_SSD in the model.

Arguments

Model (Model)

Model to get last *FREQUENCY_DOMAIN_SSD in

Returns

FreqSSD object (or null if there are no *FREQUENCY_DOMAIN_SSDs in the model).

Return type

FreqSSD

Example

To get the last *FREQUENCY_DOMAIN_SSD in model m:

var f = FreqSSD.Last(m);

Next()

Description

Returns the next *FREQUENCY_DOMAIN_SSD in the model.

Arguments

No arguments

Returns

FreqSSD object (or null if there are no more *FREQUENCY_DOMAIN_SSDs in the model).

Return type

FreqSSD

Example

To get the *FREQUENCY_DOMAIN_SSD in model m after *FREQUENCY_DOMAIN_SSD f:

var f = f.Next();

Previous()

Description

Returns the previous *FREQUENCY_DOMAIN_SSD in the model.

Arguments

No arguments

Returns

FreqSSD object (or null if there are no more *FREQUENCY_DOMAIN_SSDs in the model).

Return type

FreqSSD

Example

To get the *FREQUENCY_DOMAIN_SSD in model m before *FREQUENCY_DOMAIN_SSD f:

var f = f.Previous();

RemoveLoadData(index[integer])

Description

Allows user to remove a specified load card in *FREQUENCY_DOMAIN_SSD.

This method is only applicable when option is not FreqSSD.SUBCASE.

Arguments

index (integer)

Index of the load card you want to remove. Note that indices start at 0.

Returns

No return value

Example

To remove first load card in *FREQUENCY_DOMAIN_SSD f:

f.RemoveLoadData(0);

RemoveSubcaseData(index[integer])

Description

Allows user to remove cards for a specified subcase in *FREQUENCY_DOMAIN_SSD.

This method is only applicable when option is FreqSSD.SUBCASE.

Arguments

index (integer)

Index of the subcase you want to remove cards for. Note that indices start at 0.

Returns

No return value

Example

To remove cards corresponding to the second subcase in *FREQUENCY_DOMAIN_SSD f:

f.RemoveSubcaseData(1);

Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean]) [static]

Description

Allows the user to select *FREQUENCY_DOMAIN_SSDs using standard PRIMER object menus.

Arguments

flag (Flag)

Flag to use when selecting *FREQUENCY_DOMAIN_SSDs

prompt (string)

Text to display as a prompt to the user

limit (optional) (Model or Flag)

If the argument is a Model then only *FREQUENCY_DOMAIN_SSDs from that model can be selected. If the argument is a Flag then only *FREQUENCY_DOMAIN_SSDs that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any *FREQUENCY_DOMAIN_SSDs can be selected. from any model.

modal (optional) (boolean)

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_SSDs selected or null if menu cancelled

Return type

Number

Example

To select *FREQUENCY_DOMAIN_SSDs from model m, flagging those selected with flag f, giving the prompt 'Select *FREQUENCY_DOMAIN_SSDs':

FreqSSD.Select(f, 'Select *FREQUENCY_DOMAIN_SSDs', m);

To select *FREQUENCY_DOMAIN_SSDs, flagging those selected with flag f but limiting selection to *FREQUENCY_DOMAIN_SSDs flagged with flag l, giving the prompt 'Select *FREQUENCY_DOMAIN_SSDs':

FreqSSD.Select(f, 'Select *FREQUENCY_DOMAIN_SSDs', l);

SetErpData(index[integer], data[Array of data])

Description

Set the data for a specific ERP part. For each ERP part there will be 2 values. There are nerp ERP parts.

This method is only applicable when option is FreqSSD.ERP.

Arguments

index (integer)

Index you want to set ERP data for. Note that indices start at 0.

data (Array of data)

An array containing the ERP data (values: pid[integer], ptyp[integer]). The array length should be 2.

Returns

No return value.

Example

To set the 3rd ERP part data for *FREQUENCY_DOMAIN_SSD f to the values in array edata:

f.SetErpData(2, edata);

SetFlag(flag[Flag])

Description

Sets a flag on the *FREQUENCY_DOMAIN_SSD.

Arguments

flag (Flag)

Flag to set on the *FREQUENCY_DOMAIN_SSD

Returns

No return value

Example

To set flag f for *FREQUENCY_DOMAIN_SSD f:

f.SetFlag(f);

SetLoadData(index[integer], data[Array of data])

Description

Set the data for a specific excitation load. For each load there will be 8 values. There can be as many loads as needed.

This method is only applicable when option is not FreqSSD.SUBCASE.

Arguments

index (integer)

Index you want to set load data for. Note that indices start at 0.

data (Array of data)

An array containing the load data (values: nid[integer], ntyp[integer], dof[integer], vad[integer], lc1[integer], lc2[integer], sf[real], vid[integer]).

The array length should be 8.

Returns

No return value.

Example

To set the 4th load data for *FREQUENCY_DOMAIN_SSD f to the values in array ldata:

f.SetLoadData(3, ldata);

SetSubcaseData(index[integer], caseid[string], title[string], nload[integer], data[Array of data])

Description

Set the data for a specific subcase. For each subcase, data will have 8 x nload values. There can be as many subcases as needed.

This method is only applicable when option is FreqSSD.SUBCASE.

Arguments

index (integer)

Index you want to set subcase data for. Note that indices start at 0.

caseid (string)

Identification string to be used as the case ID (must include at least one letter).

title (string)

A description of the current loading case (can be blank).

nload (integer)

Number of loads for this loading case.

data (Array of data)

An array containing the subcase load data (values: nid[integer], ntyp[integer], dof[integer], vad[integer], lc1[integer], lc2[integer], sf[real], vid[integer], ...)

Where values nid to vid are repeated nload times in the array. The array length should be 8 x nload.

Returns

No return value.

Example

To set the 2nd subcase data for *FREQUENCY_DOMAIN_SSD f to have caseid "ID2", no title, 2 load cards and load data of ldata:

f.SetSubcaseData(1, "ID2", "", 2, ldata);

Total(Model[Model], exists (optional)[boolean]) [static]

Description

Returns the total number of *FREQUENCY_DOMAIN_SSDs in the model.

Arguments

Model (Model)

Model to get total for

exists (optional) (boolean)

true if only existing *FREQUENCY_DOMAIN_SSDs should be counted. If false or omitted referenced but undefined *FREQUENCY_DOMAIN_SSDs will also be included in the total.

Returns

number of *FREQUENCY_DOMAIN_SSDs

Return type

Number

Example

To get the total number of *FREQUENCY_DOMAIN_SSDs in model m:

var total = FreqSSD.Total(m);

UnflagAll(Model[Model], flag[Flag]) [static]

Description

Unsets a defined flag on all of the *FREQUENCY_DOMAIN_SSDs in the model.

Arguments

Model (Model)

Model that the defined flag for all *FREQUENCY_DOMAIN_SSDs will be unset in

flag (Flag)

Flag to unset on the *FREQUENCY_DOMAIN_SSDs

Returns

No return value

Example

To unset the flag f on all the *FREQUENCY_DOMAIN_SSDs in model m:

FreqSSD.UnflagAll(m, f);

ViewParameters()

Description

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.

Arguments

No arguments

Returns

FreqSSD object.

Return type

FreqSSD

Example

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

if (f.ViewParameters().GetParameter(f.example) ) do_something...

Warning(message[string], details (optional)[string])

Description

Adds a warning for *FREQUENCY_DOMAIN_SSD. For more details on checking see the Check class.

Arguments

message (string)

The warning message to give

details (optional) (string)

An optional detailed warning message

Returns

No return value

Example

To add a warning message "My custom warning" for *FREQUENCY_DOMAIN_SSD f:

f.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this *FREQUENCY_DOMAIN_SSD.

Arguments

No arguments

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for *FREQUENCY_DOMAIN_SSD f:

var xrefs = f.Xrefs();

toString()

Description

Creates a string containing the *FREQUENCY_DOMAIN_SSD data in keyword format. Note that this contains the keyword header and the keyword cards. See also FreqSSD.Keyword() and FreqSSD.KeywordCards().

Arguments

No arguments

Returns

string

Return type

String

Example

To get data for *FREQUENCY_DOMAIN_SSD f in keyword format

var s = f.toString();