d03pvf calculates a numerical flux function using Osher's Approximate Riemann Solver for the Euler equations in conservative form. It is designed primarily for use with the upwind discretization schemes d03pff,d03plford03psf, but may also be applicable to other conservative upwind schemes requiring numerical flux functions.
The routine may be called by the names d03pvf or nagf_pde_dim1_parab_euler_osher.
3Description
d03pvf calculates a numerical flux function at a single spatial point using Osher's Approximate Riemann Solver (see Hemker and Spekreijse (1986) and Pennington and Berzins (1994)) for the Euler equations (for a perfect gas) in conservative form. You must supply the left and right solution values at the point where the numerical flux is required, i.e., the initial left and right states of the Riemann problem defined below. In the routines d03pff,d03plfandd03psf, the left and right solution values are derived automatically from the solution values at adjacent spatial points and supplied to the subroutine argument numflx from which you may call d03pvf.
The Euler equations for a perfect gas in conservative form are:
where $\rho $ is the density, $m$ is the momentum, $e$ is the specific total energy, and $\gamma $ is the (constant) ratio of specific heats. The pressure $p$ is given by
The routine calculates the Osher approximation to the numerical flux function $F({U}_{L},{U}_{R})=F\left({U}^{*}({U}_{L},{U}_{R})\right)$, where $U={U}_{L}$ and $U={U}_{R}$ are the left and right solution values, and ${U}^{*}({U}_{L},{U}_{R})$ is the intermediate state $\omega \left(0\right)$ arising from the similarity solution $U(y,t)=\omega (y/t)$ of the Riemann problem defined by
with $U$ and $F$ as in (2), and initial piecewise constant values $U={U}_{L}$ for $y<0$ and $U={U}_{R}$ for $y>0$. The spatial domain is $-\infty <y<\infty $, where $y=0$ is the point at which the numerical flux is required. Osher's solver carries out an integration along a path in the phase space of $U$ consisting of subpaths which are piecewise parallel to the eigenvectors of the Jacobian of the PDE system. There are two variants of the Osher solver termed O (original) and P (physical), which differ in the order in which the subpaths are taken. The P-variant is generally more efficient, but in some rare cases may fail (see Hemker and Spekreijse (1986) for details). The argument path specifies which variant is to be used. The algorithm for Osher's solver for the Euler equations is given in detail in the Appendix of Pennington and Berzins (1994).
4References
Hemker P W and Spekreijse S P (1986) Multiple grid and Osher's scheme for the efficient solution of the steady Euler equations Applied Numerical Mathematics2 475–493
Pennington S V and Berzins M (1994) New NAG Library software for first-order partial differential equations ACM Trans. Math. Softw.20 63–99
Quirk J J (1994) A contribution to the great Riemann solver debate Internat. J. Numer. Methods Fluids18 555–574
5Arguments
1: $\mathbf{uleft}\left(3\right)$ – Real (Kind=nag_wp) arrayInput
On entry: ${\mathbf{uleft}}\left(\mathit{i}\right)$ must contain the left value of the component ${U}_{\mathit{i}}$, for $\mathit{i}=1,2,3$. That is, ${\mathbf{uleft}}\left(1\right)$ must contain the left value of $\rho $, ${\mathbf{uleft}}\left(2\right)$ must contain the left value of $m$ and ${\mathbf{uleft}}\left(3\right)$ must contain the left value of $e$.
Constraints:
${\mathbf{uleft}}\left(1\right)\ge 0.0$;
Left pressure, $\mathit{pl}\ge 0.0$, where $\mathit{pl}$ is calculated using (3).
2: $\mathbf{uright}\left(3\right)$ – Real (Kind=nag_wp) arrayInput
On entry: ${\mathbf{uright}}\left(\mathit{i}\right)$ must contain the right value of the component ${U}_{\mathit{i}}$, for $\mathit{i}=1,2,3$. That is, ${\mathbf{uright}}\left(1\right)$ must contain the right value of $\rho $, ${\mathbf{uright}}\left(2\right)$ must contain the right value of $m$ and ${\mathbf{uright}}\left(3\right)$ must contain the right value of $e$.
Constraints:
${\mathbf{uright}}\left(1\right)\ge 0.0$;
Right pressure, $\mathit{pr}\ge 0.0$, where $\mathit{pr}$ is calculated using (3).
3: $\mathbf{gamma}$ – Real (Kind=nag_wp)Input
On entry: the ratio of specific heats, $\gamma $.
Constraint:
${\mathbf{gamma}}>0.0$.
4: $\mathbf{path}$ – Character(1)Input
On entry: the variant of the Osher scheme.
${\mathbf{path}}=\text{'O'}$
Original.
${\mathbf{path}}=\text{'P'}$
Physical.
Constraint:
${\mathbf{path}}=\text{'O'}$ or $\text{'P'}$.
5: $\mathbf{flux}\left(3\right)$ – Real (Kind=nag_wp) arrayOutput
On exit: ${\mathbf{flux}}\left(\mathit{i}\right)$ contains the numerical flux component ${\hat{F}}_{\mathit{i}}$, for $\mathit{i}=1,2,3$.
6: $\mathbf{ifail}$ – IntegerInput/Output
On entry: ifail must be set to $0$, $\mathrm{-1}$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $\mathrm{-1}$ means that an error message is printed while a value of $1$ means that it is not.
If halting is not appropriate, the value $\mathrm{-1}$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).
Note: if the left and/or right values of $\rho $ or $p$ (from (3)) are found to be negative, then the routine will terminate with an error exit (${\mathbf{ifail}}={\mathbf{2}}$). If the routine is being called from the numflx etc., then a soft fail option (${\mathbf{ifail}}={\mathbf{1}}$ or $\mathrm{-1}$) is recommended so that a recalculation of the current time step can be forced using the numflx argument ires (see d03pfford03plf).
6Error Indicators and Warnings
If on entry ${\mathbf{ifail}}=0$ or $\mathrm{-1}$, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
${\mathbf{ifail}}=1$
On entry, ${\mathbf{gamma}}=\u27e8\mathit{\text{value}}\u27e9$.
Constraint: ${\mathbf{gamma}}>0.0$.
On entry, ${\mathbf{path}}=\u27e8\mathit{\text{value}}\u27e9$.
Constraint: ${\mathbf{path}}=\text{'O'}$ or $\text{'P'}$.
${\mathbf{ifail}}=2$
Left pressure value $\mathit{pl}<0.0$: $\mathit{pl}=\u27e8\mathit{\text{value}}\u27e9$.
On entry, ${\mathbf{uleft}}\left(1\right)=\u27e8\mathit{\text{value}}\u27e9$.
Constraint: ${\mathbf{uleft}}\left(1\right)\ge 0.0$.
On entry, ${\mathbf{uright}}\left(1\right)=\u27e8\mathit{\text{value}}\u27e9$.
Constraint: ${\mathbf{uright}}\left(1\right)\ge 0.0$.
Right pressure value $\mathit{pr}<0.0$: $\mathit{pr}=\u27e8\mathit{\text{value}}\u27e9$.
${\mathbf{ifail}}=-99$
An unexpected error has been triggered by this routine. Please
contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.
7Accuracy
d03pvf performs an exact calculation of the Osher numerical flux function, and so the result will be accurate to machine precision.
8Parallelism and Performance
Background information to multithreading can be found in the Multithreading documentation.
d03pvf is not thread safe and should not be called from a multithreaded user program. Please see Section 1 in FL Interface Multithreading for more information on thread safety.
d03pvf is not threaded in any implementation.
9Further Comments
d03pvf must only be used to calculate the numerical flux for the Euler equations in exactly the form given by (2), with ${\mathbf{uleft}}\left(\mathit{i}\right)$ and ${\mathbf{uright}}\left(\mathit{i}\right)$ containing the left and right values of $\rho ,m$ and $e$, for $\mathit{i}=1,2,3$, respectively. It should be noted that Osher's scheme, in common with all Riemann solvers, may be unsuitable for some problems (see Quirk (1994) for examples). The time taken depends on the input argument path and on the left and right solution values, since inclusion of each subpath depends on the signs of the eigenvalues. In general this cannot be determined in advance.