verification_sources.h File Reference

#include "variables.h"

Include dependency graph for verification_sources.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
PetscBool	VerificationDiffusivityOverrideActive (const SimCtx *simCtx)
	Reports whether a verification-only diffusivity override is active.
PetscErrorCode	ApplyVerificationDiffusivityOverride (UserCtx *user)
	Populates the Eulerian diffusivity field from a verification-only source override.
PetscBool	VerificationScalarOverrideActive (const SimCtx *simCtx)
	Reports whether a verification-only scalar override is active.
PetscErrorCode	ApplyVerificationScalarOverrideToParticles (UserCtx *user)
	Populates the particle Psi field from a verification-only source override.

Function Documentation

VerificationDiffusivityOverrideActive()

PetscBool VerificationDiffusivityOverrideActive

(

const SimCtx *

simCtx

)

Reports whether a verification-only diffusivity override is active.

Parameters

simCtx

Simulation context.

Returns

PETSC_TRUE when a verification diffusivity source override is enabled.

Reports whether a verification-only diffusivity override is active.

See include/verification_sources.h for the public parameter and return contract.

Definition at line 11 of file verification_sources.c.

{
    if (!simCtx) return PETSC_FALSE;
    return simCtx->verificationDiffusivity.enabled;
}

Here is the caller graph for this function:

ApplyVerificationDiffusivityOverride()

PetscErrorCode ApplyVerificationDiffusivityOverride

(

UserCtx *

user

)

Populates the Eulerian diffusivity field from a verification-only source override.

Parameters

[in,out]

user

Block-local context whose Diffusivity vector will be filled.

Returns

PetscErrorCode 0 on success.

Populates the Eulerian diffusivity field from a verification-only source override.

See include/verification_sources.h for the public parameter and return contract.

Definition at line 31 of file verification_sources.c.

{
    PetscErrorCode ierr;
    SimCtx        *simCtx = user->simCtx;
    PetscReal    ***diff_arr = NULL;
    const Cmpnts ***cent = NULL;
    DMDALocalInfo  info = user->info;
    PetscReal      min_gamma = PETSC_MAX_REAL;
 
    PetscFunctionBeginUser;
 
    if (!VerificationDiffusivityOverrideActive(simCtx)) PetscFunctionReturn(0);
 
    ierr = DMDAVecGetArray(user->da, user->Diffusivity, &diff_arr); CHKERRQ(ierr);
    ierr = DMDAVecGetArrayRead(user->fda, user->Cent, &cent); CHKERRQ(ierr);
 
    for (PetscInt k = info.zs; k < info.zs + info.zm; ++k) {
        for (PetscInt j = info.ys; j < info.ys + info.ym; ++j) {
            for (PetscInt i = info.xs; i < info.xs + info.xm; ++i) {
                const PetscReal gamma =
                  simCtx->verificationDiffusivity.gamma0 +
                  simCtx->verificationDiffusivity.slope_x * cent[k][j][i].x;
                diff_arr[k][j][i] = gamma;
                min_gamma = PetscMin(min_gamma, gamma);
            }
        }
    }
 
    ierr = DMDAVecRestoreArrayRead(user->fda, user->Cent, &cent); CHKERRQ(ierr);
    ierr = DMDAVecRestoreArray(user->da, user->Diffusivity, &diff_arr); CHKERRQ(ierr);
 
    {
        PetscReal global_min_gamma = 0.0;
        ierr = MPI_Allreduce(&min_gamma, &global_min_gamma, 1, MPIU_REAL, MPI_MIN, PETSC_COMM_WORLD); CHKERRMPI(ierr);
        if (global_min_gamma <= 0.0) {
            SETERRQ(PETSC_COMM_WORLD, PETSC_ERR_ARG_WRONG,
                    "verification diffusivity override produced non-positive Gamma values (min=%g).",
                    (double)global_min_gamma);
        }
    }
 
    ierr = UpdateLocalGhosts(user, "Diffusivity"); CHKERRQ(ierr);
    LOG_ALLOW(GLOBAL, LOG_DEBUG,
              "Applied verification diffusivity override profile '%s' (gamma0=%g, slope_x=%g).\n",
              simCtx->verificationDiffusivity.profile,
              (double)simCtx->verificationDiffusivity.gamma0,
              (double)simCtx->verificationDiffusivity.slope_x);
 
    PetscFunctionReturn(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

VerificationScalarOverrideActive()

PetscBool VerificationScalarOverrideActive

(

const SimCtx *

simCtx

)

Reports whether a verification-only scalar override is active.

Parameters

simCtx

Simulation context.

Returns

PETSC_TRUE when a verification scalar source override is enabled.

Reports whether a verification-only scalar override is active.

See include/verification_sources.h for the public parameter and return contract.

Definition at line 21 of file verification_sources.c.

{
    if (!simCtx) return PETSC_FALSE;
    return simCtx->verificationScalar.enabled;
}

Here is the caller graph for this function:

ApplyVerificationScalarOverrideToParticles()

PetscErrorCode ApplyVerificationScalarOverrideToParticles

(

UserCtx *

user

)

Populates the particle Psi field from a verification-only source override.

Parameters

[in,out]

user

Block-local context whose particle scalar field will be filled.

Returns

PetscErrorCode 0 on success.

Populates the particle Psi field from a verification-only source override.

See include/verification_sources.h for the public parameter and return contract.

Definition at line 86 of file verification_sources.c.

{
    PetscFunctionBeginUser;
    if (!user) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "UserCtx cannot be NULL.");
    if (!VerificationScalarOverrideActive(user->simCtx)) PetscFunctionReturn(0);
 
    PetscCall(SetAnalyticalScalarFieldOnParticles(user, "Psi"));
    LOG_ALLOW(GLOBAL, LOG_DEBUG,
              "Applied verification scalar override profile '%s' to particle field 'Psi'.\n",
              user->simCtx->verificationScalar.profile);
    PetscFunctionReturn(0);
}

Here is the call graph for this function:

Here is the caller graph for this function: