Change symmetry line name (#100)

Change the keyword for reflection from "symmetry" to ":symmetry"
trixi-framework · Jun 21, 2024 · 9e110ff · 9e110ff
1 parent d28931e
commit 9e110ff
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/Benchmarks/ControlFiles/PacMan.control b/Benchmarks/ControlFiles/PacMan.control
@@ -44,7 +44,7 @@
  zEqn = z(t) = 0.0
  \end{PARAMETRIC_EQUATION_CURVE}
  \begin{END_POINTS_LINE}
- name = symmetry
+ name = :symmetry
  xStart = [-1.0,0.3,0.0]
  xEnd = [0.0,0.0,0.0]
  \end{END_POINTS_LINE}

diff --git a/Benchmarks/TestGeneratorControlFiles/PacMan.control b/Benchmarks/TestGeneratorControlFiles/PacMan.control
@@ -44,7 +44,7 @@
  zEqn = z(t) = 0.0
  \end{PARAMETRIC_EQUATION_CURVE}
  \begin{END_POINTS_LINE}
- name = symmetry
+ name = :symmetry
  xStart = [-1.0,0.3,0.0]
  xEnd = [0.0,0.0,0.0]
  \end{END_POINTS_LINE}

diff --git a/Documentation/docs/the-model.md b/Documentation/docs/the-model.md
@@ -18,7 +18,7 @@ As an example, the model in Fig. 16 has one outer boundary - the outer triangle
 ![B&M](https://user-images.githubusercontent.com/25242486/241190479-ba50d797-3bd9-41b1-bc38-03fc86f8c3da.png)
 <p align = "center"> Fig. 17. Mesh with interior interfaces bounded by circles.</p>
 
-The mesh generator generates unstructured meshes, and there is no reason in general why a mesh must be symmetric if the model is symmetric. Since symmetry can be a desirable feature, HOHQMesh allows one to define a symmetry boundary about which the mesh will be symmetric by setting boundary names as "symmetry". The symmetry boundary must be a straight line (no matter how that is defined, see below) and multiple symmetry boundaries must be co-linear. What HOHQMesh does is take a model and mesh it. Then, if one or more of the outer boundary curves are named "symmetry", that mesh will be reflected about the symmetry line and the result will be a perfectly symmetric mesh. An example is shown in Fig. 18.
+The mesh generator generates unstructured meshes, and there is no reason in general why a mesh must be symmetric if the model is symmetric. Since symmetry can be a desirable feature, HOHQMesh allows one to define a symmetry boundary about which the mesh will be symmetric by setting boundary names as ":symmetry" (with a colon, so as not to interfere with some other use of the name). The symmetry boundary must be a straight line (no matter how that is defined, see below) and multiple symmetry boundaries must be co-linear. What HOHQMesh does is take a model and mesh it. Then, if one or more of the outer boundary curves are named ":symmetry", that mesh will be reflected about the symmetry line and the result will be a perfectly symmetric mesh. An example is shown in Fig. 18. If the curve designated as ":symmetry" is not straight, or if any of multiple lines so designated are not co-linear, then an error is poseted and the mesh will not be reflected.
 
 ![NotREFL](https://github.com/trixi-framework/HOHQMesh/assets/25242486/5e145806-1acb-43c4-b712-ea6eeb703c64)
 <p align = "center"> Fig. 18. A mesh (left) reflected about the red boundary line (right).</p>

diff --git a/Examples/2D/PacMan/PacMan.control b/Examples/2D/PacMan/PacMan.control
@@ -43,7 +43,7 @@
  zEqn = z(t) = 0.0
  \end{PARAMETRIC_EQUATION_CURVE}
  \begin{END_POINTS_LINE}
- name = symmetry
+ name = :symmetry
  xStart = [-1.0,0.3,0.0]
  xEnd = [0.0,0.0,0.0]
  \end{END_POINTS_LINE}

diff --git a/Source/Curves/ContinuousCurves/SMCurveClass.f90 b/Source/Curves/ContinuousCurves/SMCurveClass.f90
@@ -40,7 +40,7 @@ Module SMCurveClass
 ! ---------
 !
  INTEGER, PARAMETER :: SM_CURVE_NAME_LENGTH = 32
- CHARACTER(LEN=SM_CURVE_NAME_LENGTH), PARAMETER :: SYMMETRY_CURVE_NAME = "symmetry"
+ CHARACTER(LEN=SM_CURVE_NAME_LENGTH), PARAMETER :: SYMMETRY_CURVE_NAME = ":symmetry"
 !
 ! ---------------------
 ! Base class definition