program load command

Syntax

program load keyword

Load a compatible DLL.

Note

As with all program commands, use of the command word program is optional; program load and load are both valid.

The DLLs can be a user-defined FISH function, contact model, constitutive model for zones or structural elements, framework module, or a framework GUI module. The type of module being loaded must be specified with either the cmodel, contactmodelmechanical, function, guimodule, module or plotitem keywords.

Plugins are loaded into the program, and remain available until program shutdown. The list of currently loaded plugins is available by executing the program list plugins command.

The “Tools/Plugins” menu of the user interface provides a general plugin manager dialog.

cmodel [loadoptions]

Load constitutive model DLLs. The plugin file prefix is model. The additional model will appear in the list of available models by executing the zone cmodel list command in FLAC3D.

contactmodelmechanical [loadoptions]

Load mechanical contact model DLLs. The plugin file prefix is contactmodelmechanical3d in 3d and contanctmodelmechanical2d in 2d. As these contact models apply to contacts between balls, pebbles, and wall facets, the PFC module must first be loaded (see the module keyword).

function [loadoptions]

Load one or more FISH function DLLs. The plugin file prefix is fish. A FISH function DLL may create one or more FISH intrinsics, that will appear in the list available by executing the fish list intrinsics command.

guimodule [loadoptions]

Load framework GUI module DLLs. The plugin file prefix is guimodule3d in 3d and guimodule2d in 2d. In general, an engine module exists to drive each GUI module and an engine module must be loaded before a GUI module (see the module keyword).

module [loadoptions]

Load framework engine [DR: provide definition of this term to CS; CS: put defintion into terminology scheme] module DLLs. The plugin file prefix is module3d in 3d and module2d in 2d. The module will appear in the list available by executing the program list module command.

plotitem [loadoptions]

Load framework plot item DLLs. The plugin file prefix is plotitem3d in 3d and plotitem2d in 2d.

Block of Common Options for Loading

The following keywords are available to affect how plugins of a given type are loaded. cmodel, contactmodelmechanical, function, guimodule, module and plotitem.

s

Load the plugin DLL file named s. Either the full file name can be given, or the code will attempt to find a name matching the pattern “prefixname005.dll” where s = name and the prefix matches the plugin type. If a full path is not given, the code will look in the executable directory and all subdirectories as well as the current directory and all subdirectories for a match.

automatic

Attempt to load all plugins found matching “prefixname005.dll” where prefix matches the plugin type and name matches anything available. By default this will scan the “exe64/plugins” directory of the installation location, and all subdirectories. This can be overruled with the directory keyword.

directory sd

Specify the directory to scan when using automatic. All subdirectories will also be scanned. The default directory is “exe64/plugins” directory of the installation location.