FreqFRF class

Returns

No return value

Example

To create a new *FREQUENCY_DOMAIN_FRF in model m for BLANK option

var f = new FreqFRF(m, FreqFRF.BLANK);

new FreqFRF(Model[Model], n1[integer], n1typ[integer], n2[integer], n2typ[integer])   [deprecated]

This function is deprecated in version 22.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Create a new FreqFRF object.

Returns

FreqFRF object

Return type

FreqFRF

Example

To create a new *FREQUENCY_DOMAIN_FRF in model m with node 10 for excitation output and node set 2 for response output

var f = new FreqFRF(m, 10, FreqFRF.NODE, 2, FreqFRF.NODE_SET);

Details of functions

AddSubcaseData()

Description

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

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

Returns

Index of the new subcase

Return type

integer

Example

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

f.AddSubcaseData();

AssociateComment(Comment[Comment])

Description

Associates a comment with a *FREQUENCY_DOMAIN_FRF.

Returns

No return value

Example

To associate comment c to the *FREQUENCY_DOMAIN_FRF f:

f.AssociateComment(c);

Browse(modal (optional)[boolean])

Description

Starts an edit panel in Browse mode.

Returns

no return value

Example

To Browse *FREQUENCY_DOMAIN_FRF f:

f.Browse();

ClearFlag(flag[Flag])

Description

Clears a flag on the *FREQUENCY_DOMAIN_FRF.

Returns

No return value

Example

To clear flag f for *FREQUENCY_DOMAIN_FRF f:

f.ClearFlag(f);

Copy(range (optional)[boolean])

Description

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

Returns

FreqFRF object

Return type

FreqFRF

Example

To copy *FREQUENCY_DOMAIN_FRF f into *FREQUENCY_DOMAIN_FRF z:

var z = f.Copy();

DetachComment(Comment[Comment])

Description

Detaches a comment from a *FREQUENCY_DOMAIN_FRF.

Returns

No return value

Example

To detach comment c from the *FREQUENCY_DOMAIN_FRF f:

f.DetachComment(c);

Edit(modal (optional)[boolean])

Description

Starts an interactive editing panel.

Returns

no return value

Example

To Edit *FREQUENCY_DOMAIN_FRF f:

f.Edit();

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

Description

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

Returns

No return value

Example

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

f.Error("My custom error");

First(Model[Model]) [static]

Description

Returns the first *FREQUENCY_DOMAIN_FRF in the model.

Returns

FreqFRF object (or null if there are no *FREQUENCY_DOMAIN_FRFs in the model).

Return type

FreqFRF

Example

To get the first *FREQUENCY_DOMAIN_FRF in model m:

var f = FreqFRF.First(m);

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

Description

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

Returns

No return value

Example

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

FreqFRF.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the *FREQUENCY_DOMAIN_FRF is flagged or not.

Returns

true if flagged, false if not.

Return type

Boolean

Example

To check if *FREQUENCY_DOMAIN_FRF 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_FRF in the model.
Note that ForEach has been designed to make looping over *FREQUENCY_DOMAIN_FRFs as fast as possible and so has some limitations.
Firstly, a single temporary FreqFRF object is created and on each function call it is updated with the current *FREQUENCY_DOMAIN_FRF data. This means that you should not try to store the FreqFRF object for later use (e.g. in an array) as it is temporary.
Secondly, you cannot create new *FREQUENCY_DOMAIN_FRFs inside a ForEach loop.

Returns

No return value

Example

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

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

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

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

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

Description

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

Returns

Array of FreqFRF objects or properties

Return type

Array

Example

To make an array of FreqFRF objects for all of the *FREQUENCY_DOMAIN_FRFs in model m:

var a = FreqFRF.GetAll(m);

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

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

GetComments()

Description

Extracts the comments associated to a *FREQUENCY_DOMAIN_FRF.

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_FRF f:

var comm_array = f.GetComments();

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

Description

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

Returns

Array of FreqFRF objects or properties

Return type

Array

Example

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

var f = FreqFRF.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_FRFs in model m flagged with f:

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

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

Description

Returns the FreqFRF object for a *FREQUENCY_DOMAIN_FRF ID.

Returns

FreqFRF object (or null if *FREQUENCY_DOMAIN_FRF does not exist).

Return type

FreqFRF

Example

To get the FreqFRF object for *FREQUENCY_DOMAIN_FRF 100 in model m

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

GetParameter(prop[string])

Description

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

Returns

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

Return type

Parameter

Example

To check if FreqFRF 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 FreqFRF 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 13 values when vad1=12 else 11 values . There can be as many subcases as needed.

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

Returns

An array containing the subcase data (values: title[string], n1[integer], n1typ[integer], n1typ[integer], dof1[integer], vad1[integer], vid1[integer], n2[integer], n2typ[integer],dof2[integer], vad2[integer], vid2[integer], n11[integer], n11typ[integer])

n11 and n11typ are present only when vad1 =12

Return type

Number

Example

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

var sdata = f.GetSubcaseData(1);

Keyword()

Description

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

Returns

string containing the keyword.

Return type

String

Example

To get the keyword for *FREQUENCY_DOMAIN_FRF f:

var key = f.Keyword();

KeywordCards()

Description

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

Returns

string containing the cards.

Return type

String

Example

To get the cards for *FREQUENCY_DOMAIN_FRF f:

var cards = f.KeywordCards();

Last(Model[Model]) [static]

Description

Returns the last *FREQUENCY_DOMAIN_FRF in the model.

Returns

FreqFRF object (or null if there are no *FREQUENCY_DOMAIN_FRFs in the model).

Return type

FreqFRF

Example

To get the last *FREQUENCY_DOMAIN_FRF in model m:

var f = FreqFRF.Last(m);

Next()

Description

Returns the next *FREQUENCY_DOMAIN_FRF in the model.

Returns

FreqFRF object (or null if there are no more *FREQUENCY_DOMAIN_FRFs in the model).

Return type

FreqFRF

Example

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

var f = f.Next();

Previous()

Description

Returns the previous *FREQUENCY_DOMAIN_FRF in the model.

Returns

FreqFRF object (or null if there are no more *FREQUENCY_DOMAIN_FRFs in the model).

Return type

FreqFRF

Example

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

var f = f.Previous();

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

Description

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

Returns

Number of *FREQUENCY_DOMAIN_FRFs selected or null if menu cancelled

Return type

Number

Example

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

FreqFRF.Select(f, 'Select *FREQUENCY_DOMAIN_FRFs', m);

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

FreqFRF.Select(f, 'Select *FREQUENCY_DOMAIN_FRFs', l);

SetFlag(flag[Flag])

Description

Sets a flag on the *FREQUENCY_DOMAIN_FRF.

Returns

No return value

Example

To set flag f for *FREQUENCY_DOMAIN_FRF f:

f.SetFlag(f);

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

Description

Set the data for a specific subcase. There can be as many subcases as needed.

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

Returns

No return value.

Example

To set the 2nd subcase data for *FREQUENCY_DOMAIN_FRF to have title "subcase 1" and vad1 as 2:

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

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

Description

Returns the total number of *FREQUENCY_DOMAIN_FRFs in the model.

Returns

number of *FREQUENCY_DOMAIN_FRFs

Return type

Number

Example

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

var total = FreqFRF.Total(m);

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

Description

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

Returns

No return value

Example

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

FreqFRF.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.

Returns

FreqFRF object.

Return type

FreqFRF

Example

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

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

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

Description

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

Returns

No return value

Example

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

f.Warning("My custom warning");

Xrefs()

Description

Returns the cross references for this *FREQUENCY_DOMAIN_FRF.

Returns

Xrefs object.

Return type

Xrefs

Example

To get the cross references for *FREQUENCY_DOMAIN_FRF f:

var xrefs = f.Xrefs();

toString()

Description

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

Returns

string

Return type

String

Example

To get data for *FREQUENCY_DOMAIN_FRF f in keyword format

var str = f.toString();