test_statistics_target.c File Reference

C unit tests for pointwise spatial target resolution. More...

#include "test_support.h"
#include "statistics_target.h"
#include "setup.h"

Include dependency graph for test_statistics_target.c:

Go to the source code of this file.

Macros
#define	TARGET_TEST_N   6 /* fixture size; DMDA is TARGET_TEST_N + 1 per dimension */
#define	TARGET_CELL_EXTENT   5 /* cell-like span: indices [1, 6) */
#define	TARGET_NODE_EXTENT   6 /* node-like nonperiodic span: indices [0, 6) */

Functions
static PetscErrorCode	PlanCount (UserCtx *user, FieldId field_id, PetscInt *count)
	Builds a plan and returns its global point count.
static PetscErrorCode	TestCellCenteredExcludesBoundaryAndDummy (void)
	Cell-centered fields must exclude the dummy slot and the extra high slot.
static PetscErrorCode	TestFaceLayoutsAreNodeLikeInOwnDirection (void)
	Each face family is node-like in exactly its own direction.
static PetscErrorCode	TestPeriodicDirectionsDropDuplicatePlane (void)
	Periodic directions must drop the wrapped duplicate plane.
static PetscErrorCode	TestComponentStaggeredRejected (void)
	Component-staggered fields cannot share one pointwise domain and are rejected.
static PetscErrorCode	TestFluidMaskThreshold (void)
	The fluid mask admits fluid cells and rejects blanked ones at the documented threshold.
static PetscErrorCode	TestCellSpanAgreesWithOwnedCellRange (void)
	The cell-centered span must agree with the existing owned-cell helper.
int	main (int argc, char **argv)
	Entry point for the spatial target suite.

Detailed Description

C unit tests for pointwise spatial target resolution.

Covers the Stage 2 acceptance items in Field Statistics Phase 2 Implementation Specification section 13: cell, node, and I/J/K-face layouts, and nonperiodic, mixed, and fully periodic domains with no duplicate planes.

The fixture builds a DMDA of size n + 1 per dimension, so with n = 6 each dimension has seven slots: one extra non-physical high-side slot, and under the solver's shifted convention a boundary/dummy slot at index zero.

Definition in file test_statistics_target.c.

Macro Definition Documentation

TARGET_TEST_N

#define TARGET_TEST_N   6 /* fixture size; DMDA is TARGET_TEST_N + 1 per dimension */

Definition at line 20 of file test_statistics_target.c.

TARGET_CELL_EXTENT

#define TARGET_CELL_EXTENT   5 /* cell-like span: indices [1, 6) */

Definition at line 21 of file test_statistics_target.c.

TARGET_NODE_EXTENT

#define TARGET_NODE_EXTENT   6 /* node-like nonperiodic span: indices [0, 6) */

Definition at line 22 of file test_statistics_target.c.

Function Documentation

PlanCount()

static PetscErrorCode PlanCount ( UserCtx *  user, FieldId  field_id, PetscInt *  count  )

static

Builds a plan and returns its global point count.

Definition at line 25 of file test_statistics_target.c.

{
    SpatialTargetPlan plan;
 
    PetscFunctionBeginUser;
    PetscCall(SpatialTargetPlanCreate(user, field_id, PICURV_STATISTICS_MASK_FLUID, &plan));
    PetscCall(SpatialTargetPlanGlobalPointCount(&plan, PETSC_COMM_WORLD, count));
    PetscFunctionReturn(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

TestCellCenteredExcludesBoundaryAndDummy()

static PetscErrorCode TestCellCenteredExcludesBoundaryAndDummy ( void  )

static

Cell-centered fields must exclude the dummy slot and the extra high slot.

Definition at line 36 of file test_statistics_target.c.

{
    SimCtx *simCtx = NULL;
    UserCtx *user = NULL;
    SpatialTargetPlan plan;
    PetscInt local = 0, global = 0;
 
    PetscFunctionBeginUser;
    PetscCall(PicurvCreateMinimalContexts(&simCtx, &user, TARGET_TEST_N, TARGET_TEST_N, TARGET_TEST_N));
 
    PetscCall(SpatialTargetPlanCreate(user, FIELD_ID_P, PICURV_STATISTICS_MASK_FLUID, &plan));
    PetscCall(PicurvAssertIntEqual(PICURV_TARGET_POINTWISE, plan.kind, "plan kind should be pointwise"));
    PetscCall(PicurvAssertIntEqual(FIELD_LAYOUT_CELL_CENTERED, plan.descriptor->layout,
                                   "P should resolve as cell-centered"));
    /* On one rank the owned range spans the block, so the plan is the layout span. */
    if (simCtx->size == 1) {
        for (PetscInt dim = 0; dim < 3; ++dim) {
            PetscCall(PicurvAssertIntEqual(1, plan.start[dim],
                                           "cell-centered span must skip the index-zero dummy slot"));
            PetscCall(PicurvAssertIntEqual(TARGET_TEST_N, plan.end[dim],
                                           "cell-centered span must skip the extra high-side slot"));
        }
    }
    PetscCall(SpatialTargetPlanLocalPointCount(&plan, &local));
    PetscCall(SpatialTargetPlanGlobalPointCount(&plan, PETSC_COMM_WORLD, &global));
    PetscCall(PicurvAssertIntEqual(TARGET_CELL_EXTENT * TARGET_CELL_EXTENT * TARGET_CELL_EXTENT, global,
                                   "cell-centered global point count"));
    PetscCall(PicurvAssertBool((PetscBool)(local <= global), "local count cannot exceed global count"));
 
    /* Vector and scalar cell-centered fields share one domain. */
    PetscCall(PlanCount(user, FIELD_ID_UCAT, &global));
    PetscCall(PicurvAssertIntEqual(TARGET_CELL_EXTENT * TARGET_CELL_EXTENT * TARGET_CELL_EXTENT, global,
                                   "Ucat shares the cell-centered domain regardless of dof"));
 
    PetscCall(PicurvDestroyMinimalContexts(&simCtx, &user));
    PetscFunctionReturn(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

TestFaceLayoutsAreNodeLikeInOwnDirection()

static PetscErrorCode TestFaceLayoutsAreNodeLikeInOwnDirection ( void  )

static

Each face family is node-like in exactly its own direction.

Definition at line 75 of file test_statistics_target.c.

{
    SimCtx *simCtx = NULL;
    UserCtx *user = NULL;
    PetscInt global = 0;
    const PetscInt cell = TARGET_CELL_EXTENT;
    const PetscInt node = TARGET_NODE_EXTENT;
 
    PetscFunctionBeginUser;
    PetscCall(PicurvCreateMinimalContexts(&simCtx, &user, TARGET_TEST_N, TARGET_TEST_N, TARGET_TEST_N));
 
    PetscCall(PlanCount(user, FIELD_ID_CSI, &global));
    PetscCall(PicurvAssertIntEqual(node * cell * cell, global, "I-face domain is node-like in i only"));
    PetscCall(PlanCount(user, FIELD_ID_ETA, &global));
    PetscCall(PicurvAssertIntEqual(cell * node * cell, global, "J-face domain is node-like in j only"));
    PetscCall(PlanCount(user, FIELD_ID_ZET, &global));
    PetscCall(PicurvAssertIntEqual(cell * cell * node, global, "K-face domain is node-like in k only"));
    PetscCall(PlanCount(user, FIELD_ID_COORDINATES, &global));
    PetscCall(PicurvAssertIntEqual(node * node * node, global, "node-centered domain is node-like in all directions"));
 
    PetscCall(PicurvDestroyMinimalContexts(&simCtx, &user));
    PetscFunctionReturn(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

TestPeriodicDirectionsDropDuplicatePlane()

static PetscErrorCode TestPeriodicDirectionsDropDuplicatePlane ( void  )

static

Periodic directions must drop the wrapped duplicate plane.

The periodic repair algorithms write index zero and the final slot from the opposite side, so both are dependent duplicates. A node-like direction therefore loses one entry under periodicity, while a cell-like direction is unchanged because its duplicates were already outside the span.

Definition at line 107 of file test_statistics_target.c.

{
    SimCtx *simCtx = NULL;
    UserCtx *user = NULL;
    PetscInt global = 0;
    const PetscInt cell = TARGET_CELL_EXTENT;
    const PetscInt node = TARGET_NODE_EXTENT;
 
    PetscFunctionBeginUser;
    /* Mixed: periodic in i only. */
    PetscCall(PicurvCreateMinimalContextsWithPeriodicity(&simCtx, &user,
                                                         TARGET_TEST_N, TARGET_TEST_N, TARGET_TEST_N,
                                                         PETSC_TRUE, PETSC_FALSE, PETSC_FALSE));
    PetscCall(PlanCount(user, FIELD_ID_P, &global));
    PetscCall(PicurvAssertIntEqual(cell * cell * cell, global,
                                   "cell-centered count is unchanged by periodicity"));
    PetscCall(PlanCount(user, FIELD_ID_CSI, &global));
    PetscCall(PicurvAssertIntEqual(cell * cell * cell, global,
                                   "I-face loses its duplicate plane when i is periodic"));
    PetscCall(PlanCount(user, FIELD_ID_ETA, &global));
    PetscCall(PicurvAssertIntEqual(cell * node * cell, global,
                                   "J-face keeps its node-like span when only i is periodic"));
    PetscCall(PlanCount(user, FIELD_ID_COORDINATES, &global));
    PetscCall(PicurvAssertIntEqual(cell * node * node, global,
                                   "node-centered loses only the periodic direction"));
    PetscCall(PicurvDestroyMinimalContexts(&simCtx, &user));
 
    /* Fully periodic: every node-like direction collapses to the cell extent. */
    PetscCall(PicurvCreateMinimalContextsWithPeriodicity(&simCtx, &user,
                                                         TARGET_TEST_N, TARGET_TEST_N, TARGET_TEST_N,
                                                         PETSC_TRUE, PETSC_TRUE, PETSC_TRUE));
    PetscCall(PlanCount(user, FIELD_ID_COORDINATES, &global));
    PetscCall(PicurvAssertIntEqual(cell * cell * cell, global,
                                   "fully periodic node-centered domain has no duplicate planes"));
    PetscCall(PlanCount(user, FIELD_ID_CSI, &global));
    PetscCall(PicurvAssertIntEqual(cell * cell * cell, global,
                                   "fully periodic I-face domain has no duplicate planes"));
    PetscCall(PlanCount(user, FIELD_ID_P, &global));
    PetscCall(PicurvAssertIntEqual(cell * cell * cell, global,
                                   "fully periodic cell-centered domain is unchanged"));
    PetscCall(PicurvDestroyMinimalContexts(&simCtx, &user));
    PetscFunctionReturn(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

TestComponentStaggeredRejected()

static PetscErrorCode TestComponentStaggeredRejected ( void  )

static

Component-staggered fields cannot share one pointwise domain and are rejected.

Definition at line 152 of file test_statistics_target.c.

{
    SimCtx *simCtx = NULL;
    UserCtx *user = NULL;
    SpatialTargetPlan plan;
    PetscErrorCode staggered_ierr = 0;
    PetscErrorCode classify_ierr = 0;
    PetscBool node_like = PETSC_FALSE;
 
    PetscFunctionBeginUser;
    PetscCall(PicurvCreateMinimalContexts(&simCtx, &user, TARGET_TEST_N, TARGET_TEST_N, TARGET_TEST_N));
 
    PetscCall(PetscPushErrorHandler(PetscIgnoreErrorHandler, NULL));
    staggered_ierr = SpatialTargetPlanCreate(user, FIELD_ID_UCONT, PICURV_STATISTICS_MASK_FLUID, &plan);
    PetscCall(PetscPopErrorHandler());
    PetscCall(PicurvAssertIntEqual(PETSC_ERR_ARG_WRONGSTATE, staggered_ierr,
                                   "Ucont is component-staggered and must not resolve a pointwise domain"));
 
    PetscCall(PetscPushErrorHandler(PetscIgnoreErrorHandler, NULL));
    classify_ierr = PicurvLayoutDimensionIsNodeLike(FIELD_LAYOUT_COMPONENT_STAGGERED, 0, &node_like);
    PetscCall(PetscPopErrorHandler());
    PetscCall(PicurvAssertIntEqual(PETSC_ERR_ARG_WRONGSTATE, classify_ierr,
                                   "component-staggered layout has no single per-dimension classification"));
 
    PetscCall(PetscPushErrorHandler(PetscIgnoreErrorHandler, NULL));
    classify_ierr = PicurvLayoutDimensionIsNodeLike(FIELD_LAYOUT_CELL_CENTERED, 3, &node_like);
    PetscCall(PetscPopErrorHandler());
    PetscCall(PicurvAssertIntEqual(PETSC_ERR_ARG_OUTOFRANGE, classify_ierr,
                                   "dimension index outside 0..2 must be rejected"));
 
    PetscCall(PicurvDestroyMinimalContexts(&simCtx, &user));
    PetscFunctionReturn(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

TestFluidMaskThreshold()

static PetscErrorCode TestFluidMaskThreshold ( void  )

static

The fluid mask admits fluid cells and rejects blanked ones at the documented threshold.

Definition at line 187 of file test_statistics_target.c.

{
    SimCtx *simCtx = NULL;
    UserCtx *user = NULL;
    SpatialTargetPlan plan;
 
    PetscFunctionBeginUser;
    PetscCall(PicurvCreateMinimalContexts(&simCtx, &user, TARGET_TEST_N, TARGET_TEST_N, TARGET_TEST_N));
    PetscCall(SpatialTargetPlanCreate(user, FIELD_ID_UCAT, PICURV_STATISTICS_MASK_FLUID, &plan));
 
    PetscCall(PicurvAssertBool(SpatialTargetPlanMaskAllows(&plan, 0.0),
                               "open fluid must pass the fluid mask"));
    PetscCall(PicurvAssertBool(SpatialTargetPlanMaskAllows(&plan, 0.05),
                               "values below the threshold must pass the fluid mask"));
    PetscCall(PicurvAssertBool((PetscBool)!SpatialTargetPlanMaskAllows(&plan, 1.0),
                               "solid cells must fail the fluid mask"));
    PetscCall(PicurvAssertBool((PetscBool)!SpatialTargetPlanMaskAllows(&plan, PICURV_STATISTICS_FLUID_THRESHOLD),
                               "the threshold itself is excluded, matching the existing Nvert < 0.1 rule"));
    PetscCall(PicurvAssertBool((PetscBool)!SpatialTargetPlanMaskAllows(NULL, 0.0),
                               "a null plan must not admit points"));
 
    PetscCall(PicurvDestroyMinimalContexts(&simCtx, &user));
    PetscFunctionReturn(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

TestCellSpanAgreesWithOwnedCellRange()

static PetscErrorCode TestCellSpanAgreesWithOwnedCellRange ( void  )

static

The cell-centered span must agree with the existing owned-cell helper.

GetOwnedCellRange reports cells by their origin node index, while field storage uses the solver's shifted convention where the cell with origin j lives at array index j + 1. The two therefore describe the same cells in different index spaces. This pins that relationship so the target plan and the established helper cannot drift apart.

Definition at line 221 of file test_statistics_target.c.

{
    SimCtx *simCtx = NULL;
    UserCtx *user = NULL;
    SpatialTargetPlan plan;
 
    PetscFunctionBeginUser;
    PetscCall(PicurvCreateMinimalContexts(&simCtx, &user, TARGET_TEST_N, TARGET_TEST_N, TARGET_TEST_N));
    PetscCall(SpatialTargetPlanCreate(user, FIELD_ID_P, PICURV_STATISTICS_MASK_FLUID, &plan));
 
    for (PetscInt dim = 0; dim < 3; ++dim) {
        PetscInt origin_start = 0;
        PetscInt origin_count = 0;
 
        PetscCall(GetOwnedCellRange(&user->info, dim, &origin_start, &origin_count));
        /* Shift from origin-node indexing into field-storage indexing. */
        PetscCall(PicurvAssertIntEqual(origin_start + 1, plan.start[dim],
                                       "cell span start must be the owned-cell origin shifted by one"));
        PetscCall(PicurvAssertIntEqual(origin_start + origin_count + 1, plan.end[dim],
                                       "cell span end must be the owned-cell extent shifted by one"));
    }
 
    PetscCall(PicurvDestroyMinimalContexts(&simCtx, &user));
    PetscFunctionReturn(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

main()

int main	(	int	argc,
		char **	argv
	)

Entry point for the spatial target suite.

Definition at line 250 of file test_statistics_target.c.

{
    PetscErrorCode ierr;
    const PicurvTestCase cases[] = {
        {"cell-centered-excludes-boundary-and-dummy", TestCellCenteredExcludesBoundaryAndDummy},
        {"face-layouts-node-like-in-own-direction", TestFaceLayoutsAreNodeLikeInOwnDirection},
        {"periodic-directions-drop-duplicate-plane", TestPeriodicDirectionsDropDuplicatePlane},
        {"component-staggered-rejected", TestComponentStaggeredRejected},
        {"fluid-mask-threshold", TestFluidMaskThreshold},
        {"cell-span-agrees-with-owned-cell-range", TestCellSpanAgreesWithOwnedCellRange},
    };
 
    ierr = PetscInitialize(&argc, &argv, NULL, "PICurv spatial target tests");
    if (ierr) {
        return (int)ierr;
    }
 
    ierr = PicurvRunTests("unit-statistics-target", cases, sizeof(cases) / sizeof(cases[0]));
    if (ierr) {
        PetscFinalize();
        return (int)ierr;
    }
 
    ierr = PetscFinalize();
    return (int)ierr;
}

Here is the call graph for this function: