recon1d_emplm_wa module reference

Extrapolated-Monotonized Piecewise Linear Method 1D reconstruction.

Data Types

emplm_wa

Extraplated Monotonic PLM reconstruction of White and Adcroft, 2008.

Functions/Subroutines

`reconstruct()`	Calculate a 1D PLM reconstruction based on h(:) and u(:)
`plm_extrapolate_slope()`	Returns a PLM slope using h2 extrapolation from a cell to the left, in the same arbitrary units as the input values [A].
`unit_tests()`	Runs PLM reconstruction unit tests and returns True for any fails, False otherwise.

Detailed Description

This extends MPLM_WA, following White and Adcroft, 2008 [87], by extrapolating for the slopes of the first and last cells. This extrapolation is used by White et al., 2009, during grid-generation.

Type Documentation

type recon1d_emplm_wa/emplm_wa

Extraplated Monotonic PLM reconstruction of White and Adcroft, 2008.

Type fields:

% reconstruct :: procedure, private Implementation of the EMPLM_WA reconstruction with boundary extrapolation.
% unit_tests :: procedure, private Implementation of unit tests for the EMPLM_WA reconstruction.

[source]

Function/Subroutine Documentation

subroutine recon1d_emplm_wa/reconstruct(this, h, u)

Calculate a 1D PLM reconstruction based on h(:) and u(:)

Parameters:

this :: this [inout] This reconstruction
h :: h [in] Grid spacing (thickness) [typically H]
u :: u [in] Cell mean values [A]

[source]

function recon1d_emplm_wa/plm_extrapolate_slope(h_l, h_c, h_neglect, u_l, u_c)

Returns a PLM slope using h2 extrapolation from a cell to the left, in the same arbitrary units as the input values [A]. Use the negative to extrapolate from the cell to the right.

Parameters:

h_l :: h_l [in] Thickness of left cell in arbitrary grid thickness units [H]
h_c :: h_c [in] Thickness of center cell in arbitrary grid thickness units [H]
h_neglect :: h_neglect [in] A negligible thickness [H]
u_l :: u_l [in] Value of left cell in arbitrary units [A]
u_c :: u_c [in] Value of center cell in arbitrary units [A]

[source]

function recon1d_emplm_wa/unit_tests(this, verbose, stdout, stderr)

Runs PLM reconstruction unit tests and returns True for any fails, False otherwise.

Parameters:

this :: this [inout] This reconstruction
verbose :: verbose [in] True, if verbose
stdout :: stdout [in] I/O channel for stdout
stderr :: stderr [in] I/O channel for stderr

[source]