Files
CFDEMcoupling-PUBLIC/doc/liggghtsCommandModel_readLiggghtsData.html
2016-05-18 11:38:55 +02:00

94 lines
2.1 KiB
HTML

<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>liggghtsCommandModel_readLiggghtsData command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in liggghtsCommmands dictionary.
</P>
<PRE>liggghtsCommandModels
(
readLiggghtsData
);
readLiggghtsDataProps0
{
startIndex "scalar1";
verbose ;
exactTiming ;
filePath
(
"word"
);
runFirst "bool1";
runEveryCouplingStep "bool2";
startTime "scalar2";
endTime "scalar3";
timeInterval "scalar4";
}
</PRE>
<UL><LI><I>scalar1</I> = start index of data file to be read
<LI><I>verbose</I> = (default off) flag for verbose run
<LI><I>exactTiming</I> = flag indicating that start time should be kept even during a coupling interval
<LI><I>filePath</I> = path to LIGGGHTS data file. Each word in a new line, numbers and symbols need special treatment (e.g. $couplingInterval will be replaced by correct coupling interval in the simulation)
<LI><I>bool1</I> = true if to be run at first timestep only (prio 1)
<LI><I>bool2</I> = true if to be run at every coupling step (prio 2)
<LI><I>scalar2</I> = if bool2 and bool3 false then starts at scalar2 (prio 3) run
<LI><I>scalar3</I> = if bool2 and bool3 false then it ends at scalar3 (prio 3) run
<LI><I>scalar4</I> = if bool2 and bool3 false then it repeats at scalar3 increasing the data file index (prio 3) run
</UL>
<P><B>Examples:</B>
</P>
<PRE>liggghtsCommandModels
(
readLiggghtsData
);
readLiggghtsDataProps0
{
startIndex 0;
exactTiming true;
filePath
(
dotdot
slash
DEM
slash
packing.data
);
runFirst off;
runEveryCouplingStep off;
startTime 0.002;
endTime 0.012;
timeInterval 0.001;
}
</PRE>
<P><B>Description:</B>
</P>
<P>The readLiggghtsData liggghtsCommand Model can be used to read liggghts data files into liggghts during runtime of a coupled simulation.
</P>
<P><B>Restrictions:</B>
</P>
<P>Note: Model is not up to date.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "liggghtsCommandModel.html">liggghtsCommandModel</A>
</P>
</HTML>