STYLE: some documentation for sampledSurfaces specification

This commit is contained in:
Mark Olesen
2016-12-14 17:54:23 +01:00
parent 36173b5306
commit e7a4a3a73d

View File

@ -29,6 +29,41 @@ Description
The write() method is used to sample and write files. The write() method is used to sample and write files.
Example of function object specification:
\verbatim
surfaces
{
type surfaces;
libs ("libsampling.so");
// Write at same frequency as fields
writeControl outputTime;
writeInterval 1;
// Fields to be sampled
fields (p U);
// Interpolation scheme to use
interpolationScheme cell;
// Output surface format
surfaceFormat vtk;
formatOptions { }
surfaces
(
f0surf
{
type sampledTriSurfaceMesh;
surface f0surf.obj;
source cells;
keepIds true;
}
);
}
\endverbatim
SourceFiles SourceFiles
sampledSurfaces.C sampledSurfaces.C