Files
CFDEMcoupling-PFM/doc/forceModel_fieldTimeAverage.txt
2018-07-26 13:04:30 +02:00

71 lines
1.3 KiB
Plaintext

"CFDEMproject Website"_lws - "Main Page"_main :c
:link(lws,http://www.cfdem.com)
:link(main,CFDEMcoupling_Manual.html)
:line
forceModel fieldTimeAverage command :h3
[Syntax:]
Defined in couplingProperties dictionary.
forceModels
(
fieldTimeAverage
);
fieldTimeAverageProps
\{
startTime time;
scalarFieldNames
(
"scalarField"
);
vectorFieldNames
(
"vectorField"
);
\} :pre
{time} = (optional) time to start temporal averaging :ulb,l
{scalarField} = names of the finite volume scalar fields to be temporally averaged :l
{vectorField} = names of the finite volume vector fields to be temporally averaged :l
:ule
[Examples:]
forceModels
(
fieldTimeAverage
);
fieldTimeAverageProps
\{
startTime 1.0;
scalarFieldNames
(
"voidfraction"
);
vectorFieldNames
(
"Us"
);
\} :pre
[Description:]
This "force model" does not influence the particles or the simulation - it is a
post-processing tool! Starting at start time the specified fields are temporally
averaged and written at "writeTime". They can then be probed using standard
function object probes. The output name is timeAverage_scalarField, where
scalarField is the name of the original field.
[Restrictions:]
none
[Related commands:]
"forceModel"_forceModel.html