Dispersion

Dispersion(dispersivity, pore_diffusion)

Handles dispersion and diffusion terms in the transport equation.

This class computes hydrodynamic dispersion coefficients combining mechanical dispersion and pore diffusion effects.

Parameters

Name	Type	Description	Default
dispersivity	jax.Array	Longitudinal dispersivity, either scalar or per cell.	required
pore_diffusion	AbstractSpecies	Pore diffusion coefficient for each species.	required

Methods

Name	Description
build	Build a Dispersion instance and validate dispersivity shape.
get_dispersion_coefficient	Compute dispersion coefficients for each species.
rate	Compute the dispersion contribution to the species rate of change.

build

Dispersion.build(cells, dispersivity, pore_diffusion)

Build a Dispersion instance and validate dispersivity shape.

Parameters

Name	Type	Description	Default
cells	Cells	Spatial discretization of the domain.	required
dispersivity	jax.Array	Longitudinal dispersivity, either scalar or per cell.	required
pore_diffusion	AbstractSpecies	Pore diffusion coefficient for each species.	required

Returns

Name	Type	Description
	Dispersion	Configured dispersion scheme.

Raises

Name	Type	Description
	ValueError	If dispersivity does not match the number of cells.

get_dispersion_coefficient

Dispersion.get_dispersion_coefficient(time, system)

Compute dispersion coefficients for each species.

Parameters

Name	Type	Description	Default
time	jax.Array	Current simulation time.	required
system	System	The reactive transport system.	required

Returns

Name	Type	Description
	AbstractSpecies	Dispersion coefficients for each species.

rate

Dispersion.rate(time, state, system)

Compute the dispersion contribution to the species rate of change.

Parameters

Name	Type	Description	Default
time	jax.Array	Current simulation time.	required
state	AbstractSpecies	Current species concentrations.	required
system	System	The reactive transport system.	required

Returns

Name	Type	Description
	AbstractSpecies	Dispersion contribution to the rate of change.