VelocityGeneration class

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

VelocityGeneration constants

Name Description
VelocityGeneration.NODE_SET ID is a NODE_SET
VelocityGeneration.PART ID is a PART
VelocityGeneration.PART_SET ID is a PART_SET

VelocityGeneration properties

Name Type Description
exists (read only) logical true if initial velocity generation exists, false if referred to but not defined.
icid integer Local coordinate system
id integer Set Part ID, Part set ID or Node set ID
include integer The Include file number that the initial velocity generation is in.
irigid integer Overide part inertia flag
ivatn integer Tracked parts flag
model (read only) integer The Model number that the initial velocity generation is in.
nx real x-direction cosine
ny real y-direction cosine
nz real z-direction cosine
omega real Angular velocity about the rotational axis
phase integer Dynamic relaxation flag
type constant Specify the type of Velocity generation (Can be VelocityGeneration.PART_SET or VelocityGeneration.PART or VelocityGeneration.NODE_SET)
vx real Initial translational velocity in X direction
vy real Initial translational velocity in Y direction
vz real Initial translational velocity in Z direction
xc real x-coordinate on rotational axis
yc real y-coordinate on rotational axis
zc real z-coordinate on rotational axis

Detailed Description

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

Constructor

new VelocityGeneration(Model[Model], type[constant], id[integer], omega[real], vx[real], vy[real], vz[real], ivatn[integer], xc[real], yc[real], zc[real], nx[real], ny[real], nz[real], phase[integer], irigid[integer], icid[integer])

Description

Create a new VelocityGeneration object.

Arguments

  • Model (Model)

    Model that velocity will be created in

  • type (constant)

    Specify the type of Velocity generation (Can be VelocityGeneration.PART_SET or VelocityGeneration.PART or VelocityGeneration.NODE_SET)

  • id (integer)

    Set Part ID, Part set ID or Node set ID

  • omega (real)

    Angular velocity about the rotational axis

  • vx (real)

    Initial translational velocity in X direction

  • vy (real)

    Initial translational velocity in Y direction

  • vz (real)

    Initial translational velocity in Z direction

  • ivatn (integer)

    Tracked parts flag

  • xc (real)

    x-coordinate on rotational axis

  • yc (real)

    y-coordinate on rotational axis

  • zc (real)

    z-coordinate on rotational axis

  • nx (real)

    x-direction cosine

  • ny (real)

    y-direction cosine

  • nz (real)

    z-direction cosine

  • phase (integer)

    Dynamic relaxation flag

  • irigid (integer)

    Overide part inertia flag

  • icid (integer)

    Local coordinate system

    Returns

    VelocityGeneration object

    Return type

    VelocityGeneration

    Example

    To create a new velocity in model m 

    var s = new VelocityGeneration(m, VelocityGeneration.PART, 500, 3.4, 2.4, 3.7, 7.9, 0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1, 0);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a initial velocity generation.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the initial velocity generation

    Returns

    No return value

    Example

    To associate comment c to the initial velocity generation ivg: 

    ivg.AssociateComment(c);

    Blank()

    Description

    Blanks the initial velocity generation

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank initial velocity generation ivg: 

    ivg.Blank();

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

    Description

    Blanks all of the initial velocity generations in the model.

    Arguments

  • Model (Model)

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

    VelocityGeneration.BlankAll(m);

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

    Description

    Blanks all of the flagged initial velocity generations in the model.

    Arguments

  • Model (Model)

    Model that all the flagged initial velocity generations will be blanked in

  • flag (Flag)

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

    VelocityGeneration.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the initial velocity generation is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if initial velocity generation ivg is blanked: 

    if (ivg.Blanked() ) do_something...

    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 initial velocity generation ivg: 

    ivg.Browse();

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the initial velocity generation.

    Arguments

  • flag (Flag)

    Flag to clear on the initial velocity generation

    Returns

    No return value

    Example

    To clear flag f for initial velocity generation ivg: 

    ivg.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

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

    VelocityGeneration object

    Return type

    VelocityGeneration

    Example

    To copy initial velocity generation ivg into initial velocity generation z: 

    var z = ivg.Copy();

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

    Description

    Starts an interactive editing panel to create a initial velocity generation

    Arguments

  • Model (Model)

    Model that the initial velocity generation 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

    VelocityGeneration object (or null if not made).

    Return type

    VelocityGeneration

    Example

    To start creating a initial velocity generation in model m: 

    var ivg = VelocityGeneration.Create(m);

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a initial velocity generation.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the initial velocity generation

    Returns

    No return value

    Example

    To detach comment c from the initial velocity generation ivg: 

    ivg.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 initial velocity generation ivg: 

    ivg.Edit();

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

    Description

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

    ivg.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first initial velocity generation in the model.

    Arguments

  • Model (Model)

    Model to get first initial velocity generation in

    Returns

    VelocityGeneration object (or null if there are no initial velocity generations in the model).

    Return type

    VelocityGeneration

    Example

    To get the first initial velocity generation in model m: 

    var ivg = VelocityGeneration.First(m);

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

    Description

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

    Arguments

  • Model (Model)

    Model that all initial velocity generations will be flagged in

  • flag (Flag)

    Flag to set on the initial velocity generations

    Returns

    No return value

    Example

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

    VelocityGeneration.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the initial velocity generation is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the initial velocity generation

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model that all initial velocity generations are in

  • func (function)

    Function to call for each initial velocity generation

  • 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 velocity generations in model m: 

    VelocityGeneration.ForEach(m, test);
function test(ivg)
{
// ivg is VelocityGeneration object
}

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

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

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

    Description

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

    Arguments

  • Model (Model)

    Model to get initial velocity generations from

  • property (optional) (string)

    Name for property to get for all initial velocity generations in the model

    Returns

    Array of VelocityGeneration objects or properties

    Return type

    Array

    Example

    To make an array of VelocityGeneration objects for all of the initial velocity generations in model m: 

    var a = VelocityGeneration.GetAll(m);

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

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

    GetComments()

    Description

    Extracts the comments associated to a initial velocity generation.

    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 generation ivg: 

    var comm_array = ivg.GetComments();

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

    Description

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

    Arguments

  • Model (Model)

    Model to get initial velocity generations from

  • flag (Flag)

    Flag set on the initial velocity generations that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged initial velocity generations in the model

    Returns

    Array of VelocityGeneration objects or properties

    Return type

    Array

    Example

    To make an array of VelocityGeneration objects for all of the initial velocity generations in model m flagged with f: 

    var ivg = VelocityGeneration.GetFlagged(m, f);

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

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

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

    Description

    Returns the VelocityGeneration object for a initial velocity generation ID.

    Arguments

  • Model (Model)

    Model to find the initial velocity generation in

  • number (integer)

    number of the initial velocity generation you want the VelocityGeneration object for

    Returns

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

    Return type

    VelocityGeneration

    Example

    To get the VelocityGeneration object for initial velocity generation 100 in model m 

    var ivg = VelocityGeneration.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

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

    Arguments

  • prop (string)

    initial velocity generation property to get parameter for

    Returns

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

    Return type

    Parameter

    Example

    To check if VelocityGeneration property ivg.example is a parameter: 

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

    To check if VelocityGeneration property ivg.example is a parameter by using the GetParameter method: 

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

    Keyword()

    Description

    Returns the keyword for this initial velocity (*INITIAL_VELOCITY_GENERATION). Note that a carriage return is not added. See also VelocityGeneration.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_generation. Note that a carriage return is not added. See also VelocityGeneration.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 generation in the model.

    Arguments

  • Model (Model)

    Model to get last initial velocity generation in

    Returns

    VelocityGeneration object (or null if there are no initial velocity generations in the model).

    Return type

    VelocityGeneration

    Example

    To get the last initial velocity generation in model m: 

    var ivg = VelocityGeneration.Last(m);

    Next()

    Description

    Returns the next initial velocity generation in the model.

    Arguments

    No arguments

    Returns

    VelocityGeneration object (or null if there are no more initial velocity generations in the model).

    Return type

    VelocityGeneration

    Example

    To get the initial velocity generation in model m after initial velocity generation ivg: 

    var ivg = ivg.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 generation.

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

    VelocityGeneration object (or null if not picked)

    Return type

    VelocityGeneration

    Example

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

    var ivg = VelocityGeneration.Pick('Pick initial velocity generation from screen', m);

    Previous()

    Description

    Returns the previous initial velocity generation in the model.

    Arguments

    No arguments

    Returns

    VelocityGeneration object (or null if there are no more initial velocity generations in the model).

    Return type

    VelocityGeneration

    Example

    To get the initial velocity generation in model m before initial velocity generation ivg: 

    var ivg = ivg.Previous();

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

    Description

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

    Arguments

  • flag (Flag)

    Flag to use when selecting initial velocity generations

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

    Return type

    Number

    Example

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

    VelocityGeneration.Select(f, 'Select initial velocity generations', m);

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

    VelocityGeneration.Select(f, 'Select initial velocity generations', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the initial velocity generation.

    Arguments

  • flag (Flag)

    Flag to set on the initial velocity generation

    Returns

    No return value

    Example

    To set flag f for initial velocity generation ivg: 

    ivg.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

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

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the initial velocity generation is sketched. If omitted redraw is true. If you want to sketch several initial velocity generations 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 generation ivg: 

    ivg.Sketch();

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

    Description

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

    Arguments

  • Model (Model)

    Model that all the flagged initial velocity generations will be sketched in

  • flag (Flag)

    Flag set on the initial velocity generations that you want to sketch

  • redraw (optional) (boolean)

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

    VelocityGeneration.SketchFlagged(m, flag);

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

    Description

    Returns the total number of initial velocity generations in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

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

    Returns

    number of initial velocity generations

    Return type

    Number

    Example

    To get the total number of initial velocity generations in model m: 

    var total = VelocityGeneration.Total(m);

    Unblank()

    Description

    Unblanks the initial velocity generation

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank initial velocity generation ivg: 

    ivg.Unblank();

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

    Description

    Unblanks all of the initial velocity generations in the model.

    Arguments

  • Model (Model)

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

    VelocityGeneration.UnblankAll(m);

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

    Description

    Unblanks all of the flagged initial velocity generations in the model.

    Arguments

  • Model (Model)

    Model that the flagged initial velocity generations will be unblanked in

  • flag (Flag)

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

    VelocityGeneration.UnblankFlagged(m, f);

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

    Description

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

    Arguments

  • Model (Model)

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

  • flag (Flag)

    Flag to unset on the initial velocity generations

    Returns

    No return value

    Example

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

    VelocityGeneration.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the initial velocity generation.

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the initial velocity generation is unsketched. If omitted redraw is true. If you want to unsketch several initial velocity generations 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 generation ivg: 

    ivg.Unsketch();

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

    Description

    Unsketches all initial velocity generations.

    Arguments

  • Model (Model)

    Model that all initial velocity generations will be unblanked in

  • redraw (optional) (boolean)

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

    VelocityGeneration.UnsketchAll(m);

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

    Description

    Unsketches all flagged initial velocity generations in the model.

    Arguments

  • Model (Model)

    Model that all initial velocity generations will be unsketched in

  • flag (Flag)

    Flag set on the initial velocity generations that you want to unsketch

  • redraw (optional) (boolean)

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

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

    VelocityGeneration object.

    Return type

    VelocityGeneration

    Example

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

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

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

    Description

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

    ivg.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this initial velocity generation.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for initial velocity generation ivg: 

    var xrefs = ivg.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 VelocityGeneration.Keyword() and VelocityGeneration.KeywordCards().

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for velocity i in keyword format 

    var s = i.toString();