Merge pull request #5417 from MFraters/add_cpo_user_warnings

Add warning that CPO plugin in still a work in progress.
geodynamics · Oct 8, 2023 · 397849d · 397849d
2 parents 63a0b51 + 5479b39
commit 397849d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/source/particle/property/crystal_preferred_orientation.cc b/source/particle/property/crystal_preferred_orientation.cc
@@ -1252,6 +1252,8 @@ namespace aspect
     {
       ASPECT_REGISTER_PARTICLE_PROPERTY(CrystalPreferredOrientation,
                                         "crystal preferred orientation",
+                                        "WARNING: all the CPO plugins are a work in progress and not ready for production use yet. "
+                                        "See https://github.com/geodynamics/aspect/issues/3885 for current status and alternatives. "
                                         "The plugin manages and computes the evolution of Lattice/Crystal Preferred Orientations (LPO/CPO) "
                                         "on particles. Each ASPECT particle can be assigned many grains. Each grain is assigned a size and a orientation "
                                         "matrix. This allows for CPO evolution tracking with polycrystalline kinematic CrystalPreferredOrientation evolution models such "