Velocity class

The Velocity class gives you access to define initial velocity 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

Velocity properties

Name Type Description
boxid integer Define box containing nodes
exists (read only) logical true if initial velocity exists, false if referred to but not defined.
icid integer Local coordinate system
include integer The Include file number that the initial velocity is in.
irigid integer IRIGID flag
model (read only) integer The Model number that the initial velocity is in.
nsid integer Set Node set ID
nsidex integer Set Exempted Node set ID
vx real Initial velocity in X direction
vxe real Initial velocity in X direction of exempted nodes
vxr real Initial rotational velocity about X axis
vxre real Initial rotational velocity about X axis of exempted nodes
vy real Initial velocity in Y direction
vye real Initial velocity in Y direction of exempted nodes
vyr real Initial rotational velocity about Y axis
vyre real Initial rotational velocity about Y axis of exempted nodes
vz real Initial velocity in Z direction
vze real Initial velocity in Z direction of exempted nodes
vzr real Initial rotational velocity about Z axis
vzre real Initial rotational velocity about Z axis of exempted nodes

Detailed Description

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

Constructor

new Velocity(Model[Model], nsid[integer], vx[real], vy[real], vz[real], vxr[real], vyr[real], vzr[real], boxid (optional)[integer], irigid (optional)[integer], nsidex (optional)[integer], vxe (optional)[real], vye (optional)[real], vze (optional)[real], vxre (optional)[real], vyre (optional)[real], vzre (optional)[real], icid (optional)[real])

Description

Create a new Velocity object.

Arguments

  • Model (Model)

    Model that velocity will be created in

  • nsid (integer)

    Set Node set ID

  • vx (real)

    Initial velocity in X direction

  • vy (real)

    Initial velocity in Y direction

  • vz (real)

    Initial velocity in Z direction

  • vxr (real)

    Initial rotational velocity about X axis

  • vyr (real)

    Initial rotational velocity about Y axis

  • vzr (real)

    Initial rotational velocity about Z axis

  • boxid (optional) (integer)

    Define box containing nodes

  • irigid (optional) (integer)

    IRIGID flag

  • nsidex (optional) (integer)

    Set Exempted Node set ID

  • vxe (optional) (real)

    Initial velocity in X direction of exempted nodes

  • vye (optional) (real)

    Initial velocity in Y direction of exempted nodes

  • vze (optional) (real)

    Initial velocity in Z direction of exempted nodes

  • vxre (optional) (real)

    Initial rotational velocity about X axis of exempted nodes

  • vyre (optional) (real)

    Initial rotational velocity about Y axis of exempted nodes

  • vzre (optional) (real)

    Initial rotational velocity about Z axis of exempted nodes

  • icid (optional) (real)

    Local coordinate system nodes

    Returns

    Velocity object

    Return type

    Velocity

    Example

    To create a new velocity in model m 

    var s = new Velocity(m, 1, 2.4, 3.7, 7.9, 0.0, 0.0, 0.0);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a initial velocity.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the initial velocity

    Returns

    No return value

    Example

    To associate comment c to the initial velocity v: 

    v.AssociateComment(c);

    Blank()

    Description

    Blanks the initial velocity

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank initial velocity v: 

    v.Blank();

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

    Description

    Blanks all of the initial velocities in the model.

    Arguments

  • Model (Model)

    Model that all initial velocities 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 initial velocities in model m: 

    Velocity.BlankAll(m);

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

    Description

    Blanks all of the flagged initial velocities in the model.

    Arguments

  • Model (Model)

    Model that all the flagged initial velocities will be blanked in

  • flag (Flag)

    Flag set on the initial velocities 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 initial velocities in model m flagged with f: 

    Velocity.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the initial velocity is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if initial velocity v is blanked: 

    if (v.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the initial velocity.

    Arguments

  • flag (Flag)

    Flag to clear on the initial velocity

    Returns

    No return value

    Example

    To clear flag f for initial velocity v: 

    v.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the initial velocity. The target include of the copied initial velocity 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

    Velocity object

    Return type

    Velocity

    Example

    To copy initial velocity v into initial velocity z: 

    var z = v.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a initial velocity.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the initial velocity

    Returns

    No return value

    Example

    To detach comment c from the initial velocity v: 

    v.DetachComment(c);

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

    Description

    Adds an error for initial velocity. 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 initial velocity v: 

    v.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first initial velocity in the model.

    Arguments

  • Model (Model)

    Model to get first initial velocity in

    Returns

    Velocity object (or null if there are no initial velocities in the model).

    Return type

    Velocity

    Example

    To get the first initial velocity in model m: 

    var v = Velocity.First(m);

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

    Description

    Flags all of the initial velocities in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all initial velocities will be flagged in

  • flag (Flag)

    Flag to set on the initial velocities

    Returns

    No return value

    Example

    To flag all of the initial velocities with flag f in model m: 

    Velocity.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the initial velocity is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the initial velocity

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if initial velocity v has flag f set on it: 

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

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

    Description

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

    Arguments

  • Model (Model)

    Model that all initial velocities are in

  • func (function)

    Function to call for each initial velocity

  • 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 initial velocities in model m: 

    Velocity.ForEach(m, test);
function test(v)
{
// v is Velocity object
}

    To call function test for all of the initial velocities in model m with optional object: 

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

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

    Description

    Returns an array of Velocity objects or properties for all of the initial velocities in a model in PRIMER. If the optional property argument is not given then an array of Velocity objects is returned. If the property argument is given, that property value for each initial velocity is returned in the array instead of a Velocity object

    Arguments

  • Model (Model)

    Model to get initial velocities from

  • property (optional) (string)

    Name for property to get for all initial velocities in the model

    Returns

    Array of Velocity objects or properties

    Return type

    Array

    Example

    To make an array of Velocity objects for all of the initial velocities in model m: 

    var a = Velocity.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a initial velocity.

    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 initial velocity v: 

    var comm_array = v.GetComments();

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

    Description

    Returns an array of Velocity objects for all of the flagged initial velocities in a model in PRIMER If the optional property argument is not given then an array of Velocity objects is returned. If the property argument is given, then that property value for each initial velocity is returned in the array instead of a Velocity object

    Arguments

  • Model (Model)

    Model to get initial velocities from

  • flag (Flag)

    Flag set on the initial velocities that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged initial velocities in the model

    Returns

    Array of Velocity objects or properties

    Return type

    Array

    Example

    To make an array of Velocity objects for all of the initial velocities in model m flagged with f: 

    var v = Velocity.GetFlagged(m, f);

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

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

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

    Description

    Returns the Velocity object for a initial velocity ID.

    Arguments

  • Model (Model)

    Model to find the initial velocity in

  • number (integer)

    number of the initial velocity you want the Velocity object for

    Returns

    Velocity object (or null if initial velocity does not exist).

    Return type

    Velocity

    Example

    To get the Velocity object for initial velocity 100 in model m 

    var v = Velocity.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    initial velocity property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if Velocity property v.example is a parameter: 

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

    To check if Velocity property v.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this initial velocity (*INITIAL_VELOCITY). Note that a carriage return is not added. See also Velocity.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for velocity i: 

    var key = i.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the initial velocity. Note that a carriage return is not added. See also Velocity.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for velocity i: 

    var cards = i.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last initial velocity in the model.

    Arguments

  • Model (Model)

    Model to get last initial velocity in

    Returns

    Velocity object (or null if there are no initial velocities in the model).

    Return type

    Velocity

    Example

    To get the last initial velocity in model m: 

    var v = Velocity.Last(m);

    Next()

    Description

    Returns the next initial velocity in the model.

    Arguments

    No arguments

    Returns

    Velocity object (or null if there are no more initial velocities in the model).

    Return type

    Velocity

    Example

    To get the initial velocity in model m after initial velocity v: 

    var v = v.Next();

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

    Description

    Allows the user to pick a initial velocity.

    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 initial velocities from that model can be picked. If the argument is a Flag then only initial velocities that are flagged with limit can be selected. If omitted, or null, any initial velocities 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

    Velocity object (or null if not picked)

    Return type

    Velocity

    Example

    To pick a initial velocity from model m giving the prompt 'Pick initial velocity from screen': 

    var v = Velocity.Pick('Pick initial velocity from screen', m);

    Previous()

    Description

    Returns the previous initial velocity in the model.

    Arguments

    No arguments

    Returns

    Velocity object (or null if there are no more initial velocities in the model).

    Return type

    Velocity

    Example

    To get the initial velocity in model m before initial velocity v: 

    var v = v.Previous();

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

    Description

    Allows the user to select initial velocities using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting initial velocities

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

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

    Return type

    Number

    Example

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

    Velocity.Select(f, 'Select initial velocities', m);

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

    Velocity.Select(f, 'Select initial velocities', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the initial velocity.

    Arguments

  • flag (Flag)

    Flag to set on the initial velocity

    Returns

    No return value

    Example

    To set flag f for initial velocity v: 

    v.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the initial velocity. The initial velocity will be sketched until you either call Velocity.Unsketch(), Velocity.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To sketch initial velocity v: 

    v.Sketch();

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

    Description

    Sketches all of the flagged initial velocities in the model. The initial velocities will be sketched until you either call Velocity.Unsketch(), Velocity.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

    Arguments

  • Model (Model)

    Model that all the flagged initial velocities will be sketched in

  • flag (Flag)

    Flag set on the initial velocities that you want to sketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the initial velocities are sketched. If omitted redraw is true. If you want to sketch flagged initial velocities 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 initial velocities flagged with flag in model m: 

    Velocity.SketchFlagged(m, flag);

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

    Description

    Returns the total number of initial velocities in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of initial velocities

    Return type

    Number

    Example

    To get the total number of initial velocities in model m: 

    var total = Velocity.Total(m);

    Unblank()

    Description

    Unblanks the initial velocity

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank initial velocity v: 

    v.Unblank();

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

    Description

    Unblanks all of the initial velocities in the model.

    Arguments

  • Model (Model)

    Model that all initial velocities 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 initial velocities in model m: 

    Velocity.UnblankAll(m);

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

    Description

    Unblanks all of the flagged initial velocities in the model.

    Arguments

  • Model (Model)

    Model that the flagged initial velocities will be unblanked in

  • flag (Flag)

    Flag set on the initial velocities 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 initial velocities in model m flagged with f: 

    Velocity.UnblankFlagged(m, f);

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

    Description

    Unsets a defined flag on all of the initial velocities in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all initial velocities will be unset in

  • flag (Flag)

    Flag to unset on the initial velocities

    Returns

    No return value

    Example

    To unset the flag f on all the initial velocities in model m: 

    Velocity.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the initial velocity.

    Arguments

  • redraw (optional) (boolean)

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

    Returns

    No return value

    Example

    To unsketch initial velocity v: 

    v.Unsketch();

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

    Description

    Unsketches all initial velocities.

    Arguments

  • Model (Model)

    Model that all initial velocities will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not after the initial velocities 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 initial velocities in model m: 

    Velocity.UnsketchAll(m);

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

    Description

    Unsketches all flagged initial velocities in the model.

    Arguments

  • Model (Model)

    Model that all initial velocities will be unsketched in

  • flag (Flag)

    Flag set on the initial velocities that you want to unsketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the initial velocities 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 initial velocities flagged with flag in model m: 

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

    Velocity object.

    Return type

    Velocity

    Example

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

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

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

    Description

    Adds a warning for initial velocity. 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 initial velocity v: 

    v.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this initial velocity.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for initial velocity v: 

    var xrefs = v.Xrefs();

    toString()

    Description

    Creates a string containing the initial velocity data in keyword format. Note that this contains the keyword header and the keyword cards. See also Velocity.Keyword() and Velocity.KeywordCards().

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for velocity i in keyword format 

    var s = i.toString();