openfoam/applications/utilities/surface
Mark Olesen 660f3e5492 ENH: cleanup autoPtr class (issue #639)
Improve alignment of its behaviour with std::unique_ptr

  - element_type typedef
  - release() method - identical to ptr() method
  - get() method to get the pointer without checking and without releasing it.
  - operator*() for dereferencing

Method name changes

  - renamed rawPtr() to get()
  - renamed rawRef() to ref(), removed unused const version.

Removed methods/operators

  - assignment from a raw pointer was deleted (was rarely used).
    Can be convenient, but uncontrolled and potentially unsafe.
    Do allow assignment from a literal nullptr though, since this
    can never leak (and also corresponds to the unique_ptr API).

Additional methods

  - clone() method: forwards to the clone() method of the underlying
    data object with argument forwarding.

  - reset(autoPtr&&) as an alternative to operator=(autoPtr&&)

STYLE: avoid implicit conversion from autoPtr to object type in many places

- existing implementation has the following:

     operator const T&() const { return operator*(); }

  which means that the following code works:

       autoPtr<mapPolyMesh> map = ...;
       updateMesh(*map);    // OK: explicit dereferencing
       updateMesh(map());   // OK: explicit dereferencing
       updateMesh(map);     // OK: implicit dereferencing

  for clarity it may preferable to avoid the implicit dereferencing

- prefer operator* to operator() when deferenced a return value
  so it is clearer that a pointer is involve and not a function call
  etc    Eg,   return *meshPtr_;  vs.  return meshPtr_();
2018-02-26 12:00:00 +01:00
..
surfaceAdd ENH: improve consistency of ListOps and stringListOps 2018-02-21 12:58:00 +01:00
surfaceBooleanFeatures ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceCheck STYLE: consistent use of wordHashSet instead of HashSet<word> 2018-02-22 11:19:47 +01:00
surfaceClean ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceCoarsen ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceConvert ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceFeatureConvert ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceFeatureExtract ENH: added constexpr, noexcept for bool, Switch 2018-03-03 20:32:49 +01:00
surfaceFind ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceHookUp ENH: improve consistency of ListOps and stringListOps 2018-02-21 12:58:00 +01:00
surfaceInertia ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceInflate ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceLambdaMuSmooth ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceMeshConvert ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceMeshExport ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceMeshImport ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceMeshInfo ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceMeshTriangulate ENH: change wordRes to be a List of wordRe instead of a wrapper (issue #259) 2018-02-21 10:05:30 +01:00
surfaceOrient ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfacePatch ENH: cleanup autoPtr class (issue #639) 2018-02-26 12:00:00 +01:00
surfacePointMerge ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceRedistributePar ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceRefineRedGreen STYLE: consistency in using argList::addArgument, argList::addOption 2017-11-22 12:54:28 +01:00
surfaceSplitByPatch STYLE: consistency in using argList::addArgument, argList::addOption 2017-11-22 12:54:28 +01:00
surfaceSplitByTopology STYLE: consistency in using argList::addArgument, argList::addOption 2017-11-22 12:54:28 +01:00
surfaceSplitNonManifolds ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceSubset STYLE: consistency in using argList::addArgument, argList::addOption 2017-11-22 12:54:28 +01:00
surfaceToPatch ENH: simplify method names for reading argList options and arguments 2018-01-08 15:35:18 +01:00
surfaceTransformPoints ENH: change wordRes to be a List of wordRe instead of a wrapper (issue #259) 2018-02-21 10:05:30 +01:00
README

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