Customization Guide

www.kxcad.net Home > CAE Index > ANSYS Index > Release 11.0 Documentation for ANSYS Workbench


Your Ad Here

Before embarking on Job Script customization, consult ANSYS Technical Support or your ANSYS Software Distributor to check if new Job Scripts have been made available after release.

Customizing an Existing Job

Job Templates, Code Templates, and code for ANSYS Workbench Simulation are included with the RSM installation are located in:

[installdir]\Config\xml and \scripts
Visual Studio projects are supplied in the scripts folder to aid in editing.


Back To Top

Editing Scripts

The Job Script files are currently delivered in the C# language. Theoretically, it is possible to use Visual Basic and JScript languages but currently this has not been officially tested. C++ may also be supported in future release.


Back To Top

Using Keywords

Keywords are used to invoke specialized scripts to integrate with non-native operating systems (e.g. Unix, Linux) and third party job schedulers (e.g. LSF, MS Compute Cluster). The Keyword is appended to the base Job Code Template name. For example, if the code template is named ServerTestCode.xml and the Keyword is “LSF”, RSM will first look for ServerTestCode_LSF.xml. Keywords are the best way to invoke custom scripts without affecting the existing jobs.


Back To Top

Job Templates

Job Templates define the Code Template (see below), inputs and outputs of a Job. The Job Template for a Server Test job is shown below.

<?xml version="1.0" ?>

<jobTemplate>

<script>ServerTestCode.xml</script>

<debug>TRUE</debug>

<cleanup>TRUE</cleanup>

<inputs>

<file type="ascii">*.in</file>

</inputs>

<outputs>

<file type="ascii">*.out</file>

</outputs>

</jobTemplate>


Back To Top

Code Template

A Code Template for a Server Test Job is shown below. The template contains sections for the actual code files, referenced assemblies (.dlls) and support files (such as localized strings). These files are transferred to the Compute Server and processed by the ScriptHostService on that computer.

<?xml version="1.0" ?>

<codeDefinition>

<codeFiles>

<codeFile>ServerTest.cs</codeFile>

</codeFiles>

<references />

<supportFiles />

</codeDefinition>


Back To Top

RSM Integration

Submitting completely new jobs (as opposed to customizations to existing jobs) involves using the RSM API in the client application. Contact ANSYS Technical Support for information on integrating an application with RSM.

Your Ad Here