SetShell class

The SetShell class gives you access to shell 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:

_example
$example
ABC_example

Class functions

First(model[Model])
FlagAll(model[Model], flag[Flag])
GetAll(model[Model], property (optional)[string])
GetFlagged(model[Model], flag[Flag], property (optional)[string])
GetFromID(model[Model], label[integer])
GetFromIndex(model[Model], index[integer])
Last(model[Model])
Total(model[Model])
UnflagAll(model[Model], flag[Flag])

Member functions

AllItems()
ClearFlag(flag[Flag])
Flagged(flag[Flag])
Item(index[integer])
Next()
Previous()
SetFlag(flag[Flag])

SetShell properties

Name	Type	Description
include (read only)	integer	The include file number in the model that the shell set is in
index (read only)	integer	The internal index for the shell set in D3PLOT (starting at 0)
label (read only)	integer	The Ansys LS-DYNA label for the shell set
model (read only)	Model	The Model that the shell set is in
title (read only)	string	The title for the shell 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 shell items in the shell set
type (read only)	constant	The type for the shell set (will be Type.SET_SHELL)

Detailed Description

The SetShell 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 shell items for the shell set in the model

Arguments

No arguments

Returns

array of Shell objects

Return type

Array

Example

To get the shell items in shell set s:

var items = s.AllItems();

ClearFlag(flag[Flag])

Description

Clears a flag on a shell set

Arguments

flag (Flag)

Flag (see AllocateFlag) to clear on the shell set

Returns

No return value

Example

To clear flag f on shell set s:

s.ClearFlag();

First(model[Model]) [static]

Description

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

Arguments

model (Model)

Model to get first shell set in

Returns

SetShell object

Return type

SetShell

Example

To get the first shell set in model m:

var s = SetShell.First(m);

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

Description

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

Arguments

model (Model)

Model that all the shell sets will be flagged in

flag (Flag)

Flag (see AllocateFlag) to set on the shell sets

Returns

No return value

Example

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

SetShell.FlagAll(m, f);

Flagged(flag[Flag])

Description

Checks if the shell set is flagged or not

Arguments

flag (Flag)

Flag (see AllocateFlag) to test on the shell set

Returns

true if flagged, false if not

Return type

boolean

Example

To check if shell 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 SetShell objects or properties for all of the shell sets in the model. If the optional property argument is not given then an array of SetShell objects is returned. If the property argument is given, that property value for each shell set is returned in the array instead of a SetShell object

Arguments

model (Model)

Model that all the shell sets are in

property (optional) (string)

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

Returns

Array of SetShell objects or properties

Return type

Array

Example

To get all of the shell sets in model m:

var s = SetShell.GetAll(m);

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

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

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

Description

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

Arguments

model (Model)

Model that the flagged shell sets are in

flag (Flag)

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

property (optional) (string)

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

Returns

Array of SetShell objects or properties

Return type

Array

Example

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

SetShell.GetFlagged(m, f);

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

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

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

Description

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

Arguments

model (Model)

Model to get shell set in

label (integer)

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

Returns

SetShell object

Return type

SetShell

Example

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

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

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

Description

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

Arguments

model (Model)

Model to get shell set in

index (integer)

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

Returns

SetShell object

Return type

SetShell

Example

To get the 51st shell set in model m:

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

Item(index[integer])

Description

Returns a shell item from the shell set in the model

Arguments

index (integer)

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

Returns

Shell object

Return type

Shell

Example

To get the 10th shell in shell set s:

var items = s.Item(9);

Last(model[Model]) [static]

Description

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

Arguments

model (Model)

Model to get last shell set in

Returns

SetShell object

Return type

SetShell

Example

To get the last shell set in model m:

var s = SetShell.Last(m);

Next()

Description

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

Arguments

No arguments

Returns

SetShell object

Return type

SetShell

Example

To get the next shell set after shell set s:

s = s.Next();

Previous()

Description

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

Arguments

No arguments

Returns

SetShell object

Return type

SetShell

Example

To get the previous shell set before shell set s:

s = s.Previous();

SetFlag(flag[Flag])

Description

Sets a flag on a shell set

Arguments

flag (Flag)

Flag (see AllocateFlag) to set on the shell set

Returns

No return value

Example

To set flag f on shell set s:

s.SetFlag(f);

Total(model[Model]) [static]

Description

Returns the total number of shell sets in the model

Arguments

model (Model)

Model to get total in

Returns

The number of shell sets

Return type

integer

Example

To get the number of shell sets in model m:

var total = SetShell.Total(m);

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

Description

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

Arguments

model (Model)

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

flag (Flag)

Flag (see AllocateFlag) to unset on the shell sets

Returns

No return value

Example

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

SetShell.UnflagAll(m, f);