From 76d7de4a1a7082bf2c60f1dfc90cf9d4ccfe13d7 Mon Sep 17 00:00:00 2001 From: ljcarlin Date: Fri, 3 Nov 2023 13:21:25 +0100 Subject: [PATCH] Fixed typo, misleading documentation --- src/p4est_geometry.c | 2 +- src/p4est_geometry.h | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/p4est_geometry.c b/src/p4est_geometry.c index 7cb5aaf70..8690934cf 100644 --- a/src/p4est_geometry.c +++ b/src/p4est_geometry.c @@ -623,7 +623,7 @@ p4est_geometry_new_sphere2d (p4est_connectivity_t * conn, double R) builtin = P4EST_ALLOC_ZERO (p4est_geometry_builtin_t, 1); sphere2d = &builtin->p.sphere2d; - sphere2d->type = P4EST_GEOMETRY_BUILTIN_DISK2D; + sphere2d->type = P4EST_GEOMETRY_BUILTIN_SPHERE2D; sphere2d->R = R; builtin->geom.name = "p4est_sphere2d"; diff --git a/src/p4est_geometry.h b/src/p4est_geometry.h index 62e037d97..582eb7717 100644 --- a/src/p4est_geometry.h +++ b/src/p4est_geometry.h @@ -74,9 +74,10 @@ typedef void (*p4est_geometry_destroy_t) (p4est_geometry_t * geom); /** Encapsulates a custom transformation from tree-local coordinates to * user defined physical space. * - * \warning Used in \ref p4est_vtk.h to write global-coordinate meshes. - * In this case *user is assumed to point to a \ref p4est_connectivity. - * In general it can be used however the user likes. + * Used in \ref p4est_vtk.h to write global-coordinate meshes. + * + * Some internal p4est functions assume that *user points to a + * \ref p4est_connectivity. However, in general it can be used as the user wishes. * * This structure can be filled or allocated by the user. * p4est will never change its contents.