Andrew Heather authored 4 years ago and Mark OLESEN committed 3 years ago

Examle usage:

    // Optional axes dictionary
    // Note: axes not visible by default for backwards compatility
    axes
    {
        visible         yes;
        colour          (0 0 0);
        fontColour      (0.7 0.7 0.7);
        fontSize        30;
        lengthFactor    0.2;
    }

- simpler version checks

- compile into mpi-specific target directories for better support of
  different MPI vendors

- use MPI hint from MPI_ARCH_PATH and OSMESA hint from MESA_ARCH_PATH.
  Set internally as env variable to allow further override via a CMake
  variable.

- Require paraview >= 5.6, simpler version checks

- compile into mpi-specific target directories for better support of
  different MPI vendors

- use MPI hint from MPI_ARCH_PATH and OSMESA hint from MESA_ARCH_PATH.
  Set internally as env variable to allow further override via a CMake
  variable.

- adjust linked libraries

- use OSMESA hint from MESA_ARCH_PATH.
  Set internally as env variable to allow further override via a CMake
  variable.

- select all volume fields on startup instead of just T/p/U, which
  was a holdover from when memory was much more limited

- align multiblock names with foamToVTK
  - "patches" -> "boundary"

- pointPatches may or may not have a "value" type.
  Use the patch value field where possible and the internal field
  otherwise. Previously always used the internal field.

- using ENABLE_BY_DEFAULT=ON eliminates much of the declaration cruft

- when enabled, this removes various bits of cutting planes.
  Can re-enable on a case-by-case basis (eg, when dealing with baffles)

ENH: support nColours for colourMap (default: 256)

- can be useful when creating distinct contours

- struck by the old dash bug, but also has some remnants of building
  into the project directory by default. It should be the user
  directory for consistency with other modules.

  This can be overriden with the "-prefix" option.

- now derived CMAKE_INSTALL_PREFIX from FOAM_MODULE_PREFIX since this
  improves consistency between the wmake rules and the cmake ones.

- defaults to user locations

- uses updated cmake/paraview scripts (1912, patch=200506)
  to support a user-specified installation prefix.

  Reworked the wmake Make/{files,options} files to respect the use
  of CMAKE_INSTALL_PREFIX, or default to FOAM_LIBBIN.

  Similarly the CMakeLists files have been updated to add install
  targets that respect the value of CMAKE_INSTALL_PREFIX.

  For building with paraview-5.7 and 5.8 a "staged" install is used
  to retain the expected output directory structure and to silently
  discard the unneeded static libraries.

- building paraview-5.7 and later requires cmake >= 3.10 itself
  but cmake-3.8 appears to work adequately for building dependent
  components

- use VERSION_GREATER_EQUAL instead of GREATER_EQUAL

Note
    For paraview-5.7 (and later?) plugins are built into their own subdirs.
    It also is not possible to suppress creation of static libraries in
    the process.

The current solution is still a bit ugly
  - install into a local "staged" location (within the build directory)
  - use rsync to relocate to the .so files to the plugin directory

- OpenFOAM reader:
     (vtkPVFoam, PVFoamReader_SM)
  => (vtkPVFoamReader, ParaFoamReader)

- blockMesh reader:
     (vtkPVblockMesh, PVblockMeshReader_SM)
  => (vtkPVblockReader, ParaFoamBlockReader)

* provides better correspondence between library and module names

- disable only for old versions

- when using VTK from ParaView sources it can better to tag them as
  such, but simultaneously not mask the ParaView with hardware
  rendering.

  The additional ParaView_MESA_DIR variable allows this.
  The balance of library and path setup is unaffected by this.

STYLE: cleanup of Allwclean, Allwmake

CONFIG: remove local version of cmakeVersionedInstall

- silently deprecate 'startsWith', 'endsWith' methods
  (added in 2016: 2b1436066221), in favour of
  'starts_with', 'ends_with' methods, corresponding to C++20 and
  allowing us to cull then in a few years.

- handle single character versions of starts_with, ends_with.

- add single character version of removeEnd and silently deprecate
  removeTrailing which did the same thing.

- drop the const versions of removeRepeated, removeTrailing.
  Unused and with potential confusion.

STYLE: use shrink_to_fit(), erase()

- similar prefixing as the dependent readers, making it easier to
  identify

- add FOAM_API information as server module version

COMP: provide separate get_pvplugin_api function

- building plugins with paraview-5.7 is quite different

- we don't need the GUI sort order of the values.

- drop plugin support for Qt4 (old paraview)

- handle upcoming changes in VTK version naming in CMake files
  * VTK_MAJOR_VERSION becomes VTK_VERSION_MAJOR etc.

- a top-level cloud::nParcels() virtual, which is overloaded by the
  first level of Cloud inheritance. This permits quick determination of
  cloud sizes, even when retrieved from registry with the base level.
  Eg,
      cloud* cldPtr = mesh.cfindObject<cloud>("myCloud");
      label nParcels = (cldPtr ? cldPtr->nParcels() : 0);

- make writeLagrangianPositions on by default unless explicitly
  disabled in the InfoSwitches.

  Flag output errors (where neither coordinates nor positions are
  written) with Fatal.

- additional IOField helper functions in cloud

STYLE: simplify iterator inheritance

- a leftover from much older VTK versions that had poor handling of
  the scalar bar text.