Data

Returns

Example

// Does the filtering for the (scalar) X stress of part elements at integration point 2,
// checking if they are greater than 0.1
var a = GetConditionParts(Component.SXX, 0.1, Constant.GT, 2);

// Does the filtering for the yield utilisation factor of part elements (looping through all
// integration points), checking if they are greater than or equals to 1.0
var b = GetConditionParts(Component.YUTF, 1.0, Constant.GTEQ);

GetContourLimit(mode[integer], component (optional)[string]) [static]

Description

Returns the maximum/ minimum contour plot value of <component> specified for the current window. Returns null if <component> specified is not active.

Returns

real (or null if <component> specified is not active)

Return type

Number

Example

// Gets the minimum contour plot value for Scalar 1
s1min = GetContourLimit(Constant.MIN, "SCALAR_1");

// Gets the maximum contour plot value for Scalar 2
s2max = GetContourLimit(Constant.MAX, "SCALAR_2");

// Gets the minimum contour plot value for Vector
v1min = GetContourLimit(Constant.MIN, "VECTOR_1");

// Gets the maximum contour plot value for "Vel"
v2max = GetContourLimit(Constant.MAX, "VECTOR_2");

GetData(component[integer], type_code[integer], item[integer], int_pt (optional)[object | integer], extra (optional)[integer], fr_of_ref (optional)[integer], state_id (optional)[integer], dda (optional)[integer], consider_blanking (optional)[integer], mag_or_cur (optional)[integer]) [static]

Description

Returns the data for <component> of type <type_code> for the single <item>

WARNING: If the function arguments are grammatically correct but the requested data component is not present in the database, then 1, 3 or 6 zeros are returned as required, and no warning message is output. Therefore it is good practice to use function QueryDataPresent() to check that an optional data component is actually present in a database before attempting to extract its values.

In other words instead of something like this, calling GetData()for each item individually:

for(item=item_1; item<=item_2; item++)
{
    result = GetData(component, type, item, ...);
}

You can write the following to extract data into an array of results using a single call to GetMultipleData():

result = GetMultipleData(component, type, item_1, item_2, ...);

This reduces the time taken to extract data by a factor nearly equal to #items, and for a large model this can give a dramatic speed increase.

Returns

real|Array of reals

Return type

Number

Example

// Returns the (scalar) X stress of internal shell #27 at integration point 2, in the element local coordinate system.
var a = GetData(Component.SXX, Type.SHELL, 27, 2, 0, Constant.LOCAL);

// Returns the (scalar) X stress of the shell with external label 123 with the same options.
var a = GetData(Component.SXX, Type.SHELL, -123, 2, 0, Constant.LOCAL);

// Returns an array[6] of the strain tensor in solid element#93, implicitly in the global coordinate system.
var b = GetData(Component.ETEN, Type.SOLID, 93);
var sxx = b[Constant.XX];
var sxy = b[Constant.XY];

// Returns an array[3] of the 2nd user-defined Nodal Vector component at internal node #inode at state #3.
var c = GetData(Component.UNOV, Type.NODE, inode,0, 2, 0, 3);
var vx = c[Constant.X];
var vy = c[Constant.Y];
var vz = c[Constant.Z];

// For an anlysis with phase angles returns the DZ displacement of internal node #1 at the second frame of state 3.
// (Note that the state has to be set with both SetCurrentState() and a DialogueInput() command to get CURRENT_VAL
// to work as this works off the current settings in the graphics window and SetCurrentState() does not update the
// graphics window, it is only used internally by the Javascript interface).
SetCurrentState(3);
DialogueInput("/STATE 3");
SetWindowFrame(1, 2);
var a = GetData(Componnent.DZ, Type.NODE, 1, 0, 0, 0, 0, Constant.OFF, Constant.OFF, Constant.CURRENT_VAL);

GetMultipleData(component[integer], type_code[integer], item_1[integer], item_2[integer], int_pt (optional)[object | integer], extra (optional)[integer], fr_of_ref (optional)[integer], state_id (optional)[integer], dda (optional)[integer], consider_blanking (optional)[integer], mag_or_cur (optional)[integer]) [static]

Description

Returns the data for <component> of type <type_code> for the range of items <item1 .. item2>

WARNING #1: If the function arguments are grammatically correct but the requested data component is not present in the database, then 1, 3 or 6 zeros are returned as required, and no warning message is output. Therefore it is good practice to use function QueryDataPresent() to check that an optional data component is actually present in a database before attempting to extract its values.

WARNING #2: It is possible to extract vary large quantities of data using a single call of this function. Bear in mind that JavaScript representations of values are quite bloated, for example all "numbers"are 64 bit (8 byte) floating double format, and the language imposes further overheads because of the way it organises data. For large models it may be necessary to extract large blocks of data in several smaller chunks, rather than one big one.

WARNING #3: The data return value from this function is an array of length #rows, and the subscripts of this array start at row 0. In other words the result for item_1 in the call below will be returned in results array row data[0]. When extracting results for all items of a type, for example all shells in a model, item_1 will typically be 1, and it is easy to make the mistake of expecting this to be in results array row data[1]. In addition when you extract data for vector or tensor data the result will be a two-dimensional array, aligned data[#cols][#rows]. See the examples at the bottom of this description for more information about using two-dimensional arrays.

Returns

• data[#rows] for data components that return a scalar value, eg DX
• data[#cols][#rows] for data components that return a vector or tensor value, eg UNOV

Take care when dealing with the two-dimensional array of results returned by the vector and tensor component cases, as the order in which the data is stored is [column][row]. For example if you have a tensor component then in order to extract the XY shear term for index you need to write:

r = GetMultipleData(args...)

shear_term = r.data[Constant.XY][index];

Also remember that the rows in this array start at index 0, thus the results for item_1 will be row index [0] in the array of results returned, and so on.

Example

// Returns the (scalar) X stress of internal shells #1 to #100 inclusive at integration
// point 2, in the element local coordinate system
a = GetMultipleData(Component.SXX, Type.SHELL, 1, 100, 2, 0, Constant.LOCAL);
sxx = a.data[0];  // X stress in first shell
sxx = a.data[99]; // X stress in 100th shell

// Returns an array[6] of the strain tensor in solid elements #1 to #100, implicitly in the
// global coordinate system.
b = GetMultipleData(Component.ETEN, Type.SOLID, 1, 100);
sxx = b.data[Constant.XX][0];  // X strain in 1st solid
sxy = b.data[Constant.XY][99]; // XY strain in 100th solid

// Returns an array[3] of the 2nd user-defined Nodal Vector component at nodes with external
// labels 1 to 100 at state #3.
// Note that when a range of external labels is supplied, ie -ve values for <item_1> and <item_2>,
// you should check the .nr return value to see how many rows of results were actually returned, since
// if there are gaps in that label range the result may not be |item_2| - |item_1| + 1.

c = GetMultipleData(Component.UNOV, Type.NODE, -1, -100, 0, 2, 0, 3);

nres = c.nr; // Number of rows of data returned
vx = c.data[Constant.X][0]; // X component for 1st node
vy = c.data[Constant.Y][1]; // Y component for 2nd node
vz = c.data[Constant.Z][2]; // Z component for 3rd node

GetNumOnPlanIntPts(type_code[integer], item[integer], state_id (optional)[integer]) [static]

Description

Returns the number of on plan points in an element in the current model

Returns

integer

Return type

Number

Example

// Return the number of on plan points in the first SHELL element in the current model
var a = GetNumOfPlanIntPts(Type.SHELL, 1);

GetNumberOf(type_code[integer], options (optional)[object]) [static]

Description

Returns the number of items of type_code in the current model

Note that in adaptively remeshed models the current family may affect the number of nodes and elements returned. The family of the current state will be used unless you supply the optional state_id argument, in which case the family of that state will be used.

Notes:

The number of models returned by GetNumberOf(Type.MODEL) is actually the number of active and inactive model "slots" in the database, including those currently not in use. This means that it will always return the highest model number that has been used to date.

Therefore the following sequence:

• Read in (say) three models M1 to M3
• Delete models M1 and M2, leaving only M3 in use

Will result in GetNumberOf(Type.MODEL) returning the value 3.

You can use SetCurrentModel(model_id) to attempt to set a model and examine its return value to see whether it succeeded or failed:

n = GetNumberOf(Type.MODEL);

for(i=1; i<=n; i++)
{
    if(SetCurrentModel(i))  // TRUE if present
    {
        do something
    }
}

Returns

integer

Return type

Number

Example

// Return the number of models
var a = GetNumberOf(Type.MODEL);

// Return the number of shell integration points
var a = GetNumberOf(Constant.NIP_S);

// Return the number of solid elements in family of state 20
var a = GetNumberOf(Type.SOLID, { state_id:20 });

GetNumberOf(type_code[integer], state_id (optional)[integer]) [static]  [deprecated]

This function is deprecated in version 19.0. It is only provided to keep old scripts working. We strongly advise against using it in new scripts. Support may be removed in future versions.

Description

Returns the number of items of type_code in the current model

Also see the notes at the non-deprecated function with the same name.

Returns

integer

Return type

Number

Example

// Return the number of models
var a = GetNumberOf(Type.MODEL);

// Return the number of shell integration points
var a = GetNumberOf(Constant.NIP_S);

// Return the number of solid elements in family of state 20
var a = GetNumberOf(Type.SOLID, 20);

QueryDataPresent(component[integer], type_code (optional)[integer]) [static]

Description

Returns true if data <component> is present in the current model's database, otherwise false. For some data components that are switchable the <type_code> must also be supplied, these are listed below.

Returns

boolean

Return type

Boolean

Example

// Returns true if Effective Plastic Strain exists for solid
var a = QueryDataPresent(Component.EPL, Type.SOLID);

// Returns true if nodal temperatures exist
var a = QueryDataPresent(Component.TEMP);