Adams Car Package > Adams Tire > User-Written Tire/Road Models > Creating Tire Models for STI > Instructing Adams Tire to Call Your TYRSUB

Instructing Adams Tire to Call Your TYRSUB

There are two methods to instruct Adams Tire to call your user tire model:

User Tire library plug-in method

Adams Tire is able to load an Adams user library containing the user specific tire and road code based on the instructions in the tire property file:
[MODEL]
PROPERTY_FILE_FORMAT ='USER'
FUNCTION_NAME ='<tireuserlibname>::<tyrsub>'
The <tireuserlibname> can include a path, while the <tyrsub> can be any name, but the argument list should be fulfilling the requirements as stated in TYRSUB Calling Sequence.
Compiling and building the user library can be done with the Adams script in the command window:
■For Linux and Linux platforms:
adams2024_1 -c cr-user ..
■For windows platforms:
adams2024_1 cr-user ..
The Example Tire Model (STI) is using this tire plug-in method. The tire property file of this example code reads:
[MODEL]
PROPERTY_FILE_FORMAT = 'USER'
FUNCTION_NAME = 'usertire::TYR501'
So building the user library for this code can be done with (Windows):
adams2024_1 cr-user n tyr501.f rpf501.f -n usertire.dll exit
Running the model (that is, model.acf) can be done in the standard way (Windows):
adams2024_1 ru-standard model.acf
or
adams2024_1 acar ru-solver model.acf

Library names and search paths

When specifying the name of the <tireuserlibname> the Adams solver will have will try loading several species of the library name (depending on the platform) and have an extensive search path. When it cannot find the library, it will list the library names tried and the used search path, for example, when looking for the tireuserlibname equal to 'usertireroad', it may look for:
---- START: ERROR ----
The user library "usertireroad" could not be located. These name(s) were searched for: usertireroad, libusertireroad, usertireroad.dll, libusertireroad.dll. They were not located in the path list;C:\TNO Delft-Tyre\MF-Tyre MF-Swift 6.2.0.3\DelftTyre_LIBS;c:/users/joost/acar_private;c:/users/joost/acar_private\win64;C:\TNO Delft-Tyre\MF-Tyre MF-Swift 6.2.0.3\DelftTyre_LIBS;C:\TNO Delft-Tyre\MF-Tyre MF-Swift 6.2.0.3\DelftTyre_LIBS\win64;c:\Program Files\MSC.Software\Adams\2024_1\;c:\Program Files\MSC.Software\Adams\2024_1\\win64;c:\Program Files\MSC.Software\Adams\2024_1\win64\uconfg_extralg;c:\Program Files\MSC.Software\Adams\2024_1\win64;c:\Program Files\MSC.Software\Adams\2024_1\common\win64\matlab\bin\win64;c:\Program Files\MSC.Software\Adams\2024_1\bin;unknown\bin;unknown\bin\client;c:\Program Files\MSC.Software\Adams\2024_1\richclient\SCA_Kernel\WIN8664\lib;unknown\bin\server;c:\Program Files\MSC.Software\Adams\2024_1\viewflex\mdss\WIN8664\msc20170\win64i8\lib;c:\Program Files\MSC.Software\Adams\2024_1\viewflex\mdss\WIN8664\msc20170\win64i8\lib\SCA\MDSolver\Obj;c:\Program Files\MSC.Software\Adams\2024_1\viewflex\ncode\WIN8664\bin;c:\Program Files\MSC.Software\Adams\2024_1\ct\WIN8664\lib;c:\Program Files\MSC.Software\Adams\2024_1\ct\WIN8664\lib\SCA\CT;c:\Program Files\MSC.Software\Adams\2024_1\\amach
ID = 1
Note that the library name at Linux platforms is case-sensitive.
For more detailed information on the search path refer Section 2: The search path algorithm for plugin discovery.

Adams User library method

When linking your tire model against the solver, you instruct Adams Tire to call your TYRSUB by defining a tire property file that specifies a user property file format in the following way:
[MODEL]
PROPERTY_FILE_FORMAT = 'USER'
FUNCTION_NAME        = '<tyrsub>'
Compiling and building an Adams Car or Adams Solver user library can be done with the Adams script in the command window:
■For Linux and Linux platforms:
adams2024_1 -c cr-user ..
■For windows platforms:
adams2024_1 cr-user ..
When changing the tire property file of the Example Tire Model (STI) into:
[MODEL]
PROPERTY_FILE_FORMAT = 'USER'
FUNCTION_NAME        = 'TYR501'
The user library for the example code can be created with (Windows):
adams2024_1 cr-user y rpf501.f tyr501.f -n mysol.dll exit
Simulating the model (that is, model.acf) can be done with (Windows):
adams2024_1 ru-user mysol.dll model.acf exit