DampingFrequencyRange class

The DampingFrequencyRange class gives you access to define damping frequency range cards 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:

Class functions

Member functions

DampingFrequencyRange constants

Name Description
DampingFrequencyRange.DEFORM DEFORM is *DAMPING_FREQUENCY_RANGE_DEFORM.
DampingFrequencyRange.NO_OPT NO_OPT is *DAMPING_FREQUENCY_RANGE.

DampingFrequencyRange properties

Name Type Description
cdamp real Fraction of critical damping
cdampv real Fraction of critical damping applied to pressure/volume response of solid elements
exists (read only) logical true if damping frequency range exists, false if referred to but not defined.
fhigh real Highest frequency in range of interest.
flow real Lowest frequency in range of interest
icard2 integer Flag for reading the additional card
iflg integer Method used for internal calculation of damping constants
include integer The Include file number that the damping frequency range is in.
ipwp integer Flag to determine whether damping is applied to excess pore pressure
model (read only) integer The Model number that the damping frequency range is in.
option constant The DampingFrequencyRange option. Can be:
pidref integer Part ID.
psid integer Set Part set ID.

Detailed Description

The DampingFrequencyRange class allows you to create, modify, edit and manipulate damping_frequency_range cards. See the documentation below for more details.

Constructor

new DampingFrequencyRange(Model[Model], option (optional)[constant], cdamp (optional)[real], flow (optional)[real], fhigh (optional)[real], psid (optional)[integer], pidref (optional)[integer], iflg (optional)[integer], icard2 (optional)[integer], cdampv (optional)[real], ipwp (optional)[integer])

Description

Create a new DampingFrequencyRange object for *DAMPING_FREQUENCY_RANGE.

Arguments

  • Model (Model)

    Model that damping frequency range will be created in

  • option (optional) (constant)

    Damping frequency range type. Can be DampingFrequencyRange.NO_OPT or DampingFrequencyRange.DEFORM.

  • cdamp (optional) (real)

    Fraction of critical damping

  • flow (optional) (real)

    Lowest frequency in range of interest

  • fhigh (optional) (real)

    Highest frequency in range of interest.

  • psid (optional) (integer)

    Set Part set ID.

  • pidref (optional) (integer)

    Part ID.

  • iflg (optional) (integer)

    Method used for internal calculation of damping constants

  • icard2 (optional) (integer)

    Flag for reading the additional card

  • cdampv (optional) (real)

    Fraction of critical damping applied to pressure/volume response of solid elements

  • ipwp (optional) (integer)

    Flag to determine whether damping is applied to excess pore pressure

    Returns

    DampingFrequencyRange object

    Return type

    DampingFrequencyRange

    Example

    To create a new damping frequency range (of type DEFORM) in model m with cdamp, flow, fhigh, psid, iflg set to 1.5, 2.5, 3.5, 4, 1 respectively: 

    var fr = new DampingFrequencyRange(m, DampingFrequencyRange.DEFORM, 1.5, 2.5, 3.5, 4, 1);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a damping frequency range.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the damping frequency range

    Returns

    No return value

    Example

    To associate comment c to the damping frequency range fr: 

    fr.AssociateComment(c);

    Blank()

    Description

    Blanks the damping frequency range

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank damping frequency range fr: 

    fr.Blank();

    BlankAll(Model[Model], redraw (optional)[boolean]) [static]

    Description

    Blanks all of the damping frequency ranges in the model.

    Arguments

  • Model (Model)

    Model that all damping frequency ranges will be blanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To blank all of the damping frequency ranges in model m: 

    DampingFrequencyRange.BlankAll(m);

    BlankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

    Description

    Blanks all of the flagged damping frequency ranges in the model.

    Arguments

  • Model (Model)

    Model that all the flagged damping frequency ranges will be blanked in

  • flag (Flag)

    Flag set on the damping frequency ranges that you want to blank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To blank all of the damping frequency ranges in model m flagged with f: 

    DampingFrequencyRange.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the damping frequency range is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if damping frequency range fr is blanked: 

    if (fr.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the damping frequency range.

    Arguments

  • flag (Flag)

    Flag to clear on the damping frequency range

    Returns

    No return value

    Example

    To clear flag f for damping frequency range fr: 

    fr.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the damping frequency range. The target include of the copied damping frequency range 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

    DampingFrequencyRange object

    Return type

    DampingFrequencyRange

    Example

    To copy damping frequency range fr into damping frequency range z: 

    var z = fr.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a damping frequency range.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the damping frequency range

    Returns

    No return value

    Example

    To detach comment c from the damping frequency range fr: 

    fr.DetachComment(c);

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

    Description

    Adds an error for damping frequency range. 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 damping frequency range fr: 

    fr.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first damping frequency range in the model.

    Arguments

  • Model (Model)

    Model to get first damping frequency range in

    Returns

    DampingFrequencyRange object (or null if there are no damping frequency ranges in the model).

    Return type

    DampingFrequencyRange

    Example

    To get the first damping frequency range in model m: 

    var fr = DampingFrequencyRange.First(m);

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

    Description

    Flags all of the damping frequency ranges in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all damping frequency ranges will be flagged in

  • flag (Flag)

    Flag to set on the damping frequency ranges

    Returns

    No return value

    Example

    To flag all of the damping frequency ranges with flag f in model m: 

    DampingFrequencyRange.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the damping frequency range is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the damping frequency range

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if damping frequency range fr has flag f set on it: 

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

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

    Description

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

    Arguments

  • Model (Model)

    Model that all damping frequency ranges are in

  • func (function)

    Function to call for each damping frequency range

  • 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 damping frequency ranges in model m: 

    DampingFrequencyRange.ForEach(m, test);
function test(fr)
{
// fr is DampingFrequencyRange object
}

    To call function test for all of the damping frequency ranges in model m with optional object: 

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

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

    Description

    Returns an array of DampingFrequencyRange objects or properties for all of the damping frequency ranges in a model in PRIMER. If the optional property argument is not given then an array of DampingFrequencyRange objects is returned. If the property argument is given, that property value for each damping frequency range is returned in the array instead of a DampingFrequencyRange object

    Arguments

  • Model (Model)

    Model to get damping frequency ranges from

  • property (optional) (string)

    Name for property to get for all damping frequency ranges in the model

    Returns

    Array of DampingFrequencyRange objects or properties

    Return type

    Array

    Example

    To make an array of DampingFrequencyRange objects for all of the damping frequency ranges in model m: 

    var a = DampingFrequencyRange.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a damping frequency range.

    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 damping frequency range fr: 

    var comm_array = fr.GetComments();

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

    Description

    Returns an array of DampingFrequencyRange objects for all of the flagged damping frequency ranges in a model in PRIMER If the optional property argument is not given then an array of DampingFrequencyRange objects is returned. If the property argument is given, then that property value for each damping frequency range is returned in the array instead of a DampingFrequencyRange object

    Arguments

  • Model (Model)

    Model to get damping frequency ranges from

  • flag (Flag)

    Flag set on the damping frequency ranges that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged damping frequency ranges in the model

    Returns

    Array of DampingFrequencyRange objects or properties

    Return type

    Array

    Example

    To make an array of DampingFrequencyRange objects for all of the damping frequency ranges in model m flagged with f: 

    var fr = DampingFrequencyRange.GetFlagged(m, f);

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

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

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

    Description

    Returns the DampingFrequencyRange object for a damping frequency range ID.

    Arguments

  • Model (Model)

    Model to find the damping frequency range in

  • number (integer)

    number of the damping frequency range you want the DampingFrequencyRange object for

    Returns

    DampingFrequencyRange object (or null if damping frequency range does not exist).

    Return type

    DampingFrequencyRange

    Example

    To get the DampingFrequencyRange object for damping frequency range 100 in model m 

    var fr = DampingFrequencyRange.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    damping frequency range property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if DampingFrequencyRange property fr.example is a parameter: 

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

    To check if DampingFrequencyRange property fr.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this damping frequency range (*DAMPING_FREQUENCY_RANGE). Note that a carriage return is not added. See also DampingFrequencyRange.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for damping frequency range m: 

    var key = fr.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the damping frequency range. Note that a carriage return is not added. See also DampingFrequencyRange.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for damping frequency range fr: 

    var cards = fr.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last damping frequency range in the model.

    Arguments

  • Model (Model)

    Model to get last damping frequency range in

    Returns

    DampingFrequencyRange object (or null if there are no damping frequency ranges in the model).

    Return type

    DampingFrequencyRange

    Example

    To get the last damping frequency range in model m: 

    var fr = DampingFrequencyRange.Last(m);

    Next()

    Description

    Returns the next damping frequency range in the model.

    Arguments

    No arguments

    Returns

    DampingFrequencyRange object (or null if there are no more damping frequency ranges in the model).

    Return type

    DampingFrequencyRange

    Example

    To get the damping frequency range in model m after damping frequency range fr: 

    var fr = fr.Next();

    Pick(prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean], button text (optional)[string]) [static]

    Description

    Allows the user to pick a damping frequency range.

    Arguments

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

    If the argument is a Model then only damping frequency ranges from that model can be picked. If the argument is a Flag then only damping frequency ranges that are flagged with limit can be selected. If omitted, or null, any damping frequency ranges from any model can be selected. from any model.

  • modal (optional) (boolean)

    If picking is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the pick will be modal.

  • button text (optional) (string)

    By default the window with the prompt will have a button labelled 'Cancel' which if pressed will cancel the pick and return null. If you want to change the text on the button use this argument. If omitted 'Cancel' will be used.

    Returns

    DampingFrequencyRange object (or null if not picked)

    Return type

    DampingFrequencyRange

    Example

    To pick a damping frequency range from model m giving the prompt 'Pick damping frequency range from screen': 

    var fr = DampingFrequencyRange.Pick('Pick damping frequency range from screen', m);

    Previous()

    Description

    Returns the previous damping frequency range in the model.

    Arguments

    No arguments

    Returns

    DampingFrequencyRange object (or null if there are no more damping frequency ranges in the model).

    Return type

    DampingFrequencyRange

    Example

    To get the damping frequency range in model m before damping frequency range fr: 

    var fr = fr.Previous();

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

    Description

    Allows the user to select damping frequency ranges using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting damping frequency ranges

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

    To select damping frequency ranges from model m, flagging those selected with flag f, giving the prompt 'Select damping frequency ranges': 

    DampingFrequencyRange.Select(f, 'Select damping frequency ranges', m);

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

    DampingFrequencyRange.Select(f, 'Select damping frequency ranges', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the damping frequency range.

    Arguments

  • flag (Flag)

    Flag to set on the damping frequency range

    Returns

    No return value

    Example

    To set flag f for damping frequency range fr: 

    fr.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the damping frequency range. The damping frequency range will be sketched until you either call DampingFrequencyRange.Unsketch(), DampingFrequencyRange.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the damping frequency range is sketched. If omitted redraw is true. If you want to sketch several damping frequency ranges and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To sketch damping frequency range fr: 

    fr.Sketch();

    SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

    Description

    Sketches all of the flagged damping frequency ranges in the model. The damping frequency ranges will be sketched until you either call DampingFrequencyRange.Unsketch(), DampingFrequencyRange.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

    Arguments

  • Model (Model)

    Model that all the flagged damping frequency ranges will be sketched in

  • flag (Flag)

    Flag set on the damping frequency ranges that you want to sketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the damping frequency ranges are sketched. If omitted redraw is true. If you want to sketch flagged damping frequency ranges several times and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To sketch all damping frequency ranges flagged with flag in model m: 

    DampingFrequencyRange.SketchFlagged(m, flag);

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

    Description

    Returns the total number of damping frequency ranges in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of damping frequency ranges

    Return type

    Number

    Example

    To get the total number of damping frequency ranges in model m: 

    var total = DampingFrequencyRange.Total(m);

    Unblank()

    Description

    Unblanks the damping frequency range

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank damping frequency range fr: 

    fr.Unblank();

    UnblankAll(Model[Model], redraw (optional)[boolean]) [static]

    Description

    Unblanks all of the damping frequency ranges in the model.

    Arguments

  • Model (Model)

    Model that all damping frequency ranges will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To unblank all of the damping frequency ranges in model m: 

    DampingFrequencyRange.UnblankAll(m);

    UnblankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

    Description

    Unblanks all of the flagged damping frequency ranges in the model.

    Arguments

  • Model (Model)

    Model that the flagged damping frequency ranges will be unblanked in

  • flag (Flag)

    Flag set on the damping frequency ranges that you want to unblank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To unblank all of the damping frequency ranges in model m flagged with f: 

    DampingFrequencyRange.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the damping frequency ranges in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all damping frequency ranges will be unset in

  • flag (Flag)

    Flag to unset on the damping frequency ranges

    Returns

    No return value

    Example

    To unset the flag f on all the damping frequency ranges in model m: 

    DampingFrequencyRange.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the damping frequency range.

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the damping frequency range is unsketched. If omitted redraw is true. If you want to unsketch several damping frequency ranges and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch damping frequency range fr: 

    fr.Unsketch();

    UnsketchAll(Model[Model], redraw (optional)[boolean]) [static]

    Description

    Unsketches all damping frequency ranges.

    Arguments

  • Model (Model)

    Model that all damping frequency ranges will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not after the damping frequency ranges are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch all damping frequency ranges in model m: 

    DampingFrequencyRange.UnsketchAll(m);

    UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

    Description

    Unsketches all flagged damping frequency ranges in the model.

    Arguments

  • Model (Model)

    Model that all damping frequency ranges will be unsketched in

  • flag (Flag)

    Flag set on the damping frequency ranges that you want to unsketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the damping frequency ranges are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch all damping frequency ranges flagged with flag in model m: 

    DampingFrequencyRange.UnsketchAll(m, flag);

    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

    DampingFrequencyRange object.

    Return type

    DampingFrequencyRange

    Example

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

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

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

    Description

    Adds a warning for damping frequency range. 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 damping frequency range fr: 

    fr.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this damping frequency range.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for damping frequency range fr: 

    var xrefs = fr.Xrefs();

    toString()

    Description

    Creates a string containing the damping frequency range data in keyword format. Note that this contains the keyword header and the keyword cards. See also DampingFrequencyRange.Keyword() and DampingFrequencyRange.KeywordCards().

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for damping frequency range fr in keyword format 

    var s = fr.toString();