LS-PrePost Scripting Command Language and Data Center

Rev. 1
Date revised: Aug 08, 2016
By Philip Ho

Introduction
The LS-PrePost Scripting Command Language (SCL) is designed to allow a user
to write their own script to perform data manipulation for many different
purposes. The LS-PrePost SCL is a C like computer language that is executed
inside LS-PrePost. The user can execute LS-PrePost commands, retrieve results,
apply LS-DYNA data center extraction functions, and extract results from LSDYNA d3plot files and model data in the keyword input file. Also, perform
additional operations to the extracted data that were not developed within LSPrePost. The resultant data can be output to the LS-PrePost message file, a user
created file, or send it back to LS-PrePost for fringing or plotting. This document
describes the application functions interface (API) and how to use SCL along
with some example scripts for various operations.

API Functions
void ExecuteCommand(char *cmd)
Purpose:
Execute a LS-PrePost command
Input:
cmd - a string contains the LS-PrePost command
Return:
none
...............................................................................................................................
void Echo(char *string)
Purpose:
Display the text in the LS-PrePost message dialog and in the
lspost.msg file
Input:
string - text string
Output:
none
Return:
none
...............................................................................................................................
Int SCLSwitchStateTo(Int ist)
Purpose:
Switch the current state to a specified state
Input:
ist - state number, 0 > ist <= largest state

Output:
none
Return:
flag, 1=success, 0=fail
...............................................................................................................................
Int SCLGetDataCenterInt(char *parameter_name)
Purpose : Get an integer scalar value from the model. See user parameter
name list below for the available scalar values that can be retrieved.
Input:
parameter name
Output:
none
Return:
integer value
...............................................................................................................................
Float SCLGetDataCenterFloat(char *parameter_name, Int typecode, Int index,
Int ipt)
Purpose : Get a floating point value from the model. See Data Center
Parameter Name List below for the available floating point value that
can be retrieved.
Input:
parameter name
Typecode - Element or node type, constants such as "SOLID",
"SHELL", "BEAM", "TSHELL", "NODE","SPHNODE" can be
used. Not used for the parameter_name, enter as zero.
Index - Index to the component array.
Ipt - Integration points. Only valid for component values from
element shell, beam and tshell, such as "MID", "INNER", "OUTER",
1, 2, etc, can be used.
Output:
none
Return:
float value
...............................................................................................................................
void SCLGetDataCenterVector(char *parameter_name, Int externalid,
NDCOOR *result)
Purpose:
Get a vector from the model data, a vector such as nodal coordinate,
displacement vector, velocity vector, acceleration vector, and so on.
typedef ndcoor {
Float xyz[3];
} NDCOOR;
Input:
parameter_name
Externalid - Index in the component value array.
Output:
result: vector
Return:
none

...............................................................................................................................
void SCLGetDataCenterTensor(char *parameter_name, Int elementType, Int
externalid, Int ipt, TENSOR *result)
Purpose: Get stress/strain tensor from the model data.
typedef tensor{
Float xyz[6];
} TENSOR;
Input:
parameter name
elementType - "SOLID", "SHELL","TSHELL","SPHNODE" can be
used.
Externalid - Index in the component tensor array.
Ipt - Integaration points or layer. Only used for getting component
values from shell, beam and tshell, such as "MID", "INNER",
"OUTER", 1, 2, etc, can be used.
Output:
result - tensor
Return:
none
...............................................................................................................................
Int SCLGetDataCenterIntArray(char *parameter_name, Int **results,Int type,
Int id)
Purpose:
Get an integer array from the model data
Input:
parameter_name
type - element type, (only if parameter is element_connectivity)
id - element id. (only if parameter is element_connectivity)
Output:
results - integer array
Return:
array size
...............................................................................................................................
Int SCLGetDataCenterFloatArray(char *parameter_name, Int typecode, Int ipt,
Float **results)
Purpose:
Get a floating point array from the model data
Input:
parameter_name
Typecode - Element type or node type, constant such as "SOLID",
"SHELL", "BEAM", "TSHELL", "NODE","SPHNODE" can be
used. Not used for the parameter_name, enter zero.
Ipt - Integration points or layer. Only valid for getting component
values from shell, beam and tshell, such as "MID", "INNER",
"OUTER", 1, 2, etc, can be used.
Output:
results - float array

Return:
array size
...............................................................................................................................
Int SCLGetDataCenterVectorArray(char *parameter_name, NDCOOR
**results)
Purpose:
Get a vector array from the model data
Input:
parameter_name
Output:
results: vector array
Return:
array size
...............................................................................................................................
Int SCLGetDataCenterTensorArray(char *parameter_name, Int typecode,
Int ipt, TENSOR **results)
Purpose:
Get a stress or strain tensor from the model data
Input:
parameter_name
Typecode - Element type or node type, constant such as "SOLID",
"SHELL", "BEAM", "TSHELL", "NODE","SPHNODE" can be
used. If it parameter is not needed, please give it zero.
Ipt - Integration points or layer. Only valid for getting component
values from element shell, beam and tshell, such as "MID",
"INNER", "OUTER", 1, 2, etc, can be used.
Output:
results: tensor array
Return:
array size
...............................................................................................................................
void SCLFringeDCToModel(Int typecode, Int avg_opt, Int num, Float* data, Int
ist, char *label)
Purpose:
Fringe the data center array to current model.
Input:
typecode - Node or element type, constant such as "NODE",
"0","SOLID","BEAM","SHELL","TSHELL","SPHNODE" can be
used.
avg_opt nodal averaging option, 0=none, 1=nodal
num - array size
data - Float array
ist - State number which data will be assigned
Label - Name of the fringing data to be shown on fringe plot
Output:
none
Return:
none
...............................................................................................................................

void SCLSaveDCToFile(char *filename, Int num, Float *data)

Purpose:
Save the data center array to file.
Input:
filename - name of output file.
Num - array size
Data - Float array
Output:
none
Return:
none
...............................................................................................................................
Int SCLCmdResultGetValueCount(void)
Purpose:
Get number of results from a LS-PrePost command.
Input:
none
Output:
none
Return:
Number of command results.
...............................................................................................................................
Int SCLCmdResultGetValue(Int i, Int *type, Int *iv, Float *v)
Purpose: Get value of command results.
Input:
i - Index of command results. (starting from 0)
Output:
type - Type of command results. 0=integer, 1=float
depends on the data type, one of the following will be used
iv - the integer result
v - the floating point result in double word.
Return:
status flag, 1=success, 0=fail
...............................................................................................................................
Int SCLGetUserId(Int iid, Int dtype)
Purpose: Get the user defined id given an internal id.
Input:
iid - Internal id, starting with 0
Dtype - Data type, constant such as NODE, PART, SHELL, SOLID,
TSHELL, BEAM, DISCRETE, SEATBELT, SPHNODE can be
used.
Output:
none
Return:
user id
...............................................................................................................................
Int SCLGetInternalID(Int uid, Int dtype)
purpose: Get internal id given an user id.
Input:
uid - User id.
Dtype - Data type, constant such as NODE, PART, SHELL, SOLID,

TSHELL, BEAM, DISCRETE, SEATBELT, SPHNODE can be

used.
Output:
none
Return:
Internal id, starting with 0
...............................................................................................................................
Int SCLCheckIfPartIsActiveU(Int uid)
Purpose: Check if a part is active (visible) given a user defined part id
Input:
uid - User id.
Output:
none
Return:
visibility flag, 1 is visible, 0 is invisible.
...............................................................................................................................
Int SCLCheckIfPartIsActiveI(Int iid)
Purpose:
Check if a part is active (visible) given an internal part id.
Input:
iid - internal id.
Output:
none
Return:
visibility flag, 1 is visible, 0 is invisible.
...............................................................................................................................
Int SCLCheckIfElementIsActiveU(Int uid, Int dtype)
Purpose:
Check if an element part is active (visible) given an users element id.
Input:
uid - User id.
Dtype - Data type, constant such as SHELL, SOLID, TSHELL,
BEAM, SPHNODE can be used.
Output:
none
Return:
visibility flag, 1 is visible, 0 is invisible
...............................................................................................................................
Int SCLCheckIfElementisActiveI(Int iid, Int dtype)
Purpose:
Check if an element is active (visible) given an internal id.
Input:
iid - Internal id.
Dtype - Data type, constant such as SHELL, SOLID, TSHELL,
BEAM, SPHNODE can be used.
Output:
none
Return:
visibility flag, 1 is visible, 0 is invisible.
...............................................................................................................................
Int SCLInquiryPartTypeU(Int uid)
Purpose:
Check the type of element for a given user defined part id.

Input:
Output:
Return:

uid user defined external ID for part

none
element type code:
1 BEAM, 2 SHELL, 3 SOLID, 4 TSHELL
5 NRBODY, 6 MASS, 7 DISCRETE, 8 SEATBELT
9 INERTIA, 10 RGSURF, 11 SPHNODE,
12 FLUID, 13 NURBSPATCH, 14 - PARTICLE

...............................................................................................................................
Int SCLInquiryPartTypeI(Int iid)
Purpose:
Check the type of element for a given internal part id.
Input:
iid internal ID for part
Output:
none
Return:
element type code:
1 BEAM, 2 SHELL, 3 SOLID, 4 TSHELL
5 NRBODY, 6 MASS, 7 DISCRETE, 8 SEATBELT
9 INERTIA, 10 RGSURF, 11 SPHNODE,
12 FLUID, 13 NURBSPATCH, 14 - PARTICLE
...............................................................................................................................
void SCLGetModelDirectory(char *dir)
Purpose:
Get model directory.
Input:
dir the directory where model is put
Output:
none
...............................................................................................................................
Int SCLGetDataCenterString(char *parameter_name, Int iid, char *result)
Purpose:
Get string from model data.
Input:
parameter_name(like part_name).
iid - internal id(zero-based).
Output:
result - the string to be obtained.
Return:
1 is valid, 0 invalid.
...............................................................................................................................

Geometry object type

The geometry object type is used to define the type of the geometry
entities, the symbols are defined here in the following table, use the

exact capital letter as shown in the table to define the type in the
API functions
OBJ_SOLID
OBJ_SHELL
OBJ_FACE
OBJ_WIRE
OBJ_EDGE
OBJ_VERTEX

Geometry related Functions

Int SCLCalcGeomArea(Int id, Int obj_type, Float *result)
Purpose:
Calculate the area of a geometry entity.
Input:
id - geometry entity id.
obj_type - Geometry object type, see geometry object type table
above for definition
Output:
result - area value
Return:
status of calculation, 1=success, 0=fail
...............................................................................................................................
Int SCLCalcGeomVolume(Int id, Int obj_type, Float *result)
Purpose:
Calculate the volume of a geometry entity.
Input:
id - geometry element entity id.
obj_type - Geometry object type, see geometry object type table
above for definition
Output:
result - volume value.
Return:
status of calculation, 1=success, 0=fail
...............................................................................................................................
Int SCLCalcGeomLength(Int id, Int obj_type, Float *result)
Purpose:
Calculate the length of geometry entity.
Input:
id - Geometry entity id.
obj_type - Geometry object type, see geometry object type table
above for definition
Output:
result - length value.
Return:
status of calculation, 1=success, 0=fail
...............................................................................................................................

Float SCLCalcShapeBoundBox(Int id, Int obj_type, Float *minPnt, Float*

maxPnt)
Purpose:
Calculate the bounding box of geometry entity.
Input:
id Geometry entity id.
obj_type Geometry object type, see geometry object type table
Output:
minPnt min point of the shapes bounding box
maxPnt max point of the shapes bounding box
Return:
status of calculation, 1=success, 0=fail
...............................................................................................................................
Float SCLCalcShapesBoundBox(Int* ids, Int* obj_types, Int n, Float *minPnt,
Float* maxPnt)
Purpose:
Calculate the bounding box of geometry entities.
Input:
ids Geometry entities id.
obj_types Geometry entities type.
n Number of geometry entities.
Output:

minPnt min point of the shapes bounding box

maxPnt max point of the shapes bounding box
Return:
status of calculation, 1=success, 0=fail
...............................................................................................................................
Int SCLGeomGetAllShapeIDs(Int **ids, Int obj_type, Int bLocal)
Purpose: Get ids of all geometry faces.
Input:
ids ids array.
obj_type Geometry object type, see geometry object type table
above for definition
bLocal if bLocal=1, get all shape including local shape; if bLocal
= 0, just get independent shape (non-local) only. A local shape is a
shape from a parent object
Output:
none
Return:
Number of faces.
...............................................................................................................................
Int SCLMeasureGeomShellSolid(Int id, Int obj_type, Int* numOfFaces, Float*
area, Float* volume, Int* bClosed, Float* cgPnt, Float* halfInertiaMatrix,
Float* principalVector)
Purpose:
Measure shell or solid shapes geometry information
Input:
id the shell or solid shapes ID.
type the shapes type.

Output:

numOfFaces number faces of the shell or solid shape.

area area of the shell or solid shape.
volume volume of the shell or solid shape.
bClosed close tag of the shell or solid shape.
cgPnt centre mass point.
halfInertiaMatrix half inertia matrix. The array is Ixx, Ixy, Ixz, Iyy,

Iyz, Izz.
principalVector principal vector.
Return:
1=success, 0=fail
...............................................................................................................................
void SCLGeomMeasureToText(Int id, Int obj_type)
Purpose:
Issues a geometry measurement for a specified geometry shape
Input:
id - the geometry entity id
obj_type - Geometry object type, see geometry object type table
above for definition
Output:
none
Return:
none
...............................................................................................................................
void SCLGeomMeasureToText2(Int id1, Int obj_type1, Int id2, Int obj_type2)
Purpose:
Issues a geometry measurement for two specified geometry shapes
Input:
id1 - the geometry entity id for shape 1
obj_type1 - Geometry object type for shape 1, see geometry object
type table above for definition
id2 - the geometry entity id for shape 2
obj_type2 Geometry object type for shape 2
Output:
none
Return:
none
...............................................................................................................................
Int SCLGeomMeasureGetValueCount()
Purpose:
Get number of return values from Geometry measurement operation.
Input:
none
Output:
none
Return:
Number of return values.
...............................................................................................................................
void SCLGeomMeasureGetValue(Int i, char *p1, char *p2)

Purpose:
Input:
Output:

Get the geometry measurement value for the ith entry

i - the ith entry
p1 - string contains the name of the measurement
P2 - string contains the values of the measurement, can be multiple
floating point numbers, user needs to decode it according to the name
Return:
none
...............................................................................................................................
Int SCLGetParentEntityID(Int childID, Int obj_type1, Int obj_type2)
Purpose:
Get the parent entity ID given the child entity ID.
Input:
childID the child entity ID
obj_type1 object type of the child
obj_type2 object type of parent
Output:
none
Return:
parent entity ID
...............................................................................................................................
Int SCLGetParentEntityIDs(Int childID, Int obj_type1, Int obj_type2, Int **ids)
Purpose:
Get the parent entitys ids given the child entity ID.
Input:
childID the child entity ID
obj_type1 object type of the child
obj_type2 object type of parent
Output:
ids array contains parent ids. (a child can has multiple parents, e.g.
an edge line will have multiple faces)
Return:
number of parent entities
...............................................................................................................................
Int SCLGetEntityMaxID(Int type)
Purpose:
Get the max ID of the specified entity type
Input:
type entity type
Return:
max ID of the specified entity type
...............................................................................................................................
Int SCLGetSubEntityIDs(Int parentID, Int obj_type1, Int obj_type2, Int **ids)
Purpose:
Get the children entity ids given the parent entity ID
Input:
parentID the parent entity ID
obj_type1 object type of parent entity
obj_type2 object type of the sub-entity
Output:
ids array contains children ids

Return:

number of children

...............................................................................................................................
Int SCLIsSonParentRelationship(Int childID,Int obj_type1, Int parentID, Int
obj_type2)
Purpose:
Check if the child entity belongs to a parent entity
Input:
childID the child entity ID
obj_type1 object type of the child entity
parentID the parent entity ID
obj_type2 object type of the parent entity
Output:
none
Return:
True or False
...............................................................................................................................
Int SCLMidPlaneSearchFacePairs(Int ID,Int obj_type, Int bStrict, Int **ids)
Purpose:
Find the mid-plane faces pairs for a given solid entity
Input:
ID the solid entity ID
obj_type object type, must be OBJ_SOLID
bStrict key for setting the searching tolerance, 0=relax, 1=strict
Output:
face ids array, 2 ids make up a pair
Return:
number of pairs
...............................................................................................................................
Int SCLPropagateFacesByAngle(Int* IDs, Int nFace, Float angleTol, Int**
FaceIDs, Int* FaceNum)
Purpose:
Given several seed faces, find the same level faces by angle. This is
API is from Shell by Angle in Middle Surface dialog.
Input:
IDs several seed faces ID
nFace number of seed faces
angleTol angle tolerance to propagate
Output:
FaceIDs several seed faces ID
FaceNum number of propagated faces
Return:
0: no propagated faces found; 1: find propagated faces
...............................................................................................................................
Int SCLSearchSimilarShapes(Int* IDs, Int* Types, Int n, Float relativeRatio, Int

bByDisMeasure, Int** similarShapeIDs, Int** similarTypes, Int* nSimilar)

Purpose:
Search the looks like shapes with the seed shapes.
Input:
IDs seed shapes ID
Types seed shapes type
n number of seed shapes
relativeRatio error ratio, the value is in (0, 1), default value is 0.003
bByDisMeasure search by distance measure only, default is 0.
Output:
similarShapeIDs similar shapes ID after searching
similarTypes similar shapes type
nSimilar number of similar shapes
Return:
number of similar shapes
...............................................................................................................................
void SCLDeleteModel()
Purpose:
Delete all components
...............................................................................................................................
void SCLDeleteAllShape()
Purpose:
Delete all geometry shapes
...............................................................................................................................
void SCLDeleteAllFEMPart()
Purpose:
Delete all FEM parts
...............................................................................................................................
void SCLDeleteAssembly(Int assemblyID)
Purpose:
Delete assembly by ID
Input:
assemblyID assemblys ID
...............................................................................................................................
void SCLDeleteAssemblyShape(Int assemblyID)
Purpose:
Delete all shapes in specified assembly
Input:
assemblyID assemblys ID
...............................................................................................................................
void SCLDeleteAssemblyRefGeom(Int assemblyID)
Purpose:
Delete all reference geometry in specified assembly
Input:
assemblyID assemblys ID
...............................................................................................................................

void SCLDeleteAssemblyFEMPart(Int assemblyID)

Purpose:
Delete all FEM parts in specified assembly
Input:
assemblyID assemblys ID
...............................................................................................................................
void SCLDeleteGPart(Int gpartID)
Purpose:
Delete the specified GPart
Input:
gpartID GParts ID
...............................................................................................................................
void SCLDeleteGPartShape(Int gpartID)
Purpose:
Delete all shapes in specified GPart
Input:
gpartID GParts ID
...............................................................................................................................
void SCLDeleteGPartFEMPart(Int gpartID)
Purpose:
Delete all FEM parts in specified GPart
Input:
gpartID GParts ID
...............................................................................................................................
void SCLDeleteEntity(Int* IDs, Int* types, Int num)
Purpose:
Delete entities (shapes, FEM parts and reference geometry) by ID
and Type
Input:
IDs entities ID
types entities type
num entities number
...............................................................................................................................
void SCLDeleteFEMParts(Int* IDs, Int num)
Purpose:
Delete FEM parts
Input:
IDs parts ID
num parts number
...............................................................................................................................
void SCLCopyModel(Int toAssemblyID, Int toGPartID)
Purpose:
Copy all shapes and FEM parts to specified assembly and GPart
Input:
toAssemblyID the specified assembly ID. -1: copy to a new
assembly
toGPartID the specified GPart ID. -1: copy to a new GPart

...............................................................................................................................
void SCLCopyAssembly(Int fromAssemblyID, Int toAssemblyID)
Purpose:
Copy all entities(shapes, reference geometry and FEM parts) in some
assembly to another assembly
Input:
fromAssemblyID the source assembly ID
toAssemblyID the destination assembly ID. -1: copy to a new
assembly
...............................................................................................................................
void SCLCopyAssemblyShape(Int fromAssemblyID, Int toAssemblyID)
Purpose:
Copy all shapes in some assembly to another assembly
Input:
fromAssemblyID the source assembly ID
toAssemblyID the destination assembly ID. -1: copy to a new
assembly
...............................................................................................................................
void SCLCopyAssemblyRefGeom(Int fromAssemblyID, Int toAssemblyID)
Purpose:
Copy all reference geometry in some assembly to another assembly
Input:
fromAssemblyID the source assembly ID
toAssemblyID the destination assembly ID. -1: copy to a new
assembly
...............................................................................................................................
void SCLCopyAssemblyFEMPart(Int fromAssemblyID, Int toAssemblyID)
Purpose:
Copy all FEM parts in some assembly to another assembly
Input:
fromAssemblyID the source assembly ID
toAssemblyID the destination assembly ID. -1: copy to a new
assembly
...............................................................................................................................
void SCLCopyGPart(Int fromGpartID, Int toGPartID)
Purpose:
Copy all entities in some GPart to another GPart
Input:
fromGpartID the source GPart ID
toGPartID the destination GPart ID. -1: copy to a new GPart
...............................................................................................................................

void SCLCopyGPartShape(Int fromGpartID, Int toGPartID)

Purpose:
Copy all shapes in some GPart to another GPart
Input:
fromGpartID the source GPart ID
toGPartID the destination GPart ID. -1: copy to a new GPart
...............................................................................................................................
void SCLCopyGPartFEMPart(Int fromGpartID, Int toGPartID)
Purpose:
Copy all FEM parts in some GPart to another GPart
Input:
fromGpartID the source GPart ID
toGPartID the destination GPart ID. -1: copy to a new GPart
...............................................................................................................................
void SCLCopyEntity(Int* ids, Int* types, Int num)
Purpose:
Copy entities
Input:
ids the source entities ID
types the source entities type
num number of source entities
...............................................................................................................................
void SCLCopyFEMParts(Int* ids, Int num)
Purpose:
Copy FEM parts
Input:
ids the source parts ID
num number of source parts
...............................................................................................................................
void SCLHoleManage_Analysis()
Purpose:
Start analysis inner hole and outer hole in geometry shapes
...............................................................................................................................
void SCLHoleManage_AnalysisShape(Int ID, Int type)
Purpose:
Start analysis inner hole and outer hole in specified face, shell or
solid shape
Input:

ID the face, shell or solids ID

type the shapes type

...............................................................................................................................
Int SCLHoleManage_GetInnerHoleCount()
Purpose:
After analysis, get number of inner holes (inner loop from face)
Return:
number of inner hole

...............................................................................................................................
Int SCLHoleManage_GetOutHoleCount()
Purpose:
After analysis, get number of out holes (out hole is grouped by
multiple faces)
Return:
number of out hole
...............................................................................................................................
Int SCLHoleManage_GetInnerHoleInfor(Int holeID, char** holeName, Int*
holeWireID, Int** holeEdgeIDs, Int* holeEdgeCount, Float* size)
Purpose:
After analysis, get the inner hole geometry information
Input:
holeID the inner holes ID
Output:
holeName the inner holes name
holeWireID wire ID of the inner hole
holeEdgeIDs edges ID of the inner hole
holeEdgeCount number of edges from the inner hole
size diagonal length of the inner holes bounding box
Return:
0: invalid inner hole; 1: success
...............................................................................................................................
Int SCLHoleManage_GetOutHoleInfor(Int holeID, char** holeName, Int**
holeEdgeIDs, Int* holeEdgeCount, Float* size, Int* bFilled)
Purpose:
After analysis, get the out hole geometry information
Input:
holeID the out holes ID
Output:
holeName the out holes name
holeEdgeIDs edges ID of the out hole
holeEdgeCount number of edges from the out hole
size diagonal length of the inner holes bounding box
bFilled out hole filled tag (some large out hole should not be filled)
Return:
0: invalid out hole; 1: success
...............................................................................................................................
Int SCLHoleManage_FillHole(Int bInnerHole, Int holeID)
Purpose:
After analysis, fill specified inner or out hole
Input:
bInnerHole tag of inner hole or out hole
holeID the holes ID
Return:
0: invalid out hole; 1: success
...............................................................................................................................
void SCLHollowManage_Analysis(Int bSimpleHollowOnly)

Purpose:
Input:

Start analysis hollow in geometry shapes

bSimpleHollowOnly a tag to check simple or complex hollow

...............................................................................................................................
void SCLHollowManage_AnalysisShape(Int id, Int type, Int
bSimpleHollowOnly)
Purpose:
Start analysis hollow in geometry shell or solid
Input:
id the shell or solid shapes ID
type the shapes type
bSimpleHollowOnly a tag to check simple or complex hollow
...............................................................................................................................
Int SCLHollowManage_GetHollowCount()
Purpose:
After analysis, get number of hollow
Return:
number of hollow
...............................................................................................................................
Int SCLHollowManage_GetHollowInfor(Int hollowID, char** hollowName,
Int** hollowFaceIDs, Int* holeFaceCount, Float* size)
Purpose:
After analysis, get the hollow geometry information
Input:
hollowID the hollows ID
Output:
hollowName the hollows name
hollowFaceIDs faces ID of the hollow
holeFaceCount number of faces from the hollow
size diagonal length of the hollows bounding box
Return:
0: invalid hollow; 1: success
...............................................................................................................................
Int SCLHollowManage_FillHollow(Int hollowID)
Purpose:
After analysis, fill one hollow
Input:
hollowID the hollowIDs ID
Return:

0: failed; 1: success

...............................................................................................................................
Int SCLHollowManage_FillAll()
Purpose:
After analysis, fill all hollows
Return:
0: failed; 1: success

...............................................................................................................................
Int SCLSetDBEntityColor(Int ID, Int type, Float* color)
Purpose:
Set entitys color
Input:
ID the entity ID
type the entity type
color the color array (size 4, the last component is transparency)
Return:
0: failed; 1: success
...............................................................................................................................
Int SCLGetDBEntityColor(Int ID, Int type, Float* color)
Purpose:
Get entitys color
Input:
ID the entity ID
type the entity type
Output:
color the color array (size 4, the last component is transparency)
Return:
0: failed; 1: success

LS-PrePost Scripting Command Language specifics and limitations

LSPP-SCL is almost like the C programming language with the following
exceptions:
1. Combined assignments such as i++, i--, --i, ++i, i+=, i*=; are not supported,
must use i=i+1; i=i-1; i=i+n; i=i*x; i=i/n;
2. For integer data declaration, you must use Int not int.
3. For floating point number declaration, you must use Float, not float.
4. Do not type cast data conversion, e.g. Int i; Float x;
i = x; (right), i = (Int)x; (wrong)
5. Switch case:
do... while
- not supported
6. Conditional operator: (boolean) ? :
- not supported

How to use Scripting Command Language in LS-PrePost

There are 2 ways to execute the scripting command language file:
1. Run it within the regular LS-PrePost command file, use the runscript command
to execute the scl file, parameters can also be passed to the script.

The syntax:
runscript sclfilename optional parameters
Example: the following command file will execute the script that creates a X-Y
curve with the parameters defined in the command file.
parameter pa 9.0E+07
parameter pb 7000.0
parameter pc 4.0E+07
parameter npt 300
parameter xmin 0.0
parameter xmax 0.00126
runscript "customcurve.scl"

&npt &pa &pb &pc &xmin &xmax

2. Run it by going to the Application pull down menu, select Customize and in
the pop up dialog, click Load to load the SCL file, then click Run to execute.
Running script this way parameter cannot be passed to the script file, as shown in
the following pictures:

Data Center Parameter Name list

Name

Type

Status

num_states

Int

Availabl
e

num_parts

Int

Availabl
e

num_nodes

Int

Availabl
e

num_elements

Int

Availabl
e

largest_node_id

Int

Availabl
e

largest_element_id

Int

Availabl
e

num_shell_elements

Int

Availabl
e

num_beam_elements

Int

Availabl
e

num_solid_elements

Int

Availabl
e

num_tshell_elements

Int

Availabl
e

num_sph_elements

Int

Availabl
e

num_discrete_element
s

Int

Availabl
e

num_seatbelt_element
s

Int

Availabl
e

num_mass_elements

Int

Availabl
e

num_inertia_elements

Int

Availabl
e

num_validparts

Int

Availabl
e

num_beam_intp

Int

Availabl
e

largest_point_id

Int

Availabl
e

largest_vertex_id

Int

Availabl
e

largest_edge_id

Int

Availabl
e

largest_surface_id

Int

Availabl
e

node_ids

Int array

Availabl
e

element_ids

Int array

Availabl
e

elemofpart_ids

Int array

Availabl
e

validpart_ids

Int array

Availabl
e

element_connectivity

Int array

Availabl
e

largest_time

Float

Availabl
e

largest_disp_magnitud
e

Float

Availabl
e

max_stress_x

Float

Availabl

e
max_stress_y

Float

Availabl
e

max_stress_z

Float

Availabl
e

max_stress_xy

Float

Availabl
e

max_stress_yz

Float

Availabl
e

max_stress_zx

Float

Availabl
e

max_strain_x

Float

Availabl
e

max_strain_y

Float

Availabl
e

max_strain_z

Float

Availabl
e

max_strain_xy

Float

Availabl
e

max_strain_yz

Float

Availabl
e

max_strain_zx

Float

Availabl
e

state_times

Float array

Availabl
e

nodal_temperatures

Float array

Availabl
e

node_x

Float or float
array

Availabl
e

node_y

Float or float
array

Availabl
e

node_z

Float or float
array

Availabl
e

disp_x

Float or float
array

Availabl
e

disp_y

Float or float
array

Availabl
e

disp_z

Float or float
array

Availabl
e

disp_magnitude

Float or float
array

Availabl
e

velo_x

Float or float
array

Availabl
e

velo_y

Float or float
array

Availabl
e

velo_z

Float or float
array

Availabl
e

velo_magnitude

Float or float
array

Availabl
e

accel_x

Float or float
array

Availabl
e

accel_y

Float or float
array

Availabl
e

accel_z

Float or float
array

Availabl
e

accel_magnitude

Float or float
array

Availabl
e

stress_x

Float or float
array

Availabl
e

stress_y

Float or float
array

Availabl
e

stress_z

Float or float
array

Availabl
e

stress_xy

Float or float
array

Availabl
e

stress_yz

Float or float
array

Availabl
e

stress_zx

Float or float
array

Availabl
e

effective_plastic_str
ain

Float or float
array

Availabl
e

stress_1stprincipal

Float or float
array

Availabl
e

stress_2ndprincipal

Float or float
array

Availabl
e

stress_3rdprincipal

Float or float
array

Availabl
e

strain_x

Float or float
array

Availabl
e

strain_y

Float or float
array

Availabl
e

strain_z

Float or float
array

Availabl
e

strain_xy

Float or float
array

Availabl
e

strain_yz

Float or float
array

Availabl
e

strain_zx

Float or float
array

Availabl
e

strain_1stprincipal_i
nfin

Float or float
array

Availabl
e

strain_2ndprincipal_i
nfin

Float or float

Availabl

array

strain_3rdprincipal_i
nfin

Float or float
array

Availabl
e

lower_eps1

Float array

Availabl
e

upper_eps1

Float array

Availabl
e

mean_eps1

Float array

Availabl
e

lower_eps2

Float array

Availabl
e

upper_eps2

Float array

Availabl
e

mean_eps2

Float array

Availabl
e

sigma1

Float array

Availabl
e

sigma2

Float array

Availabl
e

mx

Float or float
array

Availabl
e

my

Float or float
array

Availabl
e

mxy

Float or float
array

Availabl
e

qx

Float or float
array

Availabl
e

qy

Float or float
array

Availabl
e

nx

Float or float
array

Availabl
e

ny

Float or float
array

Availabl
e

nxy

Float or float
array

Availabl
e

Nx/t-6*Mx/(t*t)

Float or float
array

Availabl
e

Nx/t+6*Mx/(t*t)

Float or float
array

Availabl
e

Ny/t-6*My/(t*t)

Float or float
array

Availabl
e

Ny/t+6*My/(t*t)

Float or float
array

Availabl
e

Nxy/t-6*Mxy/(t*t)

Float or float
array

Availabl
e

Nxy/t+6*Mxy/(t*t)

Float or float
array

Availabl
e

strain_energy_density

Float or float
array

Availabl
e

kinetic_energy

Float or float
array

Availabl
e

internal_energy

Float or float
array

Availabl
e

total_energy

Float or float
array

Availabl
e

rigidbody_dispx

Float or float
array

Availabl
e

rigidbody_dispy

Float or float
array

Availabl
e

rigidbody_dispz

Float or float
array

Availabl
e

result_rigidbody_disp

Float or float
array

Availabl
e

rigidbody_velx

Float or float
array

Availabl
e

rigidbody_vely

Float or float
array

Availabl
e

rigidbody_velz

Float or float
array

Availabl
e

result_rigidbody_vel

Float or float
array

Availabl
e

rigidbody_accelx

Float or float
array

Availabl
e

rigidbody_accely

Float or float
array

Availabl
e

rigidbody_accelz

Float or float
array

Availabl
e

result_rigidbody_accel

Float or float
array

Availabl
e

von_mises

Float or float
array

Availabl
e

thickness

Float or float
array

Availabl
e

area

Float or float
array

Availabl
e

volume

Float or float
array

Availabl
e

shell_normal

Vector

Availabl
e

displacement

Vector or vector
array

Availabl
e

velocity

Vector or vector
array

Availabl
e

acceleration

Vector or vector
array

Availabl
e

global_stress

Tensor or tensor
array

Availabl
e

global_strain

Tensor or tensor
array

Availabl
e

axial_force

Float or Float
array

Availabl
e

s_shear_resultant

Float or Float
array

Availabl
e

t_shear_resultant

Float or Float
array

Availabl
e

s_bending_moment

Float or Float
array

Availabl
e

t_bending_moment

Float or Float
array

Availabl
e

torsional_resultant

Float or Float
array

Availabl
e

axial_stress

Float or Float
array

Availabl
e

rs_shear_stress

Float or Float
array

Availabl
e

tr_shear_stress

Float or Float
array

Availabl
e

plastic_strain

Float or Float
array

Availabl
e

axial_strain

Float or Float
array

Availabl
e

Examples:
The examples can be download from the LSTC ftp site:
ftp://ftp.lstc.com/outgoing/lsprepost/SCLexamples/SCL_Examples.zip

As of June 15, 2013, there are 6 examples scripts:

1. example1.scl - script to get no. of parts in the model, and get all the part IDs. Also draw each
part by itself and auto center it before printing a png picture of the part to a file which has the
part id as the file name
2. example2.scl - script to create a plate with 5x5 shell elements, then extract the following:
a. number of nodes/elements in the model,
b. largest node/element ids,
c. the array of the node ids.
d. get the element connectivity of the last element
3. example3.scl, example3.cfile - script to create a load curve based on a given equation and
some parameters. The created curves will be written to a file called curve.txt, then load the file
back to LSPP to displayed as xyplot
This script will be run from the command file, open and execute the command file
example3.cfile
4. example4.scl - script to measure the mass, mass center of gravity and volume of all solid
parts in the model, the measured information will be written to file called example4.txt
5. example5.scl - script to extract the x,y,and z component of the displacement array from the
post-processing file, then compute the resultant displacement for all the nodes and then fringe
the computed result. Also write the computed result to a file for each state. The file written can
be loaded back into LSPP as user defined fringe data
6. example6.scl - scrpte to extract x,y,and z global stress and compute the average stress then
fringe the computed result and write it out to file as like example no. 5
7. example7.scl - Script to extract the z component of the nodal displacement array, then
differentiate it with respect to time, which should become the z velocity, then extract the z
component of the velocity array that was stored in d3plot file from differentiated result and then
fringe it.
8. example8.scl Script to extract MX, MY, MXY, QX, QY, NX, NY, NXY at the last state for
shell element from the d3plot files, and then write the extracted data to a file.