Skip to main content

optiSLang 3D Postprocessing Script API 2025 R1

ExportGeometry Struct Reference

Last update: 16.07.2025

Defines the interface for exporting a deformed geometry to a file The coordinates to be exported are either: More...

Public Types

enum  enum_format_type {
  UNINITIALIZED = 0, STL, LSDYNA, NASTRAN,
  ANSYS_MECHANICAL_DAT
}
 Defines the format of a file. More...
 

Public Member Functions

 ExportGeometry ()
 default constructor
 
bool isAnyCoordinateSet ()
 Returns true if any node coordinate needs to be modified. More...
 
bool isXCoordinateSet ()
 
bool isYCoordinateSet ()
 
bool isZCoordinateSet ()
 
 save (Structure database)
 exports the geometry More...
 

Public Attributes

number coor_increment_factor
 defines the scaling factor for coordinate increments (default: 1.0)
 
enum_format_type file_format
 the source file format
 
string file_name
 the name of the source file relative to the base path
 
bool mesh_stabilization
 is true, some stabilization algorithms are applied
 
DataObjectPtr node_coor_increment_x
 X node coordinate deviation If the neither the coordinate nor the deviation along a specific axis direction is set (i.e. empty pointer), then the reference coordinates will be used. The dataobject refers to database.indexMapper index space. This coordinate is computed by adding the respective value to the node coordinate of the reference structure. More...
 
DataObjectPtr node_coor_increment_y
 Y node coordinate deviation If the neither the coordinate nor the deviation along a specific axis direction is set (i.e. empty pointer), then the reference coordinates will be used. The dataobject refers to database.indexMapper index space. This coordinate is computed by adding the respective value to the node coordinate of the reference structure. More...
 
DataObjectPtr node_coor_increment_z
 Z node coordinate deviation If the neither the coordinate nor the deviation along a specific axis direction is set (i.e. empty pointer), then the reference coordinates will be used. The dataobject refers to database.indexMapper index space. This coordinate is computed by adding the respective value to the node coordinate of the reference structure. More...
 
DataObjectPtr node_coor_x
 X node coordinate If the neither the coordinate nor the deviation along a specific axis direction is set (i.e. empty pointer), then the reference coordinates will be used. The dataobject refers to database.indexMapper index space.
 
DataObjectPtr node_coor_y
 Y node coordinate If the neither the coordinate nor the deviation along a specific axis direction is set (i.e. empty pointer), then the reference coordinates will be used. The dataobject refers to database.indexMapper index space.
 
DataObjectPtr node_coor_z
 Z node coordinate If the neither the coordinate nor the deviation along a specific axis direction is set (i.e. empty pointer), then the reference coordinates will be used. The dataobject refers to database.indexMapper index space.
 
bool replace_files
 if true, then existing files will be replaced (else: error is thrown)
 
bool throw_error_on_unstable_mesh
 if true then an error/exception will be created if some mesh smoothening errors remain after stabilization
 

Detailed Description

Defines the interface for exporting a deformed geometry to a file The coordinates to be exported are either:

  • The coordinate of the reference structure
  • the given node coordinate
  • the sum of the reference structure coordinate and the given coordinate increment (displacement) The user can specify the three coordinate components (x,y,z) individually.

Member Enumeration Documentation

◆ enum_format_type

Defines the format of a file.

Note
In order to stay compatible with existing script files, do only append new items to this list! This list will directly influence the sort order in the item vector
Enumerator
UNINITIALIZED 

not initialized

STL 

STL format.

LSDYNA 

LS-DYNA K format.

NASTRAN 

Nastran.

ANSYS_MECHANICAL_DAT 

ANSYS Mechanical input file format.

Member Function Documentation

◆ isAnyCoordinateSet()

bool isAnyCoordinateSet ( )
inherited

Returns true if any node coordinate needs to be modified.

Returns
True if any node coordinate (absolute or increment) is set. False, otherwise.

◆ isXCoordinateSet()

bool isXCoordinateSet ( )
inherited
Returns
True if the X node coordinate (absolute or increment) is set. False, otherwise.

◆ isYCoordinateSet()

bool isYCoordinateSet ( )
inherited
Returns
True if the Y node coordinate (absolute or increment) is set. False, otherwise.

◆ isZCoordinateSet()

bool isZCoordinateSet ( )
inherited
Returns
True if the Z node coordinate (absolute or increment) is set. False, otherwise.

◆ save()

save ( Structure  database)

exports the geometry

Parameters
databasethe database where all objects are to be stored

Member Data Documentation

◆ node_coor_increment_x

DataObjectPtr node_coor_increment_x
inherited

X node coordinate deviation If the neither the coordinate nor the deviation along a specific axis direction is set (i.e. empty pointer), then the reference coordinates will be used. The dataobject refers to database.indexMapper index space. This coordinate is computed by adding the respective value to the node coordinate of the reference structure.

Note
This option is ignored if node_coor_x is set

◆ node_coor_increment_y

DataObjectPtr node_coor_increment_y
inherited

Y node coordinate deviation If the neither the coordinate nor the deviation along a specific axis direction is set (i.e. empty pointer), then the reference coordinates will be used. The dataobject refers to database.indexMapper index space. This coordinate is computed by adding the respective value to the node coordinate of the reference structure.

Note
This option is ignored if node_coor_y is set

◆ node_coor_increment_z

DataObjectPtr node_coor_increment_z
inherited

Z node coordinate deviation If the neither the coordinate nor the deviation along a specific axis direction is set (i.e. empty pointer), then the reference coordinates will be used. The dataobject refers to database.indexMapper index space. This coordinate is computed by adding the respective value to the node coordinate of the reference structure.

Note
This option is ignored if node_coor_z is set

Connect with Ansys