## Keyboard shortcuts

Press `←` or `→` to navigate between chapters

Press `S` or `/` to search in the book

Press `?` to show this help

Press `Esc` to hide this help

# Usage

The parameter input for user defined material models are defined using the `*MAT_USER_[X]` command in the input deck. See the *MAT_USER_X documentation for more information.

The framework example library is built as `IMPETUS example user material`. When using the GUI, keep the `.dll` or `.so` together with `IMPETUS example user material.xml`; the XML gives the GUI the friendly material documentation. The embedded manifest is already inside the binary and does not need to be copied as a separate file.

Use `IMPETUS example user material` as the optional title line on the example `*MAT_USER_X` cards. For your own user materials, set the optional title to the base name shared by your compiled library and XML file. The GUI editor uses that title to find the XML manual entry when the cursor is on a `*MAT_USER_X` command.

## Start simulation with your DLL / shared object in the GUI

1. In IMPETUS Solver GUI, navigate to `Solve` and then in the Ribbon menu click on `Start simulation` button.
2. Browse for your input file.
3. Check the “Use defined material model” check box.
4. Browse for your DLL / shared object file.
5. Click `Start` button to start the simulation.

## Start simulation with your DLL / shared object in CLI

To start simulations in CLI, use the `impstart` command, which is located in `[installation_dir]/Solver/gui`. This tool add simulations to the job queue and status can be seen in the `Solve` tab of IMPETUS Solver GUI.

#### Usage

    impstart [options] INPUTFILE

Impstart is a command line tool and its options are obtained by executing it without arguments.

Use the `--material-path` option to specify where to find the material DLL / shared object file.

#### Example

    impstart --material-path /path/to/user-material.so /path/to/input-file.k