Lower-level functions used by the main scattering routines. More...

Collaboration diagram for Internal Scattering Helpers:

Macros
#define	__FUNCT__ "InterpolateFieldFromCornerToCenter_Vector"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "InterpolateFieldFromCornerToCenter_Scalar"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "TestCornerToCenterInterpolation"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "InterpolateFieldFromCenterToCorner_Vector"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "InterpolateFieldFromCenterToCorner_Scalar"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "InterpolateEulerFieldToSwarm"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "InterpolateAllFieldsToSwarm"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "GetScatterTargetInfo"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "GetPersistentLocalVector"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "AccumulateParticleField"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "NormalizeGridVectorByCount"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "ScatterParticleFieldToEulerField_Internal"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "ScatterParticleFieldToEulerField"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "ScatterAllParticleFieldsToEulerFields"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "InterpolateCornerToFaceCenter_Scalar"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

#define	__FUNCT__ "InterpolateCornerToFaceCenter_Vector"
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

Functions
PetscErrorCode	AccumulateParticleField (DM swarm, const char *particleFieldName, DM gridSumDM, Vec gridSumVec)
	Accumulates a particle field (scalar or vector) into a target grid sum vector.

PetscErrorCode	NormalizeGridVectorByCount (DM countDM, Vec countVec, DM dataDM, Vec sumVec, Vec avgVec)
	Normalizes a grid vector of sums by a grid vector of counts to produce an average.

PetscErrorCode	GetScatterTargetInfo (UserCtx user, const char particleFieldName, DM targetDM, PetscInt expected_dof)
	Determines the target Eulerian DM and expected DOF for scattering a given particle field.

PetscErrorCode	GetPersistentLocalVector (UserCtx user, const char fieldName, Vec *localVec)
	Retrieves the persistent local vector (e.g., lPsi, lUcat) for a given field name.

static PetscErrorCode	ScatterParticleFieldToEulerField_Internal (UserCtx user, const char particleFieldName, DM targetDM, PetscInt expected_dof, Vec eulerFieldAverageVec)
	Internal helper function to orchestrate the scatter operation (accumulate + normalize).

Detailed Description

Lower-level functions used by the main scattering routines.

Macro Definition Documentation

◆ FUNCT [1/16]

#define __FUNCT__ "InterpolateFieldFromCornerToCenter_Vector"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [2/16]

#define __FUNCT__ "InterpolateFieldFromCornerToCenter_Scalar"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [3/16]

#define __FUNCT__ "TestCornerToCenterInterpolation"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [4/16]

#define __FUNCT__ "InterpolateFieldFromCenterToCorner_Vector"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [5/16]

#define __FUNCT__ "InterpolateFieldFromCenterToCorner_Scalar"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [6/16]

#define __FUNCT__ "InterpolateEulerFieldToSwarm"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [7/16]

#define __FUNCT__ "InterpolateAllFieldsToSwarm"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [8/16]

#define __FUNCT__ "GetScatterTargetInfo"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [9/16]

#define __FUNCT__ "GetPersistentLocalVector"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [10/16]

#define __FUNCT__ "AccumulateParticleField"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [11/16]

#define __FUNCT__ "NormalizeGridVectorByCount"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [12/16]

#define __FUNCT__ "ScatterParticleFieldToEulerField_Internal"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [13/16]

#define __FUNCT__ "ScatterParticleFieldToEulerField"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [14/16]

#define __FUNCT__ "ScatterAllParticleFieldsToEulerFields"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [15/16]

#define __FUNCT__ "InterpolateCornerToFaceCenter_Scalar"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

◆ FUNCT [16/16]

#define __FUNCT__ "InterpolateCornerToFaceCenter_Vector"

Accumulates a particle field (scalar or vector) into a target grid sum vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF of `gridSumDM`).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist, DMs are incompatible, or memory access fails.

Definition at line 20 of file interpolation.c.

Function Documentation

◆ AccumulateParticleField()

PetscErrorCode AccumulateParticleField	(	DM	swarm,
		const char *	particleFieldName,
		DM	gridSumDM,
		Vec	localAccumulatorVec
	)

Accumulates a particle field (scalar or vector) into a target grid sum vector.

Accumulates particle field values into a ghosted Local Vector.

This function iterates through local particles, identifies their cell using the "DMSwarm_CellID" field, and adds the particle's field value (particleFieldName) to the corresponding cell location in the gridSumVec. It handles both scalar (DOF=1) and vector (DOF=3) fields automatically based on the DOF of gridSumDM.

IMPORTANT: The caller must ensure gridSumVec is zeroed before calling this function if a fresh sum calculation is desired.

Parameters

[in]	swarm	The DMSwarm containing particles.
[in]	particleFieldName	Name of the field on the particles (must match DOF).
[in]	gridSumDM	The DMDA associated with `gridSumVec`. Its DOF determines how many components are accumulated.
[in,out]	gridSumVec	The Vec (associated with `gridSumDM`) to accumulate sums into.

Returns: PetscErrorCode 0 on success. Errors if fields don't exist or DMs are incompatible.

This function iterates over local particles and sums their specified field property into the provided grid vector. It supports both scalar (DOF=1) and vector (DOF=3) fields.

CRITICAL USAGE NOTES:

localAccumulatorVec MUST be a Local Vector (obtained via DMGetLocalVector or DMCreateLocalVector). It must have memory allocated for ghost slots. Passing a Global Vector will trigger an error.
The vector is NOT zeroed internally. The caller must zero it if fresh accumulation is desired.
This function performs pure accumulation. It does NOT communicate ghost values to owners. The caller is responsible for calling DMLocalToGlobalBegin/End afterwards.

Parameters

[in]	swarm	The DMSwarm object containing the particles.
[in]	particleFieldName	The name of the particle field to accumulate (e.g., "Psi", "Ucat").
[in]	gridSumDM	The DMDA defining the grid topology.
[in,out]	localAccumulatorVec	The ghosted local vector to accumulate into.

Returns: PetscErrorCode 0 on success.

Definition at line 1538 of file interpolation.c.

{
    PetscErrorCode    ierr;
    PetscInt          dof;
    PetscInt          nlocal, p;
    const PetscReal   *particle_arr = NULL;
    const PetscInt    *cell_id_arr = NULL;
    
    // DMDA Accessors
    PetscScalar       ***arr_1d = NULL;      // For scalar fields
    PetscScalar       ****arr_3d = NULL;     // For vector fields
    
    // Ghosted dimension variables
    PetscInt          gxs, gys, gzs, gxm, gym, gzm;
    PetscMPIInt       rank;
    char              msg[ERROR_MSG_BUFFER_SIZE];
 
    PetscFunctionBeginUser;
    PROFILE_FUNCTION_BEGIN;
 
    ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank); CHKERRQ(ierr);
 
    // --- 1. Validation & Setup ---
    if (!swarm || !gridSumDM || !localAccumulatorVec) 
        SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "Null input in AccumulateParticleField.");
 
    // Get DMDA information
    ierr = DMDAGetInfo(gridSumDM, NULL, NULL, NULL, NULL, NULL, NULL, NULL, &dof, NULL, NULL, NULL, NULL, NULL); CHKERRQ(ierr);
    // Get Ghosted Corners (Global indices of the ghosted patch start, and its dimensions)
    ierr = DMDAGetGhostCorners(gridSumDM, &gxs, &gys, &gzs, &gxm, &gym, &gzm); CHKERRQ(ierr);
 
    // --- 2. Verify Vector Type (Global vs Local) ---
    {
        PetscInt vecSize;
        PetscInt expectedLocalSize = gxm * gym * gzm * dof;
        ierr = VecGetSize(localAccumulatorVec, &vecSize); CHKERRQ(ierr);
        
        if (vecSize != expectedLocalSize) {
            PetscSNPrintf(msg, sizeof(msg), 
                "Vector dimension mismatch! Expected Ghosted Local Vector size %d (gxm*gym*gzm*dof), got %d. "
                "Did you pass a Global Vector instead of a Local Vector?", 
                expectedLocalSize, vecSize);
            SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, msg);
        }
    }
 
    // --- 3. Acquire Particle Data ---
    ierr = DMSwarmGetLocalSize(swarm, &nlocal); CHKERRQ(ierr);
    // These calls will fail nicely if the field doesn't exist
    ierr = DMSwarmGetField(swarm, particleFieldName, NULL, NULL, (void **)&particle_arr); CHKERRQ(ierr);
    ierr = DMSwarmGetField(swarm, "DMSwarm_CellID", NULL, NULL, (void **)&cell_id_arr); CHKERRQ(ierr);
 
    // --- 4. Acquire Grid Accessors ---
    // DMDAVecGetArray* handles the mapping from Global (i,j,k) to the underlying Local Array index
    if (dof == 1) {
        ierr = DMDAVecGetArray(gridSumDM, localAccumulatorVec, &arr_1d); CHKERRQ(ierr);
    } else if (dof == 3) {
        ierr = DMDAVecGetArrayDOF(gridSumDM, localAccumulatorVec, &arr_3d); CHKERRQ(ierr);
    } else {
         PetscSNPrintf(msg, sizeof(msg), "Unsupported DOF=%d. AccumulateParticleField supports DOF 1 or 3.", dof);
         SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, msg);
    }
 
    // --- 5. Accumulate Loop ---
    // Iterate through all local particles
    for (p = 0; p < nlocal; ++p) {
        // Retrieve Geometric Grid Index (0-based)
        PetscInt i_geom = cell_id_arr[p * 3 + 0];
        PetscInt j_geom = cell_id_arr[p * 3 + 1];
        PetscInt k_geom = cell_id_arr[p * 3 + 2];
 
        // Apply Shift (+1) to match Memory Layout (Index 0 is boundary/ghost)
        PetscInt i = i_geom + 1;
        PetscInt j = j_geom + 1;
        PetscInt k = k_geom + 1;
 
        // Bounds Check: Ensure (i,j,k) falls within the Local Ghosted Patch.
        // This allows writing to ghost slots which will later be reduced to the owner rank.
        if (i >= gxs && i < gxs + gxm && 
            j >= gys && j < gys + gym && 
            k >= gzs && k < gzs + gzm)
        {
            if (dof == 1) {
                arr_1d[k][j][i] += particle_arr[p];
            } else {
                // For DOF=3, unroll the loop for slight optimization
                arr_3d[k][j][i][0] += particle_arr[p * 3 + 0];
                arr_3d[k][j][i][1] += particle_arr[p * 3 + 1];
                arr_3d[k][j][i][2] += particle_arr[p * 3 + 2];
            }
        } 
        // Note: Particles outside the ghost layer are skipped. This is expected behavior
        // if particles have not yet been migrated or localized correctly.
    }
 
    // --- 6. Restore Arrays and Fields ---
    if (dof == 1) {
        ierr = DMDAVecRestoreArray(gridSumDM, localAccumulatorVec, &arr_1d); CHKERRQ(ierr);
    } else {
        ierr = DMDAVecRestoreArrayDOF(gridSumDM, localAccumulatorVec, &arr_3d); CHKERRQ(ierr);
    }
    
    ierr = DMSwarmRestoreField(swarm, particleFieldName, NULL, NULL, (void **)&particle_arr); CHKERRQ(ierr);
    ierr = DMSwarmRestoreField(swarm, "DMSwarm_CellID", NULL, NULL, (void **)&cell_id_arr); CHKERRQ(ierr);
 
    PROFILE_FUNCTION_END;
    PetscFunctionReturn(0);
}

Here is the caller graph for this function:

◆ NormalizeGridVectorByCount()

PetscErrorCode NormalizeGridVectorByCount	(	DM	countDM,
		Vec	countVec,
		DM	dataDM,
		Vec	sumVec,
		Vec	avgVec
	)

Normalizes a grid vector of sums by a grid vector of counts to produce an average.

Calculates avgVec[i] = sumVec[i] / countVec[i] for each component of each OWNED cell where countVec[i] > 0. Sets avgVec[i] = 0 otherwise. Handles both scalar (DOF=1) and vector (DOF=3) data fields based on dataDM. Uses basic VecGetArray/VecGetArrayRead and manual index calculation.

Parameters

[in]	countDM	The DMDA associated with `countVec` (must have DOF=1).
[in]	countVec	The Vec containing particle counts per cell (read-only).
[in]	dataDM	The DMDA associated with `sumVec` and `avgVec` (must have DOF=1 or DOF=3).
[in]	sumVec	The Vec containing the accumulated sums per cell (read-only).
[in,out]	avgVec	The Vec where the calculated averages will be stored (overwritten).

Returns: PetscErrorCode 0 on success.

Calculates avgVec[i] = sumVec[i] / countVec[i] for each component of each cell owned by the current process, provided countVec[i] > 0. Otherwise, sets avgVec[i] = 0. Handles both scalar (DOF=1) and vector (DOF=3) data fields based on the DOF of dataDM. Uses DMDA multi-dimensional array accessors (DMDAVecGetArray...) for safe and convenient indexing.

Parameters

[in]	countDM	The DMDA associated with `countVec` (must have DOF=1).
[in]	countVec	The Vec containing particle counts per cell (read-only).
[in]	dataDM	The DMDA associated with `sumVec` and `avgVec` (must have DOF=1 or DOF=3).
[in]	sumVec	The Vec containing the accumulated sums per cell (read-only).
[in,out]	avgVec	The Vec where the calculated averages will be stored (overwritten). Must be associated with `dataDM`.

Returns: PetscErrorCode 0 on success. Errors on incompatible DMs or memory access failure.

Definition at line 1795 of file interpolation.c.

{
    PetscErrorCode ierr;
    PetscInt       data_dof;
    PetscInt       count_dof;
    PetscMPIInt    rank;
    char           msg[ERROR_MSG_BUFFER_SIZE];
 
    // Pointers for DMDA array accessors - declare specific types
    PetscScalar    ***count_arr_3d = NULL;      // For DOF=1 count vector (3D DMDA)
    PetscScalar    ***sum_arr_scalar = NULL;    // For DOF=1 sum vector (3D DMDA)
    PetscScalar    ***avg_arr_scalar = NULL;    // For DOF=1 avg vector (3D DMDA)
    PetscScalar    ****sum_arr_vector = NULL;   // For DOF=3 sum vector (3D DMDA + DOF)
    PetscScalar    ****avg_arr_vector = NULL;   // For DOF=3 avg vector (3D DMDA + DOF)
 
 
    PetscFunctionBeginUser;
 
    PROFILE_FUNCTION_BEGIN;
 
    ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank); CHKERRQ(ierr);
 
    // --- Validation ---
    ierr = DMDAGetInfo(countDM, NULL, NULL, NULL, NULL, NULL, NULL, NULL, &count_dof, NULL, NULL, NULL, NULL, NULL); CHKERRQ(ierr);
    ierr = DMDAGetInfo(dataDM, NULL, NULL, NULL, NULL, NULL, NULL, NULL, &data_dof, NULL, NULL, NULL, NULL, NULL); CHKERRQ(ierr);
    if (count_dof != 1) { PetscSNPrintf(msg, sizeof(msg), "countDM must have DOF=1, got %d.", count_dof); SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, msg); }
    if (data_dof != 1 && data_dof != 3) { PetscSNPrintf(msg, sizeof(msg), "dataDM DOF must be 1 or 3, got %d.", data_dof); SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, msg); }
 
    // --- Get Array Access using appropriate DMDA accessors ---
    ierr = DMDAVecGetArrayRead(countDM, countVec, &count_arr_3d); CHKERRQ(ierr);
 
    if (data_dof == 1) {
        ierr = DMDAVecGetArrayRead(dataDM, sumVec, &sum_arr_scalar); CHKERRQ(ierr);
        ierr = DMDAVecGetArray(dataDM, avgVec, &avg_arr_scalar); CHKERRQ(ierr);
    } else { // data_dof == 3
        ierr = DMDAVecGetArrayDOFRead(dataDM, sumVec, &sum_arr_vector); CHKERRQ(ierr);
        ierr = DMDAVecGetArrayDOF(dataDM, avgVec, &avg_arr_vector); CHKERRQ(ierr);
    }
 
    // Get the corners (global start indices) and dimensions of the *local owned* region
    PetscInt xs, ys, zs, xm, ym, zm;
    ierr = DMDAGetCorners(countDM, &xs, &ys, &zs, &xm, &ym, &zm); CHKERRQ(ierr);
 
    // --- Normalize Over Owned Cells ---
    LOG_ALLOW(LOCAL, LOG_DEBUG, "(Rank %d): Normalizing DOF=%d data over owned range [%d:%d, %d:%d, %d:%d].\n",
              rank, data_dof, xs, xs+xm, ys, ys+ym, zs, zs+zm);
 
    // Loop using GLOBAL indices (i, j, k) over the range owned by this process
    for (PetscInt k = zs; k < zs + zm; ++k) {
        for (PetscInt j = ys; j < ys + ym; ++j) {
            for (PetscInt i = xs; i < xs + xm; ++i) {
 
                // Access the count using standard 3D indexing
                PetscScalar count = count_arr_3d[k][j][i];
 
                if (PetscRealPart(count) > 0.5) { // Use tolerance for float comparison
                    if (data_dof == 1) {
                        // Access scalar sum/avg using standard 3D indexing
                        avg_arr_scalar[k][j][i] = sum_arr_scalar[k][j][i] / count;
                    } else { // data_dof == 3
                        // Access vector components using DOF indexing on the last dimension
                        for (PetscInt c = 0; c < data_dof; ++c) {
                            avg_arr_vector[k][j][i][c] = sum_arr_vector[k][j][i][c] / count;
                        }
                    }
                } else { // count is zero or negative
                    // Set average to zero
                    if (data_dof == 1) {
                        avg_arr_scalar[k][j][i] = 0.0;
                    } else { // data_dof == 3
                        for (PetscInt c = 0; c < data_dof; ++c) {
                            avg_arr_vector[k][j][i][c] = 0.0;
                        }
                    }
                } // end if count > 0.5
            } // end i loop
        } // end j loop
    } // end k loop
 
    // --- Restore Arrays using appropriate functions ---
    ierr = DMDAVecRestoreArrayRead(countDM, countVec, &count_arr_3d); CHKERRQ(ierr);
    if (data_dof == 1) {
        ierr = DMDAVecRestoreArrayRead(dataDM, sumVec, &sum_arr_scalar); CHKERRQ(ierr);
        ierr = DMDAVecRestoreArray(dataDM, avgVec, &avg_arr_scalar); CHKERRQ(ierr);
    } else { // data_dof == 3
        ierr = DMDAVecRestoreArrayDOFRead(dataDM, sumVec, &sum_arr_vector); CHKERRQ(ierr);
        ierr = DMDAVecRestoreArrayDOF(dataDM, avgVec, &avg_arr_vector); CHKERRQ(ierr);
    }
 
    // --- Assemble Final Average Vector ---
    LOG_ALLOW(GLOBAL, LOG_DEBUG, "Assembling final average vector (DOF=%d).\n", data_dof);
    ierr = VecAssemblyBegin(avgVec); CHKERRQ(ierr);
    ierr = VecAssemblyEnd(avgVec); CHKERRQ(ierr);
 
 
    PROFILE_FUNCTION_END;
 
    PetscFunctionReturn(0);
}

Here is the caller graph for this function:

◆ GetScatterTargetInfo()

PetscErrorCode GetScatterTargetInfo	(	UserCtx *	user,
		const char *	particleFieldName,
		DM *	targetDM,
		PetscInt *	expected_dof
	)

Determines the target Eulerian DM and expected DOF for scattering a given particle field.

Based on hardcoded rules mapping particle field names ("P", "Nvert", "Ucat", "Ucont") to user context DMs (user->da or user->fda). This function encapsulates the policy of where different fields should be scattered. Modify this function to add rules for custom fields.

Parameters

[in]	user	Pointer to the UserCtx containing required DMs (`da`, `fda`).
[in]	particleFieldName	Name of the particle field.
[out]	targetDM	Pointer to store the determined target DM (`user->da` or `user->fda`).
[out]	expected_dof	Pointer to store the expected DOF (1 or 3) for this field.

Returns

PetscErrorCode Returns 0 on success. Error codes:

PETSC_ERR_ARG_NULL if required inputs are NULL.
PETSC_ERR_ARG_WRONG if particleFieldName is not recognized.

Definition at line 1426 of file interpolation.c.

{
    char           msg[ERROR_MSG_BUFFER_SIZE]; // Buffer for formatted error messages
    PetscFunctionBeginUser;
 
    PROFILE_FUNCTION_BEGIN;
 
    // --- Input Validation ---
    // Check for NULL pointers in essential inputs
    if (!user) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "UserCtx pointer is NULL.");
    if (!user->da) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "UserCtx->da is NULL.");
    if (!user->fda) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "UserCtx->fda is NULL."); // Needed for vector fields
    if (!particleFieldName) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "particleFieldName is NULL.");
    if (!targetDM) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "Output targetDM pointer is NULL.");
    if (!expected_dof) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "Output expected_dof pointer is NULL.");
 
    // --- Determine Target DM and DOF based on Field Name ---
    // Compare the input field name with known scalar fields targeting 'da'
    if (strcmp(particleFieldName, "Psi") == 0 || strcmp(particleFieldName, "Nvert") == 0) {
        *expected_dof = 1;      // Scalar fields have DOF 1
        *targetDM = user->da;   // Target the primary scalar DMDA
        LOG_ALLOW(GLOBAL, LOG_DEBUG, "Field '%s' targets DM 'da' (DOF=1).\n", particleFieldName);
    }
    // Compare with known vector fields targeting 'fda'
    else if (strcmp(particleFieldName, "Ucat") == 0 || strcmp(particleFieldName, "Ucont") == 0) {
        *expected_dof = 3;      // Vector fields have DOF 3
        *targetDM = user->fda;  // Target the vector DMDA (often node-based)
        LOG_ALLOW(GLOBAL, LOG_DEBUG, "Field '%s' targets DM 'fda' (DOF=3).\n", particleFieldName);
    }
    // --- Add rules for other fields here ---
    // else if (strcmp(particleFieldName, "SomeOtherScalar") == 0) { *expected_dof = 1; *targetDM = user->da; }
    // else if (strcmp(particleFieldName, "SomeOtherVector") == 0) { *expected_dof = 3; *targetDM = user->someOtherDM; }
    else {
        // The provided field name doesn't match any known rules
        *targetDM = NULL; // Indicate failure
        *expected_dof = 0;
        // Format the error message manually
        PetscSNPrintf(msg, sizeof(msg), "Field name '%s' is not recognized for automatic DM selection.", particleFieldName);
        // Use SETERRQ with the formatted message and appropriate error code
        SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, msg); // Use WRONG argument error code
    }
 
    PROFILE_FUNCTION_END;
 
    PetscFunctionReturn(0);
}

Here is the caller graph for this function:

◆ GetPersistentLocalVector()

PetscErrorCode GetPersistentLocalVector	(	UserCtx *	user,
		const char *	fieldName,
		Vec *	localVec
	)

Retrieves the persistent local vector (e.g., lPsi, lUcat) for a given field name.

Parameters

user	User context containing the persistent vectors.
fieldName	Name of the field ("Psi", "Ucat", etc.).
localVec	Output pointer to the vector.

Returns: PetscErrorCode

Definition at line 1484 of file interpolation.c.

{
    PetscFunctionBeginUser;
    
    if (!user || !fieldName || !localVec) 
        SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "Null input in GetPersistentLocalVector");
 
    if (strcmp(fieldName, "Psi") == 0) {
        if (!user->lPsi) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "user->lPsi is not initialized");
        *localVec = user->lPsi;
    }
    else if (strcmp(fieldName, "Ucat") == 0) {
        if (!user->lUcat) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "user->lUcat is not initialized");
        *localVec = user->lUcat;
    }
    else if (strcmp(fieldName, "Ucont") == 0) {
        if (!user->lUcont) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "user->lUcont is not initialized");
        *localVec = user->lUcont;
    }
    else if (strcmp(fieldName, "Nvert") == 0) {
        if (!user->lNvert) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "user->lNvert is not initialized");
        *localVec = user->lNvert;
    }
    else {
        char msg[ERROR_MSG_BUFFER_SIZE];
        PetscSNPrintf(msg, sizeof(msg), "Field '%s' does not have a mapped persistent local vector.", fieldName);
        SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, msg);
    }
 
    PetscFunctionReturn(0);
}

◆ ScatterParticleFieldToEulerField_Internal()

static PetscErrorCode ScatterParticleFieldToEulerField_Internal	(	UserCtx *	user,
		const char *	particleFieldName,
		DM	targetDM,
		PetscInt	expected_dof,
		Vec	eulerFieldAverageVec
	)

static

Internal helper function to orchestrate the scatter operation (accumulate + normalize).

Manages the temporary sum vector and calls the accumulation and normalization functions. Assumes caller determined target DM and DOF. Checks for particle field existence. NOTE: If DMSwarmGetField fails, the subsequent SETERRQ will overwrite the original error.

Parameters

[in]	user	Pointer to UserCtx containing swarm, ParticleCount, da.
[in]	particleFieldName	Name of the field in the DMSwarm.
[in]	targetDM	The DMDA where the final average and intermediate sum reside.
[in]	expected_dof	The expected DOF (1 or 3) for the targetDM and field.
[in,out]	eulerFieldAverageVec	The pre-created Vec associated with targetDM to store the result.

Returns: PetscErrorCode 0 on success. Errors if particle field doesn't exist or underlying helpers fail.

Definition at line 1924 of file interpolation.c.

{
    PetscErrorCode ierr;
    Vec            globalsumVec = NULL;
    Vec            localsumVec = NULL;
    char           msg[ERROR_MSG_BUFFER_SIZE]; // Buffer for formatted error messages
 
    PetscFunctionBeginUser;
 
    PROFILE_FUNCTION_BEGIN;
 
    if (!user || !user->swarm || !user->ParticleCount || !particleFieldName || !targetDM || !eulerFieldAverageVec)
        SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "NULL input provided to ScatterParticleFieldToEulerField_Internal.");
    
    // --- Check if Particle Field Exists ---
    // Attempt a GetField call; if it fails, the field doesn't exist.
    // We let CHKERRQ handle the error directly if the field doesn't exist OR
    // we catch it specifically to provide a more tailored message.
 
    /*
    LOG_ALLOW(GLOBAL,LOG_DEBUG,"Field %s being accessed to check existence \n",particleFieldName);
    ierr = DMSwarmGetField(user->swarm, particleFieldName, NULL, NULL, NULL);
    if (ierr) { // If GetField returns an error
        PetscSNPrintf(msg, sizeof(msg), "Particle field '%s' not found in DMSwarm for scattering.", particleFieldName);
        // Directly set the error, overwriting the one from GetField
        SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, msg);
    }
    ierr = DMSwarmRestoreField(user->swarm, particleFieldName, NULL, NULL, NULL);
    */
    
    // --- Setup Temporary Sum Vector ---
    ierr = VecDuplicate(eulerFieldAverageVec, &globalsumVec); CHKERRQ(ierr);
    ierr = VecSet(globalsumVec, 0.0); CHKERRQ(ierr);
    ierr = PetscSNPrintf(msg, sizeof(msg), "TempSum_%s", particleFieldName); CHKERRQ(ierr);
    ierr = PetscObjectSetName((PetscObject)globalsumVec, msg); CHKERRQ(ierr);
 
    // create local vector for accumulation
    ierr = DMGetLocalVector(targetDM, &localsumVec); CHKERRQ(ierr);
    ierr = VecSet(localsumVec, 0.0); CHKERRQ(ierr);  // Must be zeroed before accumulation
    ierr = PetscSNPrintf(msg, sizeof(msg), "LocalTempSum_%s", particleFieldName); CHKERRQ(ierr);
    ierr = PetscObjectSetName((PetscObject)localsumVec, msg); CHKERRQ(ierr);
 
    // --- Accumulate ---
    // This will call DMSwarmGetField again. If it failed above, it will likely fail here too,
    // unless the error was cleared somehow between the check and here (unlikely).
    // If the check above was skipped (Option 1), this is where the error for non-existent
    // field will be caught by CHKERRQ.
    ierr = AccumulateParticleField(user->swarm, particleFieldName, targetDM, localsumVec); CHKERRQ(ierr);
 
    // --- Local to Global Sum ---
    ierr = DMLocalToGlobalBegin(targetDM, localsumVec, ADD_VALUES, globalsumVec); CHKERRQ(ierr);
    ierr = DMLocalToGlobalEnd(targetDM, localsumVec, ADD_VALUES, globalsumVec); CHKERRQ(ierr);
    // Return local vector to DM
    ierr = DMRestoreLocalVector(targetDM, &localsumVec); CHKERRQ(ierr);
 
    // Calculate the number of particles per cell.
    ierr = CalculateParticleCountPerCell(user); CHKERRQ(ierr);
    // --- Normalize ---
    ierr = NormalizeGridVectorByCount(user->da, user->ParticleCount, targetDM, globalsumVec, eulerFieldAverageVec); CHKERRQ(ierr);
 
    // --- Cleanup ---
    ierr = VecDestroy(&globalsumVec); CHKERRQ(ierr);
 
 
    PROFILE_FUNCTION_END;
 
    PetscFunctionReturn(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ __FUNCT__ [1/16]

◆ __FUNCT__ [2/16]

◆ __FUNCT__ [3/16]

◆ __FUNCT__ [4/16]

◆ __FUNCT__ [5/16]

◆ __FUNCT__ [6/16]

◆ __FUNCT__ [7/16]

◆ __FUNCT__ [8/16]

◆ __FUNCT__ [9/16]

◆ __FUNCT__ [10/16]

◆ __FUNCT__ [11/16]

◆ __FUNCT__ [12/16]

◆ __FUNCT__ [13/16]

◆ __FUNCT__ [14/16]

◆ __FUNCT__ [15/16]

◆ __FUNCT__ [16/16]

Function Documentation

◆ AccumulateParticleField()

◆ NormalizeGridVectorByCount()

◆ GetScatterTargetInfo()

◆ GetPersistentLocalVector()

◆ ScatterParticleFieldToEulerField_Internal()

◆ FUNCT [1/16]

◆ FUNCT [2/16]

◆ FUNCT [3/16]

◆ FUNCT [4/16]

◆ FUNCT [5/16]

◆ FUNCT [6/16]

◆ FUNCT [7/16]

◆ FUNCT [8/16]

◆ FUNCT [9/16]

◆ FUNCT [10/16]

◆ FUNCT [11/16]

◆ FUNCT [12/16]

◆ FUNCT [13/16]

◆ FUNCT [14/16]

◆ FUNCT [15/16]

◆ FUNCT [16/16]