Introduction<\/h2><\/h2><\/span><\/div><\/div><\/div>The creation of a new computation model in Abaqus\/CAE usually requires recurring definitions, such as the definition of a material with corresponding section, such as the request for field and history output, such as step definitions, friction properties and much more.<\/p>\n
In order not to have to perform repetitive definitions for each new model, you can easily create a plugin with the help of this article. So, corresponding definitions are done at the push of a button. Thus, boring and tedious work can be saved.<\/p>\n
The following example shows how to create such a plugin using the RSG Dialog Builder.<\/p>\n
RSG Dialog Builder provides a simple means of creating plugins in Abaqus\/CAE. Here the RSG Builder consists of two parts, the GUI and the executing script in the kernel of Abaqus\/CAE. In this example, the GUI is created manually. For the creation of the script we use the Macro Recorder for the most part. To the RSG Dialog Builder we have another contribution to<\/a> the automatic generation of screw parts<\/a>.<\/p>\n<\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/span>Definition of the variables<\/h2><\/h2><\/span><\/div><\/div><\/div>If you want to define names or values with the QuickStart plugin, you need a list of possible variables. In the present example, 2 materials with sections, as well as 2 steps with corresponding initial time increments, and outputs for a field and a history plot are to be defined.<\/p>\n
This results in the following list of variables<\/p>\n
\n- SN = Material name steel<\/li>\n
- ES = Young’s modulus steel<\/li>\n
- NueS = steel Poisson’s ratio<\/li>\n
- DS = Density steel<\/li>\n
- AS = Heat expansion coefficient steel<\/li>\n
- SSt = Section name steel<\/li>\n
- AN = Material name Aluminum<\/li>\n
- EA = Young’s modulus aluminum<\/li>\n
- NueA = Poisson’s ratio Aluminum<\/li>\n
- DA = Density aluminum<\/li>\n
- AA = Heat expansion coefficient aluminum<\/li>\n
- SAL = Section name Alu<\/li>\n
- SN1 = Name Step 1<\/li>\n
- IncS1 = Increment Step 1<\/li>\n
- SN2 = Name Step 2<\/li>\n
- IncS2 = Increment Step 2<\/li>\n
- IP1 = Interaction Property Name<\/li>\n
- FR = Friction coefficient for interaction<\/li>\n
- FO = Name for Field Output<\/li>\n
- HO = Name for History Output<\/li>\n<\/ul>\n
or all variables in one line<\/p>\n
\n- SN,ES,NueS,DS,AS,SSt,AN,EA,NueA,DA,AA,SAL,SN1,IncS1,SN2,IncS2,IP1,FR,FO,HO<\/li>\n<\/ul>\n
The list here serves only as an example.<\/p>\n<\/div><\/div><\/div><\/div><\/div>
<\/div><\/div><\/span>GUI creation<\/h2><\/h2><\/span><\/div><\/div><\/div><\/div>RSG Dialog Builder consists of 2 parts – the GUI and the script to be executed. After opening the RSG Dialog Builder, see picture below left, the GUI is offered under the GUI tab, see picture below right, the definitions of the script under the Kernel tab. In this section we will create the GUI.<\/p>\n
You should define a title for the dialog box. The activated Show dialog in test mode provides a live view of the GUI.<\/p>\n<\/div>
<\/div>![\"Quick](\"https:\/\/plm.systemworkx.de\/wp-content\/uploads\/2023\/06\/QuickStartPlugin_b1.png\")
<\/a><\/span><\/div><\/div><\/div>In this example we will work only with the Book tab, the Tab and the Text Field.<\/p>\n<\/div>
![\"Quick](\"https:\/\/plm.systemworkx.de\/wp-content\/uploads\/2023\/06\/QuickStartPlugin_b2.png\")
<\/a><\/span><\/div><\/div>When creating the GUI, we start with a Tab Book in which we want to sort all definitions using tabs. Within a tab we work only with text fields. Here the text corresponds to the above defined description of a variable, the type here to a string for a name or a float for a value, the keyword to the above agreed variables and default to the name or value when calling the plugin. Here you should directly use the correct values and names, because these are permanently stored in the plugin.<\/p>\n<\/div>
![\"Quick](\"https:\/\/plm.systemworkx.de\/wp-content\/uploads\/2023\/06\/QuickStartPlugin_b3.png\")
<\/a><\/span><\/div><\/div>The finished GUI with all inputs will look like this. The tabs provide better clarity.<\/p>\n<\/div>
![\"Quick](\"https:\/\/plm.systemworkx.de\/wp-content\/uploads\/2023\/06\/QuickStartPlugin_b4.png\")
<\/a><\/span><\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/span>Creation of the script<\/h2><\/h2><\/span><\/div><\/div><\/div><\/div>When creating the script we want to use the Macro Recorder. This saves us from studying the Abaqus\/CAE customization manuals.<\/p>\n
The following work steps are performed:<\/p>\n
\n- Starting Abaqus\/CAE with the selection of Create Model Database with Standard\/Explicit Model<\/li>\n
- Starting the macro recorder<\/li>\n
- Definition of the material data (here steel and aluminum) as well as the corresponding sections, definition of the steps, contact settings, field and history output.<\/li>\n
- Closing the macro recorder<\/li>\n<\/ol>\n
The macro recorder creates two files in the working directory with the names abaqus1.rec and abaqusMacros.py. The content is accumulated, so it is recommended to delete an existing file of this name so that the content contains only the Python code required for the script.<\/p>\n<\/div>
![\"Quick](\"https:\/\/plm.systemworkx.de\/wp-content\/uploads\/2023\/06\/QuickStartPlugin_b5.png\")
<\/a><\/span><\/div><\/div><\/div><\/div><\/div><\/div><\/div>Now the file abaqusMacros.py can be opened with the editor. Here, the editor Notepad++ is used for editing, see [1]. Here, the QuickStart function is defined for the script. It does not yet contain any parameters\/keywords and must now be filled. The rest of this block is taken, even if it calls modules that are not needed for the script. It is recommended to save this file under a new name, e.g. QuickStart.py.<\/p>\n<\/div><\/div><\/div>
<\/div><\/div>![\"Quick](\"https:\/\/plm.systemworkx.de\/wp-content\/uploads\/2023\/06\/QuickStartPlugin_b6.png\")
<\/a><\/span><\/div><\/div><\/div><\/div><\/div>When editing the function, some Python, [2], knowledge is helpful. But you can also contact us. We are happy to support.<\/p>\n
It serves to simplify the scripts if you use placeholders. Here we introduce a placeholder for the currently used window in Abaqus\/CAE (called viewport) and the model. When starting Abaqus\/CAE without calling an existing .cae file, these are usually ‘Viewport: 1’ and ‘Model-1’.<\/p>\n
If you add the two lines<\/p>\n
\n- VN = session.currentViewportName<\/li>\n
- MN = session.sessionState[VN][‘modelName’]<\/li>\n<\/ul>\n
to the script as shown in the picture, then you can replace all further occurrences of ‘Viewport: 1’ with VN and all occurrences of ‘Model-1’ with MN. If you used a different model name or opened another viewport before you started the MacroRecorder, please replace accordingly.<\/p>\n<\/div>
![\"Quick](\"https:\/\/plm.systemworkx.de\/wp-content\/uploads\/2023\/06\/QuickStartPlugin_b7.png\")
<\/a><\/span><\/div><\/div><\/div>Now the variables should be added to the script.<\/p>\n
In a first step, all variables are to be passed when calling the function. To do this, insert the above line with the variables into the empty parenthesis after def QuickStart().<\/p>\n
Then all entries of the variables in the script are replaced by the variables themselves. So, here, in the picture below the model name ‘Model-1’ by MN, the name ‘Steel’ by SN, ‘Alu’ by AN, the values of the E-moduli by the variables ES and EA, and so on.<\/p>\n<\/div>
![\"Quick](\"https:\/\/plm.systemworkx.de\/wp-content\/uploads\/2023\/06\/QuickStartPlugin_b8.png\")
<\/a><\/span><\/div><\/div><\/div>Now the finished script is inserted in the RSG Dialog Builder in the Kernel tab via the Open file function. Here, the Modules field is filled in automatically, but the function must be selected, since scripts can basically contain multiple function definitions.<\/p>\n<\/div>
![\"Quick](\"https:\/\/plm.systemworkx.de\/wp-content\/uploads\/2023\/06\/QuickStartPlugin_b9.png\")
<\/a><\/span><\/div><\/div><\/div>It is recommended that while working on your own QuickStart plugin, you save it in the working directory. Thus, the plugin is only loaded when Abaqus is started from this working directory.<\/p>\n
Only the finished plugin should then be saved so that it is always loaded when Abaqus is called. This is the case in 2 places.<\/p>\n
If you save the plugin in the home directory of a user, the plugin will be loaded for this user every time Abaqus is called.<\/p>\n
But there is also the possibility to store the plugin in a central directory for multiple users. This central directory is defined in the abaqus_v6.env file via the entry<\/p>\n
plugin_central_dir=”C:\\Simulia\\CAE\\plugins20″<\/p>\n
. Here the directory is used, which is set up by default during the installation. The abaqus_v6.env file is located in a user’s home directory or working directory. The entry can also be made centrally for multiple users in the case of central installations. But more about this in a separate wiki.<\/p>\n<\/div>
![\"Quick](\"https:\/\/plm.systemworkx.de\/wp-content\/uploads\/2023\/06\/QuickStartPlugin_b10.png\")
<\/a><\/span><\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/span>Worth knowing<\/h2><\/h2><\/span><\/div><\/div><\/div><\/div><\/div>You should save intermediate states of the creation of your own QuickStart plugin in the working directory. If you want to continue working on an intermediate state, use the File Open dialog to load the intermediate state into the RSG Dialog Builder.<\/p>\n<\/div>
In the manual, one searches in vain for an introduction to the RSG Dialog Builder. A short introduction can be found in the RSG Dialog Builder via the Alarm Clock button, which is located directly under the GUI tab.<\/p>\n<\/div><\/div><\/div>
<\/div>![\"Quick](\"https:\/\/plm.systemworkx.de\/wp-content\/uploads\/2023\/06\/QuickStartPlugin_b11.png\")
<\/a><\/span><\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/span>Summary<\/h2><\/h2><\/span><\/div><\/div><\/div>RSG Dialog Builder in interaction with Macro Recorder offers the possibility to create dialogs for a more efficient working with Abaqus\/CAE. For this, extensive knowledge of customization and scripting with Python is not necessary.<\/p>\n
Here, we have shown how to create a script with little effort, which can perform recurring definitions at the beginning of a new model in Abaqus\/CAE with one click.<\/p>\n
We will be happy to assist you in creating your QuickStart plugin. Get in contact with us.<\/p>\n<\/div><\/div><\/div><\/div><\/div>
<\/div><\/div><\/div><\/div><\/span>Literature<\/h2><\/h2><\/span><\/div><\/div><\/div><\/div>\n\n\n\n\n\n\n\n\nIn part, this text and illustrations shown are based on research of evaluated literature. If this is the case, the sources are marked in the text by a number, e.g. [2], and the source is listed here.<\/p>\n
In part, however, the sources listed here should simply be understood as recommendations for further reading.<\/p>\n<\/div>\n
\n\n\n\n\n\n[1] \u201cNotepad++<\/a>\u201d [Online]. [Accessed: 13-Jun-2023]<\/div>\n[2] \u201cWelcome to Python.Org<\/a>,\u201d Python.org [Online] [Accessed: 13-Jun-2023]<\/div>\n
The creation of a new computation model in Abaqus\/CAE usually requires recurring definitions, such as the definition of a material with corresponding section, such as the request for field and history output, such as step definitions, friction properties and much more.<\/p>\n
In order not to have to perform repetitive definitions for each new model, you can easily create a plugin with the help of this article. So, corresponding definitions are done at the push of a button. Thus, boring and tedious work can be saved.<\/p>\n
The following example shows how to create such a plugin using the RSG Dialog Builder.<\/p>\n
RSG Dialog Builder provides a simple means of creating plugins in Abaqus\/CAE. Here the RSG Builder consists of two parts, the GUI and the executing script in the kernel of Abaqus\/CAE. In this example, the GUI is created manually. For the creation of the script we use the Macro Recorder for the most part. To the RSG Dialog Builder we have another contribution to<\/a> the automatic generation of screw parts<\/a>.<\/p>\n<\/div><\/div><\/div><\/div><\/div> If you want to define names or values with the QuickStart plugin, you need a list of possible variables. In the present example, 2 materials with sections, as well as 2 steps with corresponding initial time increments, and outputs for a field and a history plot are to be defined.<\/p>\n This results in the following list of variables<\/p>\n or all variables in one line<\/p>\n The list here serves only as an example.<\/p>\n<\/div><\/div><\/div><\/div><\/div> RSG Dialog Builder consists of 2 parts – the GUI and the script to be executed. After opening the RSG Dialog Builder, see picture below left, the GUI is offered under the GUI tab, see picture below right, the definitions of the script under the Kernel tab. In this section we will create the GUI.<\/p>\n You should define a title for the dialog box. The activated Show dialog in test mode provides a live view of the GUI.<\/p>\n<\/div> In this example we will work only with the Book tab, the Tab and the Text Field.<\/p>\n<\/div> When creating the GUI, we start with a Tab Book in which we want to sort all definitions using tabs. Within a tab we work only with text fields. Here the text corresponds to the above defined description of a variable, the type here to a string for a name or a float for a value, the keyword to the above agreed variables and default to the name or value when calling the plugin. Here you should directly use the correct values and names, because these are permanently stored in the plugin.<\/p>\n<\/div> The finished GUI with all inputs will look like this. The tabs provide better clarity.<\/p>\n<\/div> When creating the script we want to use the Macro Recorder. This saves us from studying the Abaqus\/CAE customization manuals.<\/p>\n The following work steps are performed:<\/p>\n The macro recorder creates two files in the working directory with the names abaqus1.rec and abaqusMacros.py. The content is accumulated, so it is recommended to delete an existing file of this name so that the content contains only the Python code required for the script.<\/p>\n<\/div> Now the file abaqusMacros.py can be opened with the editor. Here, the editor Notepad++ is used for editing, see [1]. Here, the QuickStart function is defined for the script. It does not yet contain any parameters\/keywords and must now be filled. The rest of this block is taken, even if it calls modules that are not needed for the script. It is recommended to save this file under a new name, e.g. QuickStart.py.<\/p>\n<\/div><\/div><\/div> When editing the function, some Python, [2], knowledge is helpful. But you can also contact us. We are happy to support.<\/p>\n It serves to simplify the scripts if you use placeholders. Here we introduce a placeholder for the currently used window in Abaqus\/CAE (called viewport) and the model. When starting Abaqus\/CAE without calling an existing .cae file, these are usually ‘Viewport: 1’ and ‘Model-1’.<\/p>\n If you add the two lines<\/p>\n to the script as shown in the picture, then you can replace all further occurrences of ‘Viewport: 1’ with VN and all occurrences of ‘Model-1’ with MN. If you used a different model name or opened another viewport before you started the MacroRecorder, please replace accordingly.<\/p>\n<\/div> Now the variables should be added to the script.<\/p>\n In a first step, all variables are to be passed when calling the function. To do this, insert the above line with the variables into the empty parenthesis after def QuickStart().<\/p>\n Then all entries of the variables in the script are replaced by the variables themselves. So, here, in the picture below the model name ‘Model-1’ by MN, the name ‘Steel’ by SN, ‘Alu’ by AN, the values of the E-moduli by the variables ES and EA, and so on.<\/p>\n<\/div> Now the finished script is inserted in the RSG Dialog Builder in the Kernel tab via the Open file function. Here, the Modules field is filled in automatically, but the function must be selected, since scripts can basically contain multiple function definitions.<\/p>\n<\/div> It is recommended that while working on your own QuickStart plugin, you save it in the working directory. Thus, the plugin is only loaded when Abaqus is started from this working directory.<\/p>\n Only the finished plugin should then be saved so that it is always loaded when Abaqus is called. This is the case in 2 places.<\/p>\n If you save the plugin in the home directory of a user, the plugin will be loaded for this user every time Abaqus is called.<\/p>\n But there is also the possibility to store the plugin in a central directory for multiple users. This central directory is defined in the abaqus_v6.env file via the entry<\/p>\n plugin_central_dir=”C:\\Simulia\\CAE\\plugins20″<\/p>\n . Here the directory is used, which is set up by default during the installation. The abaqus_v6.env file is located in a user’s home directory or working directory. The entry can also be made centrally for multiple users in the case of central installations. But more about this in a separate wiki.<\/p>\n<\/div> You should save intermediate states of the creation of your own QuickStart plugin in the working directory. If you want to continue working on an intermediate state, use the File Open dialog to load the intermediate state into the RSG Dialog Builder.<\/p>\n<\/div> In the manual, one searches in vain for an introduction to the RSG Dialog Builder. A short introduction can be found in the RSG Dialog Builder via the Alarm Clock button, which is located directly under the GUI tab.<\/p>\n<\/div><\/div><\/div> RSG Dialog Builder in interaction with Macro Recorder offers the possibility to create dialogs for a more efficient working with Abaqus\/CAE. For this, extensive knowledge of customization and scripting with Python is not necessary.<\/p>\n Here, we have shown how to create a script with little effort, which can perform recurring definitions at the beginning of a new model in Abaqus\/CAE with one click.<\/p>\n We will be happy to assist you in creating your QuickStart plugin. Get in contact with us.<\/p>\n<\/div><\/div><\/div><\/div><\/div> In part, this text and illustrations shown are based on research of evaluated literature. If this is the case, the sources are marked in the text by a number, e.g. [2], and the source is listed here.<\/p>\n In part, however, the sources listed here should simply be understood as recommendations for further reading.<\/p>\n<\/div>\nDefinition of the variables<\/h2><\/h2><\/span>
\n
\n
GUI creation<\/h2><\/h2><\/span>
<\/a><\/span><\/div><\/div><\/a><\/span><\/div><\/div><\/a><\/span><\/div><\/div><\/a><\/span><\/div><\/div><\/div><\/div><\/div><\/div>Creation of the script<\/h2><\/h2><\/span>
\n
<\/a><\/span><\/div><\/div><\/a><\/span><\/div><\/div><\/div><\/div>\n
<\/a><\/span><\/div><\/div><\/a><\/span><\/div><\/div><\/a><\/span><\/div><\/div><\/a><\/span><\/div><\/div><\/div><\/div><\/div><\/div>Worth knowing<\/h2><\/h2><\/span>
<\/a><\/span><\/div><\/div><\/div><\/div><\/div><\/div>Summary<\/h2><\/h2><\/span>
Literature<\/h2><\/h2><\/span>