utvdschememodule::utvdschemetype Interface Reference

Total Variation Diminishing (TVD) interpolation scheme. More...

Inheritance diagram for utvdschememodule::utvdschemetype:

Collaboration diagram for utvdschememodule::utvdschemetype:

Private Member Functions
procedure	compute
procedure	set_field
final	destructor
procedure, private	limiter
procedure, private	compute_node_distance
type(utvdschemetype) function	constructor (dis, fmi, gradient)

Private Attributes
class(disbasetype), pointer	dis
type(tspfmitype), pointer	fmi
class(igradienttype), pointer	gradient
real(dp), dimension(:), pointer	phi
type(localcellextrematype), allocatable	min_max_phi
integer(i4b)	limiter_id = 2
real(dp), dimension(:, :), allocatable	cached_node_distance

Detailed Description

This class implements a high-resolution, TVD interpolation scheme for use in transport modeling. It extends a generic interpolation scheme interface and supports multiple TVD limiters (van Leer, Koren, Superbee, van Albada, etc.) for controlling numerical diffusion and oscillations. The default limiter is van Leer, but others can be selected by changing the limiter_id member.

The scheme uses a combination of low-order upwind and high-order limited terms to compute face concentrations. The high-order term is constructed using a gradient-based virtual node value, following the approach described by Darwish et al. An additional TVD clamp is applied to the virtual node value to enforce TVD compliance, especially on grids where the original method may not guarantee monotonicity.

• Supports both structured and unstructured grids via polymorphic discretization and gradient objects.
• The limiter can be selected via the limiter_id member (default is van Leer).
• The method find_local_extrema finds the minimum and maximum values among the current cell and its neighbors, which is used to enforce the TVD condition.
• The compute method calculates the face coefficients for the transport equation.

Definition at line 37 of file UTVDScheme.f90.

Member Function/Subroutine Documentation

compute()

procedure utvdschememodule::utvdschemetype::compute

private

Definition at line 48 of file UTVDScheme.f90.

compute_node_distance()

procedure, private utvdschememodule::utvdschemetype::compute_node_distance

private

Definition at line 53 of file UTVDScheme.f90.

Here is the call graph for this function:

constructor()

type(utvdschemetype) function utvdschememodule::utvdschemetype::constructor ( class(disbasetype), intent(in), pointer  dis, type(tspfmitype), intent(in), pointer  fmi, class(igradienttype), intent(in), allocatable, target  gradient  )

private

Definition at line 62 of file UTVDScheme.f90.

    ! -- return
    type(UTVDSchemeType) :: interpolation_scheme
    ! -- dummy
    class(DisBaseType), pointer, intent(in) :: dis
    type(TspFmiType), pointer, intent(in) :: fmi
    class(IGradientType), allocatable, intent(in), target :: gradient
 
    interpolation_scheme%dis => dis
    interpolation_scheme%fmi => fmi
 
    interpolation_scheme%gradient => gradient
    interpolation_scheme%min_max_phi = localcellextrematype(dis)
 
    allocate (interpolation_scheme%cached_node_distance(dis%njas, 3))
    call compute_node_distance(interpolation_scheme)
 

Here is the call graph for this function:

destructor()

final utvdschememodule::utvdschemetype::destructor

finalprivate

Definition at line 50 of file UTVDScheme.f90.

Here is the call graph for this function:

limiter()

procedure, private utvdschememodule::utvdschemetype::limiter

private

Definition at line 52 of file UTVDScheme.f90.

set_field()

procedure utvdschememodule::utvdschemetype::set_field

private

Definition at line 49 of file UTVDScheme.f90.

Member Data Documentation

cached_node_distance

real(dp), dimension(:, :), allocatable utvdschememodule::utvdschemetype::cached_node_distance

private

Definition at line 46 of file UTVDScheme.f90.

    real(DP), dimension(:, :), allocatable :: cached_node_distance ! distance vectors

dis

class(disbasetype), pointer utvdschememodule::utvdschemetype::dis

private

Definition at line 39 of file UTVDScheme.f90.

    class(DisBaseType), pointer :: dis

fmi

type(tspfmitype), pointer utvdschememodule::utvdschemetype::fmi

private

Definition at line 40 of file UTVDScheme.f90.

    type(TspFmiType), pointer :: fmi

gradient

class(igradienttype), pointer utvdschememodule::utvdschemetype::gradient

private

Definition at line 41 of file UTVDScheme.f90.

    class(IGradientType), pointer :: gradient

limiter_id

integer(i4b) utvdschememodule::utvdschemetype::limiter_id = 2

private

Definition at line 45 of file UTVDScheme.f90.

    integer(I4B) :: limiter_id = 2 ! default to van Leer limiter

min_max_phi

type(localcellextrematype), allocatable utvdschememodule::utvdschemetype::min_max_phi

private

Definition at line 44 of file UTVDScheme.f90.

    type(LocalCellExtremaType), allocatable :: min_max_phi ! local minimum values at nodes

phi

real(dp), dimension(:), pointer utvdschememodule::utvdschemetype::phi

private

Definition at line 43 of file UTVDScheme.f90.

    real(DP), dimension(:), pointer :: phi

---

The documentation for this interface was generated from the following file:

• /home/runner/work/modflow6/modflow6/src/Model/TransportModel/InterpolationScheme/UTVDScheme.f90