Skip to content

LGP - oSL - deprecated OSL_PROJECT_DIR, added new variables #235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 3, 2025
Merged

LGP - oSL - deprecated OSL_PROJECT_DIR, added new variables #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions 2026R1/oSL_API_interfaces_customization-26-r1/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Changelog

## 2025R2

Document added to developer site.
# Changelog

## 2026 R1
- deprecated OSL_PROJECT_DIR; added OSL_PROJECT_WORKING_DIR and OSL_PROJECT_FILE_DIR

## 2025 R2

Added Interfaces and Customizations to developer portal.
26 changes: 13 additions & 13 deletions 2026R1/oSL_API_interfaces_customization-26-r1/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"build": {
"globalMetadata": {
"title": "optiSLang interfaces and customizations 2026 R1",
"summary": "",
"version": "2026 R1",
"product": "optiSLang",
"programming language": "python",
"product collection": "Connect",
"physics": "Connect"
}
}
}
{
"build": {
"globalMetadata": {
"title": "optiSLang",
"summary": "",
"version": "2025 R2",
"product": "optiSLang",
"programming language": "python",
"product collection": "Connect",
"physics": "Connect"
}
}
}
128 changes: 64 additions & 64 deletions ...interfaces_customization-26-r1/opti_api_external_metamodel_solver_interfaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,64 +1,64 @@
# External Metamodel Solver Interfaces

In applications within the virtual prototyping process, you cannot always reduce the complexity of the physical models and obtain numerical models which can be solved quickly. Usually, each numerical simulation takes hours or even days, and it is not possible to explore various model configurations. Due to the inherent complexity of many engineering problems, you can approximate the problem and to solve other design configurations in a smooth sub-domain by applying a surrogate model.

Starting from a reduced number of simulations, a surrogate model of the original physical problem can be used to perform various possible design configurations without computing any further analyses. These well-distributed results are used to create the metamodels. The metamodel with highest Coefficient of Prognosis (CoP) is taken to be optimal. The Metamodel of Optimal Prognosis (MOP) results are stored in a monitoring database file (`*.omdb`) and can be used for the MOP Solver standalone tools to replace the original solver process.

## Using the MOP Solver Standalone Interface

Complete the following procedure to use the MOP Solver standalone interface.

1. Initialize the monitoring database and create input and output files by running the following command.

- On a Windows system:
```
[installation path]\tools\mopsolver\bin\mopsolver.exe [additional options]
```
- On a Linux system:
```
[installation path]/tools/mopsolver/bin/mopsolver [additional options]
```
- Include all three additional options listed in the following table:

| Program Option | Input | Description |
|---------------|-------|-------------|
| --init | `*.omdb` file | Reference values of all parameters are extracted and used to calculate the reference response values. These values are used to create input and output files. For initialization of the MOP Solver this option is mandatory. |
| --input, -i | text file for inputs to be written | Extracted reference values from monitoring database file are written to this file. If this file does not exist, it will be created. This option is mandatory. |
| --output, -o | text file for outputs to be written | Extracted reference input values from monitoring database file and corresponding output values of the metamodel are written to this file. If this file does not exist, it will be created. This option is mandatory. |

A file named `limits.txt` containing parameter and response bounds, as well as the CoP matrix is written to the current working directory. Log messages can be found in the `(p)mopsolver.log` file of the current working directory.

2. Solve the variation of parameter combinations.

The input file with the current design is read and output values that are solved by the metamodel are written to the output file. By default, designs with parameter values outside their bounds cause an error. Such designs can be extrapolated in extended mode.

- To complete this step, run the same command used in the previous step and include the additional options listed in the following table:

| Program Option | Input | Description |
|---------------|-------|-------------|
| --input, -i | text file for inputs to be read | This file contains the design to be solved. This option is mandatory. |
| --output, -o | text file for outputs to be written | The approximated design containing parameter and responses are written to this file. This option is mandatory. |
| --extended | - | This mode allows input parameter to exceed MOP sampling bounds. In default mode input values are checked before approximation and the application ends with an error. This option will be ignored in init mode. |

For more information, include the following options:
- `--help, -h` - Show brief help
- `--version, -v` - Show version information

## Using the MOP Solver Programming Interface

In addition to the [standalone interface](#using-the-mop-solver-programming-interface), you can also use a programming interface to the MOP Solver. This C based API allows the MOP Solver to be embedded in various programming environments.

To get started with the MOP Solver C API, usage examples and reference documentation are provided under the [optiSLang MOPSolver API documentation](https://developer.ansys.com/docs/optislang-mopsolver-api-2023-r2/index.xhtml).

The MOP Solver installation and its API is located within the base installation directory (`[installation path]`) and includes the following subfolders and files:

| Directory | File | Description |
|-----------|------|-------------|
| `[installation path]/tools/mopsolver/bin/` | mopsolver.exe | MOP Solver executable with its dependencies. This install package contains the dynamic libraries which are necessary to use the MOPSolver API. |
| `[installation path]/tools/mopsolver/bin/` | mopsolver.dll / mopsolver.so | Shared library to access mop solver functionality including support for python based meta-models. |
| `[installation path]/tools/mopsolver/bin/` | mopsolver_no_ctm.dll / mopsolver_no_ctm.so | Shared library to access mop solver functionality without support for python based meta-models. |
| `[installation path]/tools/mopsolver/lib` | mopsolver.lib, mopsolver_no_ctm.lib | Respective static libraries with and without support for python based meta-models. |
| `[installation path]/tools/mopsolver/include` | hopsolver_api.h | The MOP Solver header file. |
| `[installation path]/tools/mopsolver/examples` | mop_tenbar.omdb | Example monitoring database file. |
| `[installation path]/tools/mopsolver/examples` | msapi_sample01_cpp.cpp | Code example to show the use of the mopsolver interface with C++ programming language. |
| `[installation path]/tools/mopsolver/examples` | msapi_sample01_c.c | Code example to show the use of the mopsolver interface with C programming language. |
# External Metamodel Solver Interfaces
In applications within the virtual prototyping process, you cannot always reduce the complexity of the physical models and obtain numerical models which can be solved quickly. Usually, each numerical simulation takes hours or even days, and it is not possible to explore various model configurations. Due to the inherent complexity of many engineering problems, you can approximate the problem and to solve other design configurations in a smooth sub-domain by applying a surrogate model.
Starting from a reduced number of simulations, a surrogate model of the original physical problem can be used to perform various possible design configurations without computing any further analyses. These well-distributed results are used to create the metamodels. The metamodel with highest Coefficient of Prognosis (CoP) is taken to be optimal. The Metamodel of Optimal Prognosis (MOP) results are stored in a monitoring database file (`*.omdb`) and can be used for the MOP Solver standalone tools to replace the original solver process.
## Using the MOP Solver Standalone Interface
Complete the following procedure to use the MOP Solver standalone interface.
1. Initialize the monitoring database and create input and output files by running the following command.
- On a Windows system:
```
[installation path]\tools\mopsolver\bin\mopsolver.exe [additional options]
```
- On a Linux system:
```
[installation path]/tools/mopsolver/bin/mopsolver [additional options]
```
- Include all three additional options listed in the following table:
| Program Option | Input | Description |
|---------------|-------|-------------|
| --init | `*.omdb` file | Reference values of all parameters are extracted and used to calculate the reference response values. These values are used to create input and output files. For initialization of the MOP Solver this option is mandatory. |
| --input, -i | text file for inputs to be written | Extracted reference values from monitoring database file are written to this file. If this file does not exist, it will be created. This option is mandatory. |
| --output, -o | text file for outputs to be written | Extracted reference input values from monitoring database file and corresponding output values of the metamodel are written to this file. If this file does not exist, it will be created. This option is mandatory. |
A file named `limits.txt` containing parameter and response bounds, as well as the CoP matrix is written to the current working directory. Log messages can be found in the `(p)mopsolver.log` file of the current working directory.
2. Solve the variation of parameter combinations.
The input file with the current design is read and output values that are solved by the metamodel are written to the output file. By default, designs with parameter values outside their bounds cause an error. Such designs can be extrapolated in extended mode.
- To complete this step, run the same command used in the previous step and include the additional options listed in the following table:
| Program Option | Input | Description |
|---------------|-------|-------------|
| --input, -i | text file for inputs to be read | This file contains the design to be solved. This option is mandatory. |
| --output, -o | text file for outputs to be written | The approximated design containing parameter and responses are written to this file. This option is mandatory. |
| --extended | - | This mode allows input parameter to exceed MOP sampling bounds. In default mode input values are checked before approximation and the application ends with an error. This option will be ignored in init mode. |
For more information, include the following options:
- `--help, -h` - Show brief help
- `--version, -v` - Show version information
## Using the MOP Solver Programming Interface
In addition to the [standalone interface](#using-the-mop-solver-programming-interface), you can also use a programming interface to the MOP Solver. This C based API allows the MOP Solver to be embedded in various programming environments.
To get started with the MOP Solver C API, usage examples and reference documentation are provided under the [optiSLang MOPSolver API documentation](https://developer.ansys.com/docs/optislang-mopsolver-api-2023-r2/index.xhtml).
The MOP Solver installation and its API is located within the base installation directory (`[installation path]`) and includes the following subfolders and files:
| Directory | File | Description |
|-----------|------|-------------|
| `[installation path]/tools/mopsolver/bin/` | mopsolver.exe | MOP Solver executable with its dependencies. This install package contains the dynamic libraries which are necessary to use the MOPSolver API. |
| `[installation path]/tools/mopsolver/bin/` | mopsolver.dll / mopsolver.so | Shared library to access mop solver functionality including support for python based meta-models. |
| `[installation path]/tools/mopsolver/bin/` | mopsolver_no_ctm.dll / mopsolver_no_ctm.so | Shared library to access mop solver functionality without support for python based meta-models. |
| `[installation path]/tools/mopsolver/lib` | mopsolver.lib, mopsolver_no_ctm.lib | Respective static libraries with and without support for python based meta-models. |
| `[installation path]/tools/mopsolver/include` | hopsolver_api.h | The MOP Solver header file. |
| `[installation path]/tools/mopsolver/examples` | mop_tenbar.omdb | Example monitoring database file. |
| `[installation path]/tools/mopsolver/examples` | msapi_sample01_cpp.cpp | Code example to show the use of the mopsolver interface with C++ programming language. |
| `[installation path]/tools/mopsolver/examples` | msapi_sample01_c.c | Code example to show the use of the mopsolver interface with C programming language. |
64 changes: 32 additions & 32 deletions .../oSL_API_interfaces_customization-26-r1/opti_api_functional_mockup_interface.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
# Functional Mock-up Interface

The Functional Mock-Up Interface (FMI) enables suppliers to distribute models from various domains ([http://fmi-standard.org/](http://fmi-standard.org/)). The unified FMI standard allows you to combine models in a single simulation environment. You can simplify your design process by using combined models, called Functional Mock-Up Units (FMU), instead of relying on proprietary interfaces. An FMU is a single file that can be imported and then used as a component in any simulation tool.

You can export a Metamodel of Optimal Prognosis (MOP) or an Adaptive Metamodel of Optimal Prognosis (AMOP) as an FMU. Exporting is supported only for the following metamodels:
- Polynomial
- Kriging
- Moving least squares

To export as an FMU:
1. Open the **Functional Mock-up Unit** dialog box.
- After the calculation has finished, right-click the **MOP** or **AMOP** node and select **Export FMU** from the context menu.
- Import a monitoring database file that has already been saved into an **MOP Solver** node, then right-click the node and select **Export FMU** from the context menu.
- In the **Postprocessing** window, select **File > Export FMU**.
2. Set the following export options:

| Field | Description |
|-------|-------------|
| Output File | Path to a text file the log will be written to. |
| Name | Mandatory model name. |
| Description | Short description of the model. |
| Author | Names of the model's authors. |
| Extrapolation | - Never: Does not create an output slot and prevents calculation of the selected field.<br>- Toggle by Pin: Creates an additional input slot that is used during simulation runtime to enable or disable the calculation of the selected field dynamically.<br>- Always: Creates an output slot and allows calculation of the selected field. |
| Criteria | - Never: Does not create an output slot and prevents calculation of the selected field.<br>- Toggle by Pin: Creates an additional input slot that is used during simulation runtime to enable or disable the calculation of the selected field dynamically.<br>- Always: Creates an output slot and allows calculation of the selected field. |
| Gradients | - Never: Does not create an output slot and prevents calculation of the selected field.<br>- Toggle by Pin: Creates an additional input slot that is used during simulation runtime to enable or disable the calculation of the selected field dynamically.<br>- Always: Creates an output slot and allows calculation of the selected field. |
| Densities | - Never: Does not create an output slot and prevents calculation of the selected field.<br>- Toggle by Pin: Creates an additional input slot that is used during simulation runtime to enable or disable the calculation of the selected field dynamically.<br>- Always: Creates an output slot and allows calculation of the selected field. |
| Errors | - Never: Does not create an output slot and prevents calculation of the selected field.<br>- Toggle by Pin: Creates an additional input slot that is used during simulation runtime to enable or disable the calculation of the selected field dynamically.<br>- Always: Creates an output slot and allows calculation of the selected field. |
| Enable File Logging | Select the check box to enable logging of parameter and response values for each MOP Solver call. The logfile's path is `%TEMP%\mopsolver_fmu.log`. |

3. Click **Start**.

The resulting FMU implements Functional Mock-Up Interface for Model Exchange 1.0. Usage is currently limited to 64 bit Windows and Linux systems.
# Functional Mock-up Interface
The Functional Mock-Up Interface (FMI) enables suppliers to distribute models from various domains ([http://fmi-standard.org/](http://fmi-standard.org/)). The unified FMI standard allows you to combine models in a single simulation environment. You can simplify your design process by using combined models, called Functional Mock-Up Units (FMU), instead of relying on proprietary interfaces. An FMU is a single file that can be imported and then used as a component in any simulation tool.
You can export a Metamodel of Optimal Prognosis (MOP) or an Adaptive Metamodel of Optimal Prognosis (AMOP) as an FMU. Exporting is supported only for the following metamodels:
- Polynomial
- Kriging
- Moving least squares
To export as an FMU:
1. Open the **Functional Mock-up Unit** dialog box.
- After the calculation has finished, right-click the **MOP** or **AMOP** node and select **Export FMU** from the context menu.
- Import a monitoring database file that has already been saved into an **MOP Solver** node, then right-click the node and select **Export FMU** from the context menu.
- In the **Postprocessing** window, select **File > Export FMU**.
2. Set the following export options:
| Field | Description |
|-------|-------------|
| Output File | Path to a text file the log will be written to. |
| Name | Mandatory model name. |
| Description | Short description of the model. |
| Author | Names of the model's authors. |
| Extrapolation | - Never: Does not create an output slot and prevents calculation of the selected field.<br>- Toggle by Pin: Creates an additional input slot that is used during simulation runtime to enable or disable the calculation of the selected field dynamically.<br>- Always: Creates an output slot and allows calculation of the selected field. |
| Criteria | - Never: Does not create an output slot and prevents calculation of the selected field.<br>- Toggle by Pin: Creates an additional input slot that is used during simulation runtime to enable or disable the calculation of the selected field dynamically.<br>- Always: Creates an output slot and allows calculation of the selected field. |
| Gradients | - Never: Does not create an output slot and prevents calculation of the selected field.<br>- Toggle by Pin: Creates an additional input slot that is used during simulation runtime to enable or disable the calculation of the selected field dynamically.<br>- Always: Creates an output slot and allows calculation of the selected field. |
| Densities | - Never: Does not create an output slot and prevents calculation of the selected field.<br>- Toggle by Pin: Creates an additional input slot that is used during simulation runtime to enable or disable the calculation of the selected field dynamically.<br>- Always: Creates an output slot and allows calculation of the selected field. |
| Errors | - Never: Does not create an output slot and prevents calculation of the selected field.<br>- Toggle by Pin: Creates an additional input slot that is used during simulation runtime to enable or disable the calculation of the selected field dynamically.<br>- Always: Creates an output slot and allows calculation of the selected field. |
| Enable File Logging | Select the check box to enable logging of parameter and response values for each MOP Solver call. The logfile's path is `%TEMP%\mopsolver_fmu.log`. |
3. Click **Start**.
The resulting FMU implements Functional Mock-Up Interface for Model Exchange 1.0. Usage is currently limited to 64 bit Windows and Linux systems.
Loading