openfoam/applications/utilities/surface
Andrew Heather d8d6030ab6 INT: Integration of Mattijs' collocated parallel IO additions
Original commit message:
------------------------

Parallel IO: New collated file format

When an OpenFOAM simulation runs in parallel, the data for decomposed fields and
mesh(es) has historically been stored in multiple files within separate
directories for each processor.  Processor directories are named 'processorN',
where N is the processor number.

This commit introduces an alternative "collated" file format where the data for
each decomposed field (and mesh) is collated into a single file, which is
written and read on the master processor.  The files are stored in a single
directory named 'processors'.

The new format produces significantly fewer files - one per field, instead of N
per field.  For large parallel cases, this avoids the restriction on the number
of open files imposed by the operating system limits.

The file writing can be threaded allowing the simulation to continue running
while the data is being written to file.  NFS (Network File System) is not
needed when using the the collated format and additionally, there is an option
to run without NFS with the original uncollated approach, known as
"masterUncollated".

The controls for the file handling are in the OptimisationSwitches of
etc/controlDict:

OptimisationSwitches
{
    ...

    //- Parallel IO file handler
    //  uncollated (default), collated or masterUncollated
    fileHandler uncollated;

    //- collated: thread buffer size for queued file writes.
    //  If set to 0 or not sufficient for the file size threading is not used.
    //  Default: 2e9
    maxThreadFileBufferSize 2e9;

    //- masterUncollated: non-blocking buffer size.
    //  If the file exceeds this buffer size scheduled transfer is used.
    //  Default: 2e9
    maxMasterFileBufferSize 2e9;
}

When using the collated file handling, memory is allocated for the data in the
thread.  maxThreadFileBufferSize sets the maximum size of memory in bytes that
is allocated.  If the data exceeds this size, the write does not use threading.

When using the masterUncollated file handling, non-blocking MPI communication
requires a sufficiently large memory buffer on the master node.
maxMasterFileBufferSize sets the maximum size in bytes of the buffer.  If the
data exceeds this size, the system uses scheduled communication.

The installation defaults for the fileHandler choice, maxThreadFileBufferSize
and maxMasterFileBufferSize (set in etc/controlDict) can be over-ridden within
the case controlDict file, like other parameters.  Additionally the fileHandler
can be set by:
- the "-fileHandler" command line argument;
- a FOAM_FILEHANDLER environment variable.

A foamFormatConvert utility allows users to convert files between the collated
and uncollated formats, e.g.
    mpirun -np 2 foamFormatConvert -parallel -fileHandler uncollated

An example case demonstrating the file handling methods is provided in:
$FOAM_TUTORIALS/IO/fileHandling

The work was undertaken by Mattijs Janssens, in collaboration with Henry Weller.
2017-07-07 11:39:56 +01:00
..
surfaceAdd ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
surfaceBooleanFeatures ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
surfaceCheck ENH: relocate triSurface classes into surfMesh library (issue #294) 2017-05-18 10:42:05 +02:00
surfaceClean ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
surfaceCoarsen ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
surfaceConvert ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
surfaceFeatureConvert Integrated Foundation code to commit 104aac5 2017-05-17 16:35:18 +01:00
surfaceFeatureExtract ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
surfaceFind surfaceFind: output region/zone number of found face 2017-06-02 21:02:01 +01:00
surfaceHookUp INT: Integration of Mattijs' collocated parallel IO additions 2017-07-07 11:39:56 +01:00
surfaceInertia ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
surfaceInflate ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
surfaceLambdaMuSmooth Integrated Foundation code to commit 104aac5 2017-05-17 16:35:18 +01:00
surfaceMeshConvert Merge remote-tracking branch 'origin/decomposeParDict' into develop 2016-11-19 15:34:36 +01:00
surfaceMeshExport GIT: Initial state after latest Foundation merge 2016-09-20 14:49:08 +01:00
surfaceMeshImport STYLE: minor adjustments to doxygen comments 2016-10-04 09:16:08 +02:00
surfaceMeshInfo ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
surfaceMeshTriangulate INT: Integration of Mattijs' collocated parallel IO additions 2017-07-07 11:39:56 +01:00
surfaceOrient ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
surfacePatch STYLE: use auto and cfind to simplify selector usage (issue #512) 2017-07-03 10:36:03 +02:00
surfacePointMerge ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
surfaceRedistributePar ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
surfaceRefineRedGreen ENH: relocate triSurface classes into surfMesh library (issue #294) 2017-05-18 10:42:05 +02:00
surfaceSplitByPatch ENH: relocate triSurface classes into surfMesh library (issue #294) 2017-05-18 10:42:05 +02:00
surfaceSplitByTopology ENH: relocate triSurface classes into surfMesh library (issue #294) 2017-05-18 10:42:05 +02:00
surfaceSplitNonManifolds ENH: improved handling of 'unresolved' surface intersections (issue #450) 2017-05-08 14:57:47 +02:00
surfaceSubset ENH: relocate triSurface classes into surfMesh library (issue #294) 2017-05-18 10:42:05 +02:00
surfaceToPatch ENH: relocate triSurface classes into surfMesh library (issue #294) 2017-05-18 10:42:05 +02:00
surfaceTransformPoints ENH: add input surface scaling (issue #514) 2017-08-14 09:18:15 +02:00
README Enhance edgeMesh to support more formats. 2009-12-11 16:29:55 +01:00

2008-10-23

Contents:

surfaceAdd
- adds to surface files. (but does not intersect or anything)

surfaceBooleanOp
- Boolean operations (add, or, xor) on closed surfaces. Probably not working.

surfaceCheck
- checks surface for incorrect topology. Checks normals of neighbouring faces.

surfaceCoarsen
- Stan Melax coarsening algorithm

surfaceConvert
- Converts surfaces to/from various formats

surfaceFind
- Finds nearest vertex and face to given point.

surfaceMeshTriangulate
- Triangulate external faces of mesh and write as surface.

surfacePointMerge
- Explicit point merge of surface.

surfaceSetOutside
- Orient normals on (closed) surface.

surfaceSmooth
- Laplacian smoothing on surface vertices

surfaceSubset
- Subsets surface

surfaceToPatch
- Applies region information of surfaces to mesh.
  Each external face of mesh gets region number of nearest surface triangle.

-------------------------------------------------------------------------------

surfaceMeshConvert
- Similar to surfaceConvert, but uses surfMesh library