ScalarWave::BoundaryCorrections::UpwindPenalty< Dim > Class Template Reference

Computes the scalar wave upwind multipenalty boundary correction. More...

#include <UpwindPenalty.hpp>

Public Types
using	options = implementation defined
using	dg_package_field_tags = implementation defined
using	dg_package_data_temporary_tags = implementation defined
using	dg_package_data_volume_tags = implementation defined
using	dg_boundary_terms_volume_tags = implementation defined
Public Types inherited from ScalarWave::BoundaryCorrections::BoundaryCorrection< Dim >
using	creatable_classes = implementation defined

Public Member Functions
	UpwindPenalty (const UpwindPenalty &)=default
UpwindPenalty &	operator= (const UpwindPenalty &)=default
	UpwindPenalty (UpwindPenalty &&)=default
UpwindPenalty &	operator= (UpwindPenalty &&)=default
void	pup (PUP::er &p) override
std::unique_ptr< BoundaryCorrection< Dim > >	get_clone () const override
double	dg_package_data (gsl::not_null< Scalar< DataVector > * > packaged_char_speed_v_psi, gsl::not_null< tnsr::i< DataVector, Dim, Frame::Inertial > * > packaged_char_speed_v_zero, gsl::not_null< Scalar< DataVector > * > packaged_char_speed_v_plus, gsl::not_null< Scalar< DataVector > * > packaged_char_speed_v_minus, gsl::not_null< tnsr::i< DataVector, Dim, Frame::Inertial > * > packaged_char_speed_n_times_v_plus, gsl::not_null< tnsr::i< DataVector, Dim, Frame::Inertial > * > packaged_char_speed_n_times_v_minus, gsl::not_null< Scalar< DataVector > * > packaged_char_speed_gamma2_v_psi, gsl::not_null< tnsr::i< DataVector, 3, Frame::Inertial > * > packaged_char_speeds, const Scalar< DataVector > &psi, const Scalar< DataVector > &pi, const tnsr::i< DataVector, Dim, Frame::Inertial > &phi, const Scalar< DataVector > &constraint_gamma2, const tnsr::i< DataVector, Dim, Frame::Inertial > &normal_covector, const std::optional< tnsr::I< DataVector, Dim, Frame::Inertial > > &, const std::optional< Scalar< DataVector > > &normal_dot_mesh_velocity) const
void	dg_boundary_terms (gsl::not_null< Scalar< DataVector > * > psi_boundary_correction, gsl::not_null< Scalar< DataVector > * > pi_boundary_correction, gsl::not_null< tnsr::i< DataVector, Dim, Frame::Inertial > * > phi_boundary_correction, const Scalar< DataVector > &char_speed_v_psi_int, const tnsr::i< DataVector, Dim, Frame::Inertial > &char_speed_v_zero_int, const Scalar< DataVector > &char_speed_v_plus_int, const Scalar< DataVector > &char_speed_v_minus_int, const tnsr::i< DataVector, Dim, Frame::Inertial > &char_speed_normal_times_v_plus_int, const tnsr::i< DataVector, Dim, Frame::Inertial > &char_speed_normal_times_v_minus_int, const Scalar< DataVector > &char_speed_constraint_gamma2_v_psi_int, const tnsr::i< DataVector, 3, Frame::Inertial > &char_speeds_int, const Scalar< DataVector > &char_speed_v_psi_ext, const tnsr::i< DataVector, Dim, Frame::Inertial > &char_speed_v_zero_ext, const Scalar< DataVector > &char_speed_v_plus_ext, const Scalar< DataVector > &char_speed_v_minus_ext, const tnsr::i< DataVector, Dim, Frame::Inertial > &char_speed_minus_normal_times_v_plus_ext, const tnsr::i< DataVector, Dim, Frame::Inertial > &char_speed_minus_normal_times_v_minus_ext, const Scalar< DataVector > &char_speed_constraint_gamma2_v_psi_ext, const tnsr::i< DataVector, 3, Frame::Inertial > &char_speeds_ext, dg::Formulation) const
Public Member Functions inherited from ScalarWave::BoundaryCorrections::BoundaryCorrection< Dim >
	BoundaryCorrection (const BoundaryCorrection &)=default
BoundaryCorrection &	operator= (const BoundaryCorrection &)=default
	BoundaryCorrection (BoundaryCorrection &&)=default
BoundaryCorrection &	operator= (BoundaryCorrection &&)=default
virtual std::unique_ptr< BoundaryCorrection< Dim > >	get_clone () const =0

Static Public Attributes
static constexpr Options::String	help

Detailed Description

template<size_t Dim>
class ScalarWave::BoundaryCorrections::UpwindPenalty< Dim >

Computes the scalar wave upwind multipenalty boundary correction.

This implements the upwind multipenalty boundary correction term $D_{\beta }$. The general form is given by:

$$\begin{array}{r}{D}_{\beta }=T_{\beta \hat{\beta }}^{\mathrm{e}\mathrm{x}\mathrm{t}}{\mathrm{\Lambda }}_{\hat{\beta }\hat{\alpha }}^{\mathrm{e}\mathrm{x}\mathrm{t},-}{v}_{\hat{\alpha }}^{\mathrm{e}\mathrm{x}\mathrm{t}}-T_{\beta \hat{\beta }}^{\mathrm{i}\mathrm{n}\mathrm{t}}{\mathrm{\Lambda }}_{\hat{\beta }\hat{\alpha }}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}_{\hat{\alpha }}^{\mathrm{i}\mathrm{n}\mathrm{t}}.\end{array}$$

We denote the evolved fields by $u_{\alpha }$, the characteristic fields by $v_{\hat{\alpha }}$, and implicitly sum over reapeated indices. $T_{\beta \hat{\beta }}$ transforms characteristic fields to evolved fields, while ${\mathrm{\Lambda }}_{\hat{\beta }\hat{\alpha }}^{-}$ is a diagonal matrix with only the negative characteristic speeds, and has zeros on the diagonal for all other entries. The int and ext superscripts denote quantities on the internal and external side of the mortar. Note that Eq. (6.3) of [192] is not exactly what's implemented since that boundary term does not consistently treat both sides of the interface on the same footing.

For the scalar wave system the correction is:

$$\begin{array}{rl}\text{(1)}& D_{\mathrm{\Psi }}& ={\lambda }_{v^{\mathrm{\Psi }}}^{\mathrm{e}\mathrm{x}\mathrm{t},-}{v}^{\mathrm{e}\mathrm{x}\mathrm{t},\mathrm{\Psi }}-{\lambda }_{v^{\mathrm{\Psi }}}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}^{\mathrm{i}\mathrm{n}\mathrm{t},\mathrm{\Psi }},D_{\mathrm{\Pi }}& =\frac{1}{2}({\lambda }_{v^{+}}^{\mathrm{e}\mathrm{x}\mathrm{t},-}{v}^{\mathrm{e}\mathrm{x}\mathrm{t},+}+{\lambda }_{v^{-}}^{\mathrm{e}\mathrm{x}\mathrm{t},-}{v}^{\mathrm{e}\mathrm{x}\mathrm{t},-})+{\lambda }_{v^{\mathrm{\Psi }}}^{\mathrm{e}\mathrm{x}\mathrm{t},-}{\gamma }_2{v}^{\mathrm{e}\mathrm{x}\mathrm{t},\mathrm{\Psi }}\\ \text{(2)}& & -\frac{1}{2}({\lambda }_{v^{+}}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}^{\mathrm{i}\mathrm{n}\mathrm{t},+}+{\lambda }_{v^{-}}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}^{\mathrm{i}\mathrm{n}\mathrm{t},-})-{\lambda }_{v^{\mathrm{\Psi }}}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{\gamma }_2{v}^{\mathrm{i}\mathrm{n}\mathrm{t},\mathrm{\Psi }},D_{{\mathrm{\Phi }}_i}& =\frac{1}{2}({\lambda }_{v^{+}}^{\mathrm{e}\mathrm{x}\mathrm{t},-}{v}^{\mathrm{e}\mathrm{x}\mathrm{t},+}-{\lambda }_{v^{-}}^{\mathrm{e}\mathrm{x}\mathrm{t},-}{v}^{\mathrm{e}\mathrm{x}\mathrm{t},-})n_i^{\mathrm{e}\mathrm{x}\mathrm{t}}+{\lambda }_{v^0}^{\mathrm{e}\mathrm{x}\mathrm{t},-}{v}_i^{\mathrm{e}\mathrm{x}\mathrm{t},0}\\ \text{(3)}& & -\frac{1}{2}({\lambda }_{v^{+}}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}^{\mathrm{i}\mathrm{n}\mathrm{t},+}-{\lambda }_{v^{-}}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}^{\mathrm{i}\mathrm{n}\mathrm{t},-})n_i^{\mathrm{i}\mathrm{n}\mathrm{t}}-{\lambda }_{v^0}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}_i^{\mathrm{i}\mathrm{n}\mathrm{t},0},\end{array}$$

with characteristic fields

$$\begin{array}{}\text{(4)}& v^{\mathrm{\Psi }}& =\mathrm{\Psi },\text{(5)}& v_i^0& =({\delta }_i^k-n^k{n}_i){\mathrm{\Phi }}_k,\text{(6)}& v^{\pm }& =\mathrm{\Pi }\pm n^i{\mathrm{\Phi }}_i-{\gamma }_2\mathrm{\Psi },\end{array}$$

and characteristic speeds

$$\begin{array}{}\text{(7)}& {\lambda }_{v^{\mathrm{\Psi }}}=& -v_g^i{n}_i,\text{(8)}& {\lambda }_{v^0}=& -v_g^i{n}_i,\text{(9)}& {\lambda }_{v^{\pm }}=& \pm 1-v_g^i{n}_i,\end{array}$$

where $v_g^i$ is the mesh velocity and $n_i$ is the outward directed unit normal covector to the interface. We have also defined

$$\begin{array}{}\text{(10)}& {\lambda }_{\hat{\alpha }}^{\pm }=\{\begin{array}{ll}{\lambda }_{\hat{\alpha }}& \mathrm{i}\mathrm{f}\pm {\lambda }_{\hat{\alpha }}>0\\ 0& \mathrm{o}\mathrm{t}\mathrm{h}\mathrm{e}\mathrm{r}\mathrm{w}\mathrm{i}\mathrm{s}\mathrm{e}\end{array}\end{array}$$

In the implementation we store the speeds in a rank-3 tensor with the zeroth component being ${\lambda }_{v^{\mathrm{\Psi }}}$, the first being ${\lambda }_{v^{+}}$ and the second being ${\lambda }_{v^{-}}$.

Note that we have assumed $n_i^{\mathrm{e}\mathrm{x}\mathrm{t}}$ points in the same direction as $n_i^{\mathrm{i}\mathrm{n}\mathrm{t}}$, but in the code they point in opposite directions. If $n_i^{\mathrm{e}\mathrm{x}\mathrm{t}}$ points in the opposite direction the external speeds have their sign flipped and the $\pm$ fields and their speeds reverse roles (i.e. the $v^{\mathrm{e}\mathrm{x}\mathrm{t},+}$ field is now flowing into the element, while $v^{\mathrm{e}\mathrm{x}\mathrm{t},-}$ flows out). In our implementation this reversal actually cancels out, and we have the following equations:

$$\begin{array}{rl}\text{(11)}& D_{\mathrm{\Psi }}& =-{\lambda }_{v^{\mathrm{\Psi }}}^{\mathrm{e}\mathrm{x}\mathrm{t},+}{v}^{\mathrm{e}\mathrm{x}\mathrm{t},\mathrm{\Psi }}-{\lambda }_{v^{\mathrm{\Psi }}}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}^{\mathrm{i}\mathrm{n}\mathrm{t},\mathrm{\Psi }},D_{\mathrm{\Pi }}& =\frac{1}{2}(-{\lambda }_{v^{+}}^{\mathrm{e}\mathrm{x}\mathrm{t},+}{v}^{\mathrm{e}\mathrm{x}\mathrm{t},+}-{\lambda }_{v^{-}}^{\mathrm{e}\mathrm{x}\mathrm{t},+}{v}^{\mathrm{e}\mathrm{x}\mathrm{t},-})-{\lambda }_{v^{\mathrm{\Psi }}}^{\mathrm{e}\mathrm{x}\mathrm{t},+}{\gamma }_2{v}^{\mathrm{e}\mathrm{x}\mathrm{t},\mathrm{\Psi }}\\ \text{(12)}& & -\frac{1}{2}({\lambda }_{v^{+}}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}^{\mathrm{i}\mathrm{n}\mathrm{t},+}+{\lambda }_{v^{-}}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}^{\mathrm{i}\mathrm{n}\mathrm{t},-})-{\lambda }_{v^{\mathrm{\Psi }}}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{\gamma }_2{v}^{\mathrm{i}\mathrm{n}\mathrm{t},\mathrm{\Psi }},D_{{\mathrm{\Phi }}_i}& =\frac{1}{2}(-{\lambda }_{v^{+}}^{\mathrm{e}\mathrm{x}\mathrm{t},+}{v}^{\mathrm{e}\mathrm{x}\mathrm{t},+}+{\lambda }_{v^{-}}^{\mathrm{e}\mathrm{x}\mathrm{t},+}{v}^{\mathrm{e}\mathrm{x}\mathrm{t},-})n_i^{\mathrm{e}\mathrm{x}\mathrm{t}}-{\lambda }_{v^0}^{\mathrm{e}\mathrm{x}\mathrm{t},+}{v}_i^{\mathrm{e}\mathrm{x}\mathrm{t},0}\\ \text{(13)}& & -\frac{1}{2}({\lambda }_{v^{+}}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}^{\mathrm{i}\mathrm{n}\mathrm{t},+}-{\lambda }_{v^{-}}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}^{\mathrm{i}\mathrm{n}\mathrm{t},-})n_i^{\mathrm{i}\mathrm{n}\mathrm{t}}-{\lambda }_{v^0}^{\mathrm{i}\mathrm{n}\mathrm{t},-}{v}_i^{\mathrm{i}\mathrm{n}\mathrm{t},0},\end{array}$$

Member Function Documentation

get_clone()

template<size_t Dim>

std::unique_ptr< BoundaryCorrection< Dim > > ScalarWave::BoundaryCorrections::UpwindPenalty< Dim >::get_clone ( ) const

overridevirtual

Implements ScalarWave::BoundaryCorrections::BoundaryCorrection< Dim >.

Member Data Documentation

help

template<size_t Dim>

constexpr Options::String ScalarWave::BoundaryCorrections::UpwindPenalty< Dim >::help

staticconstexpr

Initial value:

= {
      "Computes the UpwindPenalty boundary correction term for the scalar wave "
      "system."}

---

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

• src/Evolution/Systems/ScalarWave/BoundaryCorrections/UpwindPenalty.hpp