GitLab

- need to explicitly include vtkPVConfig.h to get the version macros

- was missing range setting for the colour lookup table

- support .vtp format for geometry, surface, line, cloud.

- use native reader for handling vtk, vtp, obj, stl surface files.
  For other formats, use the MeshedSurface (the surfMesh lib) to
  handle reading and Foam::vtk::Tools::Patch to handle the
  conversion to vtkPolyData. This combination is more memory efficient.

- update tutorial case to include vtp surface geometry

- this allows more use of the runTimePostProcessing functionObject
  that will fail more gracefully if the proper version could not be
  built.

  The dummy functionObject simply emits a message that it is not available.

- partial solution for issue #1091

  This generates file properties that are case-relative,
  Eg,

      plane0
      {
          p
          {
              file "<case>/postProcessing/plane0/1/p_plane0.vtk";
          }
          U
          {
              file "<case>/postProcessing/plane0/1/U_plane0.vtk";
          }
      }

   This allows the case to be moved elsewhere and still find its files.

   This functionality was previously added for vtkCloud, but now also
   applies to streamLine, sampledSets and sampledSurfaces

- makes the intent clearer and avoids the need for additional
  constructor casting. Eg,

      labelList(10, Zero)    vs.  labelList(10, 0)
      scalarField(10, Zero)  vs.  scalarField(10, scalar(0))
      vectorField(10, Zero)  vs.  vectorField(10, vector::zero)

- use cellCentres() instead of volField equivalent for vtk conversion

- make looping variables more consistent

- centralize the transcription of OpenFOAM -> vtk tuples

- removed reliance on ParaView_INCLUDE_DIR variable for conveying the
  major.minor version information when compiling. This can be somewhat
  fragile and also adds variable that is an unnecessary when running
  (only used when compiling).

  Instead use `have_pvplugin_support` function in paraviewFunctions
  wmake script to determine the maj.min from the PV_PLUGIN_PATH
  since we have already defined the output path there with paraview
  maj.min numbering.

  Can now build with paraview from the operating system,
  provided that it has develop headers available.

      ParaView_VERSION=system

  In the etc/config.sh/paraview setup, the maj.min is taken from
  the corresponding `paraview --version` output and used when
  defining the PV_PLUGIN_PATH.

  During the build, the include path taken from `paraview-config`
  for a system installation, from the guess installation root
  of the paraview binary, or ParaView_DIR otherwise.

NB: using a system ParaView for building runTimePostProcessing is unsupported.

- these types of builds appear to have various library resolution issues
  (eg, libexpat not being loaded). Additionally, the build logic does
  not yet cover this type of use case.

CONFIG: add so version to libcatalystFoam

STYLE: add OpenFOAM/include directory in CMakeLists

- eg for foamVersion.H

- was deprecated for removal with VTK 8.1.0
  definitely removed in VTK 8.2.0

- as part of the cleanup of dictionary access methods (c6520033c9c4)
  made the dictionary class single inheritance from IDLList<entry>.

  This eliminates any ambiguities for iterators and allows
  for simple use of range-for looping.

  Eg,
      for (const entry& e : topDict))
      {
          Info<< "entry:" << e.keyword() << " is dict:" << e.isDict() << nl;
      }

   vs

      forAllConstIter(dictionary, topDict, iter))
      {
          Info<< "entry:" << iter().keyword()
              << " is dict:" << iter().isDict() << nl;
      }

- more dictionary-like methods, enforce keyType::LITERAL for all
  lookups to avoid any spurious keyword matching.

- new readEntry, readIfPresent methods

- The get() method replaces the now deprecate lookup() method.

- Deprecate lookupOrFailsafe()
  Failsafe behaviour is now an optional parameter for lookupOrDefault,
  which makes it easier to tailor behaviour at runtime.

- output of the names is now always flatted without line-breaks.
  Thus,

     os << flatOutput(someEnumNames.names()) << nl;
     os << someEnumNames << nl;

  both generate the same output.

- Constructor now uses C-string (const char*) directly instead of
  Foam::word in its initializer_list.

- Remove special enum + initializer_list constructor form since
  it can create unbounded lookup indices.

- Removd old hasEnum, hasName forms that were provided during initial
  transition from NamedEnum.

- Added static_assert on Enum contents to restrict to enum or
  integral values.  Should not likely be using this class to enumerate
  other things since it internally uses an 'int' for its values.

  Changed volumeType accordingly to enumerate on its type (enum),
  not the class itself.

- superseded by the vtkCloud function object, which provides
  significantly more functionality and more versatile output
  (using the vtp format).

Style changes:
    - use lookupObjectRef instead of using const_cast
    - use tmp::New factory

- simplifies usage.
  Support syncPar check on names() to detect inconsistencies.

- simplify readFields, ReadFields and other routines by using these
  new methods.

- what was previously termed 'setLargeCellSubset()' is now simply
  'setCellSubset()' and supports memory efficient interfaces.

  The new parameter ordering avoids ambiguities caused by default
  parameters.

  Old parameter order:

      setLargeCellSubset
      (
          const labelList& region,
          const label currentRegion,
          const label patchID = -1,
          const bool syncCouples = true
      );

  New parameter order:

      setCellSubset
      (
          const label regioni,
          const labelUList& regions,
          const label patchID = -1,
          const bool syncCouples = true
      );

   And without ambiguity:

      setCellSubset
      (
          const labelUList& selectedCells,
          const label patchID = -1,
          const bool syncCouples = true
      );

- support bitSet directly for specifying the selectedCells for
  memory efficiency and ease of use.

- Additional constructors to perform setCellSubset() immediately,
  which simplifies coding.

  For example,

      meshParts.set
      (
          zonei,
          new fvMeshSubset(mesh, selectedCells)
      );

  Or even

      return autoPtr<fvMeshSubset>::New(mesh, selectedCells);

- get<label>, get<scalar> instead of readLabel, readScalar, etc.

- regularise referencing of OpenFOAM env variables, sources etc.

CONFIG: cmake targets are globally unique

- unify CMakeLists naming and align content

- the build is now much more strongly oriented on cmake.

  The wmake wrapper only adds some minor versioning on the build
  and uses a standard CMAKE_INSTALL_PREFIX to define its installation
  location.

  These changes can make it easier for some packagers (eg, spack)
  to manage.

 - LIBRARY_OUTPUT_PATH is removed
 - CMAKE_LIBRARY_OUTPUT_DIRECTORY is used instead of LIBRARY_OUTPUT_PATH
 - CMAKE_INSTALL_PREFIX is used as install destination

- allows restriction of the output patches to specific names and hiding
  others. Allow groups when matching patch names

- forces release of memory for the associated backends

- log which channels are being emitted.
  The printChannels pipeline was redundant anyhow.

- removed fvMesh sub-channels if favour of selector flags.
  To enable/disable portions of the geometry:

      internal    true/false
      boundary    true/false

  This replaces the previous method of sub-channels in which restrictions
  were propagated from the pipeline through.

  Before
  ======
      Function Object:

          input
          {
              fields    (U p);
          }

      Pipeline:
          input = coprocessor.CreateProducer(datadescription, 'input/patches')

  Now
  ===
      Function Object:

          input
          {
              internal  false;
              fields    (U p);
          }

      Pipeline:
          input = coprocessor.CreateProducer(datadescription, 'input')

- allows cmake override of the default output library directory,
  which is normally $FOAM_LIBBIN

ENH: additional debug verbosity

- extra information (in parallel) when debug level > 1, which can help
  when isolating problems.

- if sigFpe is enabled within OpenFOAM, any errors in the Catalyst
  pipeline will potentially kill the entire simulation.

- use the new sigFpe::ignore helper class to manage a local disabling
  of SIGFPE handling.

- can remove directly from the temporary objectRegistry prior to
  converting by field type. Cannot, however, do the same for volFields
  or areaFields since these reside on their respective mesh objects.

- LINK_LIBRARIES are required for proper try_compile

STYLE: report output directory

- ParaView Catalyst with MPI is advisable (especially for larger
  simulations), but not a requirement

BUG: general patch movement was inconsistent

- previously had separate function objects for each category of source
  (finite volume, finite area, lagrangian). This lead to isolation of
  the individual input sources, which highly restricted the flexibility.

- now have a single catalyst function object with an arbitrary number
  of inputs (sources). The catalyst channel name is that of the
  corresponds dictionary name. For volume mesh sources, it is possible
  to address "mesh" and "patches" sub-channels.

  Eg,
      mesh = coprocessor.CreateProducer(datadescription, 'myregion/mesh')

  This restructuring also aims at integration of other OpenFOAM content
  (eg, surfMesh, sampled probes, sampled surfaces) as a future
  development.

- the output directory (by default "<case>/insitu") is passed onto
  catalyst as its working directory, using the upstream patches that
  now close issue #4

- reflects current change being made to the vtkCPProcessor API to
  include chdir capabilities.

- prevents accidental overwrite of runtime conversions.

- uses the cellCellStencil information to blank holes and the
  interpolated cells.

- needs more detailed attention for handling cases when three or more
  meshes are overlapping.