asxCommandModel: writeAsx

Syntax

Defined in couplingProperties dictionary.

asxCommandModels
(
   writeAsx
);

writeAsxProps
{
    path             "path";
    writeName        "name";
    overwrite        switch;
    purgeWrite       label;
}
verbose              switch;

path = alternative write path relative to execution directory for saving the restart file. If the path does not exist, it will be created. (default: “../DEM/restart”)
writeName = name of the restart file to be written in specified path. (default: “aspherix.restartCFDEM”)
overwrite = switch to select if only one restart file writeName or many files writeName_timeStamp are written (default: false)
verbose = flag for verbose output (default: false)
purgeWrite (controlDict) = integer for limiting the number of restart files written. This setting will be overruled by writeAsxProps/purgeWrite for DEM restart files! (default: 0, i.e. off)

Warning

This purgeWrite setting (read from system/controlDict) also affects CFD result files!
purgeWrite (writeAsxProps) = integer for limiting the number of restart files written, i.e. for purgeWrite = 2, only the last 2 restart files will be kept. This setting is only processed if overwrite = false and may overrule the setting in system/controlDict. (default: 0, i.e. off)

Examples

asxCommandModels
(
   runAsx
   writeAsx
);

writeAsxProps
{
     purgeWrite 4;
}

Description

Warning

The optional settings for asxCommandModels, which were previously defined in a separate constant/asxCommands dictionary file are now read from constant/couplingProperties. For now the legacy style of providing a separate constant/asxCommands dictionary is still supported, but not recommended to be used!

The writeAsx command requests the DEM side to write result and restart files at CFD output time steps. This procedure ensures that a restart file is available for (at least the last) CFD result set to continue a started simulation.

This model is active by default (see couplingProperties on how deactivate this model) and it’s default bahavior is to requests a data write at DEM side whenever CFD data is written. This behavior overrules user-defined write intervals on the DEM side. Use the writeDEMOutput switch in twoWaySocket to deactivate this behavior.

Note

Although results writing on the DEM side via this models can be used alongside the IOModels it is recommended procedure to not use an IOModel in parallel in order to reduce the amount of written data.

The purgeWrite options (defined in system/controlDict and constant/couplingProperties/asxWriteProps) limit the number of stored CFD result files and Aspherix restart files. Only the last n files will be kept. Several operation modes are possible:

system/controlDict/purgeWrite will set the number of snapshots stored for both CFD and DEM.
constant/couplingProperties/asxWriteProps/purgeWrite will overrule the setting in controlDict for DEM restart files only.

Different / independent settings for purgeWrite on CFD and DEM side are allowed.

Restrictions