SetSolid class

The SetSolid class gives you access to solid sets in D3PLOT. More...

The D3PLOT 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

SetSolid properties

Name Type Description
include (read only) integer The include file number in the model that the solid set is in
index (read only) integer The internal index for the solid set in D3PLOT (starting at 0)
label (read only) integer The Ansys LS-DYNA label for the solid set
model (read only) Model The Model that the solid set is in
title (read only) string The title for the solid set (or null if no title). This is only available if there is a ztf file for the model. If not null will be returned.
total (read only) integer The total number of solid items in the solid set
type (read only) constant The type for the solid set (will be Type.SET_SOLID)

Detailed Description

The SetSolid class allows you to view sets in D3PLOT. There are various methods and properties available. This class requires a ztf file to be present for the model. See the documentation below for more details.

Details of functions

AllItems()

Description

Returns all of the solid items for the solid set in the model

Arguments

No arguments

Returns

array of Solid objects

Return type

Array

Example

To get the solid items in solid set s: 

var items = s.AllItems();

ClearFlag(flag[Flag])

Description

Clears a flag on a solid set

Arguments

  • flag (Flag)

    Flag (see AllocateFlag) to clear on the solid set

    Returns

    No return value

    Example

    To clear flag f on solid set s: 

    s.ClearFlag();

    First(model[Model]) [static]

    Description

    Returns the first solid set in the model (or null if there are no solid sets in the model)

    Arguments

  • model (Model)

    Model to get first solid set in

    Returns

    SetSolid object

    Return type

    SetSolid

    Example

    To get the first solid set in model m: 

    var s = SetSolid.First(m);

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

    Description

    Flags all of the solid sets in the model with a defined flag

    Arguments

  • model (Model)

    Model that all the solid sets will be flagged in

  • flag (Flag)

    Flag (see AllocateFlag) to set on the solid sets

    Returns

    No return value

    Example

    To flag all of the solid sets with flag f in model m: 

    SetSolid.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the solid set is flagged or not

    Arguments

  • flag (Flag)

    Flag (see AllocateFlag) to test on the solid set

    Returns

    true if flagged, false if not

    Return type

    boolean

    Example

    To check if solid set s has flag f set on it: 

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

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

    Description

    Returns an array of SetSolid objects or properties for all of the solid sets in the model. If the optional property argument is not given then an array of SetSolid objects is returned. If the property argument is given, that property value for each solid set is returned in the array instead of a SetSolid object

    Arguments

  • model (Model)

    Model that all the solid sets are in

  • property (optional) (string)

    Name for property to get for all solid sets in the model

    Returns

    Array of SetSolid objects or properties

    Return type

    Array

    Example

    To get all of the solid sets in model m: 

    var s = SetSolid.GetAll(m);

    To return an array containing the value of property 'foo' (for example 'label' for a solid set) for each solid set in model m: 

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

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

    Description

    Gets all of the solid sets in the model flagged with a defined flag. If the optional property argument is not given then an array of SetSolid objects is returned. If the property argument is given, that property value for each solid set is returned in the array instead of a SetSolid object

    Arguments

  • model (Model)

    Model that the flagged solid sets are in

  • flag (Flag)

    Flag (see AllocateFlag) set on the solid sets to get

  • property (optional) (string)

    Name for property to get for all flagged solid sets in the model

    Returns

    Array of SetSolid objects or properties

    Return type

    Array

    Example

    To get all of the solid sets flagged with flag f in model m: 

    SetSolid.GetFlagged(m, f);

    To return an array containing the value of property 'foo' (for example 'label' for a node) for all solid sets flagged with flag f in model m: 

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

    GetFromID(model[Model], label[integer]) [static]

    Description

    Returns the SetSolid object for solid set in model with label (or null if it does not exist)

    Arguments

  • model (Model)

    Model to get solid set in

  • label (integer)

    The Ansys LS-DYNA label for the solid set in the model

    Returns

    SetSolid object

    Return type

    SetSolid

    Example

    To get the solid set in model m with label 1000: 

    var s = SetSolid.GetFromID(m, 1000);

    GetFromIndex(model[Model], index[integer]) [static]

    Description

    Returns the SetSolid object for solid set in model with index (or null if it does not exist)

    Arguments

  • model (Model)

    Model to get solid set in

  • index (integer)

    The D3PLOT internal index in the model for solid set, starting at 0.

    Returns

    SetSolid object

    Return type

    SetSolid

    Example

    To get the 51st solid set in model m: 

    var s = SetSolid.GetFromIndex(m, 50);

    Item(index[integer])

    Description

    Returns a solid item from the solid set in the model

    Arguments

  • index (integer)

    The index in the solid set to get the solid from (0 <= index < total)

    Returns

    Solid object

    Return type

    Solid

    Example

    To get the 10th solid in solid set s: 

    var items = s.Item(9);

    Last(model[Model]) [static]

    Description

    Returns the last solid set in the model (or null if there are no solid sets in the model)

    Arguments

  • model (Model)

    Model to get last solid set in

    Returns

    SetSolid object

    Return type

    SetSolid

    Example

    To get the last solid set in model m: 

    var s = SetSolid.Last(m);

    Next()

    Description

    Returns the next solid set in the model (or null if there is not one)

    Arguments

    No arguments

    Returns

    SetSolid object

    Return type

    SetSolid

    Example

    To get the next solid set after solid set s: 

    s = s.Next();

    Previous()

    Description

    Returns the previous solid set in the model (or null if there is not one)

    Arguments

    No arguments

    Returns

    SetSolid object

    Return type

    SetSolid

    Example

    To get the previous solid set before solid set s: 

    s = s.Previous();

    SetFlag(flag[Flag])

    Description

    Sets a flag on a solid set

    Arguments

  • flag (Flag)

    Flag (see AllocateFlag) to set on the solid set

    Returns

    No return value

    Example

    To set flag f on solid set s: 

    s.SetFlag(f);

    Total(model[Model]) [static]

    Description

    Returns the total number of solid sets in the model

    Arguments

  • model (Model)

    Model to get total in

    Returns

    The number of solid sets

    Return type

    integer

    Example

    To get the number of solid sets in model m: 

    var total = SetSolid.Total(m);

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

    Description

    Unsets a defined flag on all of the solid sets in the model

    Arguments

  • model (Model)

    Model that the defined flag for all solid sets will be unset in

  • flag (Flag)

    Flag (see AllocateFlag) to unset on the solid sets

    Returns

    No return value

    Example

    To unset flag f on all of the solid sets in model m: 

    SetSolid.UnflagAll(m, f);