Skip to main content

optiSLang 3D Postprocessing Script API 2025 R1

CreateSimulationArchive Class Reference

Last update: 16.07.2025

A struct collecting export information for random field simulation data. More...

Public Member Functions

 check (Structure database)
 Checks validity of these data. More...
 
 CreateSimulationArchive (ExportReferenceDesign reference_design, string the_output_file)
 constructor. It assumes that the base path is one directory level below the base path of the reference design. It further assumes a default for the design directory names and copies the information on the reference design More...
 
 save (Structure database)
 exports multiple designs to disk This method tries to export as much data as possible and does even proceed in case of errors. Important: the design directories to be exported to must already exist. More...
 

Public Attributes

string output_file
 path (absolute path)
 
ExportReferenceDesign reference_design
 stores the information on the reference design/design directory template (defines which data to be exported)
 
bool replace_files
 if true, already existing files are to be replaced
 

Detailed Description

A struct collecting export information for random field simulation data.

The idea is:

Constructor & Destructor Documentation

◆ CreateSimulationArchive()

CreateSimulationArchive ( ExportReferenceDesign  reference_design,
string  the_output_file 
)

constructor. It assumes that the base path is one directory level below the base path of the reference design. It further assumes a default for the design directory names and copies the information on the reference design

Parameters
reference_designcontains info on the reference export design
the_output_filedefines the output file

Member Function Documentation

◆ check()

check ( Structure  database)

Checks validity of these data.

If any of the specified directories or files does not exist, an exception is thrown It also checks the validity of the reference design It further checks if any of the objects to be exported does not exist. And if the scalar data contain valid amplitudes

Parameters
databasethe data base where the data is stored

◆ save()

save ( Structure  database)

exports multiple designs to disk This method tries to export as much data as possible and does even proceed in case of errors. Important: the design directories to be exported to must already exist.

Parameters
databasethe data base where all data is contained.

Connect with Ansys