recon1d_plm_hybgen module reference

Piecewise Linear Method 1D reconstruction ported from “hybgen” module in Hycom.

Data Types

plm_hybgen

PLM reconstruction following "hybgen".

Functions/Subroutines

`init()`	Initialize a 1D PLM reconstruction for n cells.
`reconstruct()`	Calculate a 1D PLM reconstructions based on h(:) and u(:)
`f()`	Value of PLM_hybgen reconstruction at a point in cell k [A].
`dfdx()`	Derivative of PLM_hybgen reconstruction at a point in cell k [A].
`average()`	Average between xa and xb for cell k of a 1D PLM reconstruction [A].
`destroy()`	Deallocate the PLM reconstruction.
`check_reconstruction()`	Checks the PLM_hybgen reconstruction for consistency.
`unit_tests()`	Runs PLM reconstruction unit tests and returns True for any fails, False otherwise.

Detailed Description

This implementation of PLM follows Colella and Woodward, 1984, with cells resorting to PCM for extrema including first and last cells in column. The cell-wise reconstructions are limited so that the edge values (which are also the extrema in a cell) are bounded by the neighbors. The limiter yields monotonicity for the CFL<1 transport problem where parts of a cell can only move to a neighboring cell, but does not yield monotonic profiles for the general remapping problem. The first and last cells are always limited to PCM.

The mom_hybgen_remap.hybgen_plm_coefs() function calculates PLM coefficients numerically equiavalent to the function calculates PLM coefficients numerically equiavalent to the recon1d_plm_hybgen() module (this implementation). module (this implementation).

Type Documentation

type recon1d_plm_hybgen/plm_hybgen

PLM reconstruction following “hybgen”.

Type fields:

% ul :: real, dimension(:), allocatable, private Left edge value [A].
% ur :: real, dimension(:), allocatable, private Right edge value [A].
% slp :: real, dimension(:), allocatable, private Right minus left edge values [A].
% init :: procedure, private Implementation of the PLM_hybgen initialization.
% reconstruct :: procedure, private Implementation of the PLM_hybgen reconstruction.
% average :: procedure, private Implementation of the PLM_hybgen average over an interval [A].
% f :: procedure, private Implementation of evaluating the PLM_hybgen reconstruction at a point [A].
% dfdx :: procedure, private Implementation of the derivative of the PLM_hybgen reconstruction at a point [A].
% destroy :: procedure, private Implementation of deallocation for PLM_hybgen.
% check_reconstruction :: procedure, private Implementation of check reconstruction for the PLM_hybgen reconstruction.
% unit_tests :: procedure, private Implementation of unit tests for the PLM_hybgen reconstruction.
% init_parent :: procedure, private Duplicate interface to
% reconstruct_parent :: procedure, private Duplicate interface to

[source]

Function/Subroutine Documentation

subroutine recon1d_plm_hybgen/init(this, n, h_neglect, check)

Initialize a 1D PLM reconstruction for n cells.

Parameters:

this :: this [out] This reconstruction
n :: n [in] Number of cells in this column
h_neglect :: h_neglect [in] A negligibly small width used in cell reconstructions [H]
check :: check [in] If true, enable some consistency checking