Skip to main content

optiSLang 3D Postprocessing Script API 2025 R1

Import

Last update: 16.07.2025

Parse files and import data. More...

Classes

class  CreateSimulationArchive
 A struct collecting export information for random field simulation data. More...
 
class  ImportCoP
 imports CoP values of amplitudes from CSV file More...
 
class  ImportCSV
 A class collecting import information for a csv file. More...
 
class  ImportDesigns
 A class collecting import information for various design directories. More...
 
struct  ImportItemInfo
 defines a data item which was found in an input file More...
 
struct  ImportOMDB
 Stores settings for loading optiSLang omdb files. Limited to scalar parameters and responses. More...
 
struct  ImportOptiSLangBinary
 stores settings for loading optiSLang binary files More...
 
class  ImportOptiSLangSignal
 Sets up an SoS project for a single user defined optiSLang 3 signal identifier. More...
 
class  ImportSRBProject
 Import a Twin Builder Static ROM Builder (SRB) project. Expects a valid SRB project directory as input. More...
 
struct  LoadDataBaseSettings
 stores settings for loadDataBase() More...
 
class  ModifyMeshBase
 Base settings that are provided for all modifier classes that change mesh coorsinates. More...
 
class  PrepareRandomFieldSimulation
 A struct collecting export information for random field simulation data. More...
 
class  ReferenceDesign
 defines information on imported data and files given a reference design More...
 

Functions

MetaStructure createSimpleStructuredGrid (number num_x, number min_x, number max_x, number num_y=1, number min_y=0.0, number max_y=0.0, number num_z=1, number min_z=0.0, number max_z=0.0)
 creates a structured grid in 1d/2d/3d using equal node spacing along each axis direction More...
 
 importElementSet_CSV (MetaStructure meta, string ident, string filename)
 Imports an element set from a CSV file. More...
 
 importElementSet_CSV (Structure database, string part_ident, string ident, string filename)
 Imports a element set from a CSV file. More...
 
 importElementSet_Indices (Structure database, string part_ident, string ident, Matrix indices)
 Imports a element set from a given index vector. More...
 
MetaStructure importMesh_2dGrid (string filename)
 Imports the 2D mesh from a single CSV-Grid file. More...
 
MetaStructure importMesh_3dGrid (string filename)
 Imports the 3D mesh from a single CSV-Grid file. More...
 
MetaStructure importMesh_Abaqus (string filename)
 Imports the mesh from a single Abaqus file. More...
 
MetaStructure importMesh_ANSYS_APDL (string filename)
 Imports the mesh from a single ANSYS APDL input file. More...
 
MetaStructure importMesh_ANSYS_RST (string filename)
 Imports the mesh from a single ANSYS RST file. More...
 
MetaStructure importMesh_Fluent_CSV (string filename)
 Imports the mesh from a single FLUENT CSV point cloud file. More...
 
MetaStructure importMesh_Image (string filename)
 imports the mesh from a single pixel-image file More...
 
MetaStructure importMesh_LSDynaK (string filename)
 imports the mesh from a single LS-DYNA K file More...
 
MetaStructure importMesh_Nastran (string filename)
 imports the mesh from a single Nastran file More...
 
MetaStructure importMesh_PERMAS (string filename)
 Imports the mesh from a single PERMAS file. More...
 
MetaStructure importMesh_Signal (string filename)
 Imports the mesh from a single CSV-Signal file. More...
 
MetaStructure importMesh_SRB (string filename)
 Imports the mesh from a Static ROM Builder points.bin file. More...
 
MetaStructure importMesh_STL (string filename, bool merge_nodes=true, number relative_node_distance=1e-4)
 imports the mesh from a single STL file (either ASCII or binary) More...
 
MetaStructure importMesh_VTK (string filename)
 Imports the mesh from a single VTK file. More...
 
 importNodeSet_CSV (MetaStructure meta, string ident, string filename)
 Imports a node set from a CSV file. More...
 
 importNodeSet_CSV (Structure database, string part_ident, string ident, string filename)
 Imports a node set from a CSV file. More...
 
 importNodeSet_Indices (Structure database, string part_ident, string ident, Matrix indices)
 Imports a node set from a given index vector. More...
 
 loadDataBase (Structure database, LoadDataBaseSettings settings)
 loads data into database from file. The data will be replaced More...
 
ReferenceDesign referenceDesign ()
 gives access to the reference design information More...
 
 setReferenceMesh (Structure database, MetaStructure mesh, bool do_create_mesh=true)
 sets the reference mesh It throws an exception if this is somehow not possible. More...
 

Detailed Description

Parse files and import data.

Function Documentation

◆ createSimpleStructuredGrid()

MetaStructure createSimpleStructuredGrid ( number  num_x,
number  min_x,
number  max_x,
number  num_y = 1,
number  min_y = 0.0,
number  max_y = 0.0,
number  num_z = 1,
number  min_z = 0.0,
number  max_z = 0.0 
)

creates a structured grid in 1d/2d/3d using equal node spacing along each axis direction

Parameters
num_xnumber of grid points along x axis
min_xsmallest coordinate along x axis
max_xlargest coordinate along x axis
num_ynumber of grid points along y axis
min_ysmallest coordinate along y axis
max_ylargest coordinate along y axis
num_znumber of grid points along z axis
min_zsmallest coordinate along z axis
max_zlargest coordinate along z axis
Returns
a meta structure containing the grid

◆ importElementSet_CSV() [1/2]

importElementSet_CSV ( MetaStructure  meta,
string  ident,
string  filename 
)

Imports an element set from a CSV file.

Parameters
metaThe meta structure to which the set definition shall be added to
identThe ident string that shall be used for the imported set definition
filenameThe absolute CSV file path where the set definition can be found

◆ importElementSet_CSV() [2/2]

importElementSet_CSV ( Structure  database,
string  part_ident,
string  ident,
string  filename 
)

Imports a element set from a CSV file.

Parameters
databaseThe database to which the set definition shall be added to
part_identThe part_ident string that shall be used for the imported set definition
identThe ident string that shall be used for the imported set definition
filenameThe absolute CSV file path where the set definition can be found

◆ importElementSet_Indices()

importElementSet_Indices ( Structure  database,
string  part_ident,
string  ident,
Matrix  indices 
)

Imports a element set from a given index vector.

Parameters
databaseThe database to which the set definition shall be added to
part_identThe part_ident string that shall be used for the imported set definition
identThe ident string that shall be used for the imported set definition
indicesThe global indices (with respect to the current reference element set)

◆ importMesh_2dGrid()

MetaStructure importMesh_2dGrid ( string  filename)

Imports the 2D mesh from a single CSV-Grid file.

Parameters
filenameDefines the input file
Returns
A meta structure containing the mesh

◆ importMesh_3dGrid()

MetaStructure importMesh_3dGrid ( string  filename)

Imports the 3D mesh from a single CSV-Grid file.

Parameters
filenameDefines the input file
Returns
A meta structure containing the mesh

◆ importMesh_Abaqus()

MetaStructure importMesh_Abaqus ( string  filename)

Imports the mesh from a single Abaqus file.

Parameters
filenameDefines the input file
Returns
A meta structure containing the mesh

◆ importMesh_ANSYS_APDL()

MetaStructure importMesh_ANSYS_APDL ( string  filename)

Imports the mesh from a single ANSYS APDL input file.

Parameters
filenameDefines the result file path
Returns
A meta structure containing the mesh

◆ importMesh_ANSYS_RST()

MetaStructure importMesh_ANSYS_RST ( string  filename)

Imports the mesh from a single ANSYS RST file.

Parameters
filenameDefines the result file path
Returns
A meta structure containing the mesh

◆ importMesh_Fluent_CSV()

MetaStructure importMesh_Fluent_CSV ( string  filename)

Imports the mesh from a single FLUENT CSV point cloud file.

Parameters
filenameDefines the input file
Returns
A meta structure containing the mesh

◆ importMesh_Image()

MetaStructure importMesh_Image ( string  filename)

imports the mesh from a single pixel-image file

Parameters
filenamedefines the input file
Returns
a meta structure containing the mesh

◆ importMesh_LSDynaK()

MetaStructure importMesh_LSDynaK ( string  filename)

imports the mesh from a single LS-DYNA K file

Parameters
filenamedefines the input file
Returns
a meta structure containing the mesh

◆ importMesh_Nastran()

MetaStructure importMesh_Nastran ( string  filename)

imports the mesh from a single Nastran file

Parameters
filenamedefines the input file
Returns
a meta structure containing the mesh

◆ importMesh_PERMAS()

MetaStructure importMesh_PERMAS ( string  filename)

Imports the mesh from a single PERMAS file.

Parameters
filenamedefines the input file
Returns
A meta structure containing the mesh

◆ importMesh_Signal()

MetaStructure importMesh_Signal ( string  filename)

Imports the mesh from a single CSV-Signal file.

Parameters
filenameDefines the input file
Returns
A meta structure containing the mesh

◆ importMesh_SRB()

MetaStructure importMesh_SRB ( string  filename)

Imports the mesh from a Static ROM Builder points.bin file.

Parameters
filenameDefines the input file
Returns
A meta structure containing the mesh

◆ importMesh_STL()

MetaStructure importMesh_STL ( string  filename,
bool  merge_nodes = true,
number  relative_node_distance = 1e-4 
)

imports the mesh from a single STL file (either ASCII or binary)

Parameters
filenamedefines the input file
Returns
a meta structure containing the mesh
Parameters
merge_nodesDefines if nodes with nearly identrical coordinates are merged. If false, each node belongs to eactly one element. If true, one may erroneously merge nodes which do not belong together (eg. if two separate bodies are very close to each other)
relative_node_distanceThe minimum relative distance between two nodes. If a distance between two nodes is below the tolerance, the nodes will be merged. The distance is defined by this factor multiplied with the largest triangle edge length in the model.

◆ importMesh_VTK()

MetaStructure importMesh_VTK ( string  filename)

Imports the mesh from a single VTK file.

Parameters
filenameDefines the input file
Returns
A meta structure containing the mesh

◆ importNodeSet_CSV() [1/2]

importNodeSet_CSV ( MetaStructure  meta,
string  ident,
string  filename 
)

Imports a node set from a CSV file.

Parameters
metaThe meta structure to which the set definition shall be added to
identThe ident string that shall be used for the imported set definition
filenameThe absolute CSV file path where the set definition can be found

◆ importNodeSet_CSV() [2/2]

importNodeSet_CSV ( Structure  database,
string  part_ident,
string  ident,
string  filename 
)

Imports a node set from a CSV file.

Parameters
databaseThe database to which the set definition shall be added to
part_identThe part_ident string that shall be used for the imported set definition
identThe ident string that shall be used for the imported set definition
filenameThe absolute CSV file path where the set definition can be found

◆ importNodeSet_Indices()

importNodeSet_Indices ( Structure  database,
string  part_ident,
string  ident,
Matrix  indices 
)

Imports a node set from a given index vector.

Parameters
databaseThe database to which the set definition shall be added to
part_identThe part_ident string that shall be used for the imported set definition
identThe ident string that shall be used for the imported set definition
indicesThe global indices (with respect to the current reference node set)

◆ loadDataBase()

loadDataBase ( Structure  database,
LoadDataBaseSettings  settings 
)

loads data into database from file. The data will be replaced

Parameters
settingscontains the settings
databasethe database where all objects are to be stored

◆ referenceDesign()

ReferenceDesign referenceDesign ( )

gives access to the reference design information

Returns
a reference to the object stored in
See also
application_data

◆ setReferenceMesh()

setReferenceMesh ( Structure  database,
MetaStructure  mesh,
bool  do_create_mesh = true 
)

sets the reference mesh It throws an exception if this is somehow not possible.

Parameters
meshthe reference mesh as a meta structure
databasethe database to be modified
do_create_meshIf this is false, then no FEM mesh is built up from the meta structure. Use this mode carefully, since SoS GUI, visualization and algorithms may not work properly. This mode is used for fast simulation of random field designs.

Connect with Ansys