#include <MOLUtilities.H>

Public Member Functions
	MOLUtilities ()
	Constructor. More...

	~MOLUtilities ()
	Destructor. More...

void	define (const ProblemDomain &a_domain, const Real &a_dx)
	Define the object. More...

void	computeFlattening (FArrayBox &a_flattening, const FArrayBox &a_W, const Interval &a_velInt, const int &a_presInd, const Real &a_smallPres, const int &a_bulkModulusInd, const Box &a_box)
	Compute the slope flattening coefficients. More...

void	applyFlattening (FArrayBox &a_dW, const FArrayBox &a_flat, const Box &a_box)
	Apply the flattening to slopes. More...

void	vanLeerSlopes (FArrayBox &a_dW, const FArrayBox &a_W, const int &a_numSlopes, const bool &a_useLimiting, const int &a_dir, const Box &a_box)
	Compute componentwise van Leer slopes. More...

void	fourthOrderSlopes (FArrayBox &a_dW4, const FArrayBox &a_W, const FArrayBox &a_dWvL, const int &a_numSlopes, const int &a_dir, const Box &a_box)
	Compute fourth-order slopes. More...

void	oneSidedDifferences (FArrayBox &a_dWMinus, FArrayBox &a_dWPlus, const FArrayBox &a_W, const int &a_dir, const Box &a_box)
	Compute slopes (dW- and dW+) using one sided differences. More...

void	slopes (FArrayBox &a_dWCent, FArrayBox &a_dWMinus, FArrayBox &a_dWPlus, const FArrayBox &a_W, const int &a_numSlopes, const int &a_dir, const Box &a_loBox, const Box &a_hiBox, const Box &a_centerBox, const Box &a_entireBox, const int &a_hasLo, const int &a_hasHi)
	Compute slopes (dW (center), dW-, and dW+) More...

void	slopeLimiter (FArrayBox &a_dW, const FArrayBox &a_dWMinus, const FArrayBox &a_dWPlus, const int &a_numSlopes, const Box &a_box)
	van Leer slope limiter. More...

void	slopeLimiterExtPreserving (FArrayBox &a_dW, const FArrayBox &a_dWMinus, const FArrayBox &a_dWPlus, const int &a_numSlopes, const Box &a_box, const int &a_dir)
	extremum-preserving van Leer slope limiter. More...

void	PPMFaceValues (FArrayBox &a_WFace, const FArrayBox &a_W, const int &a_numSlopes, const bool &a_useLimiting, const int &a_dir, const Box &a_box, const Real &a_time, const MOLPhysics *a_physPtr=NULL)
	PPM face-centered interpolant. More...

void	PPMLimiter (FArrayBox &a_dWMinus, FArrayBox &a_dWPlus, const FArrayBox &a_W, const int &a_numSlopes, const int &a_dir, const Box &a_box)
	PPM Limiter. More...

void	divVel (FArrayBox &a_divVel, const FArrayBox &a_W, const Interval &a_velInt, const int &a_dir, const Box &a_box)
	Compute face-centered velocity divergence. More...

void	divVelHO (FArrayBox &a_divVel, const FArrayBox &a_W, const int &a_dir, const Box &a_box, MOLPhysics *a_physPtr)

void	artificialViscosity (FArrayBox &a_F, const FArrayBox &a_U, const FArrayBox &a_divVel, const Real &a_scale, const int &a_dir, const Box &a_box)
	Compute face-centered artificial viscosity flux. More...

void	highOrderLimiter (bool a_highOrderLimiter)
	Set whether to use high-order limiter. More...

void	deconvolve (FArrayBox &a_avgFab, const FArrayBox &a_cellFab, int a_sign=1)
	a_avgFab += a_sign * laplacian(a_cellFab) * m_dx^2 / 24, on a_cellFab.box() More...

void	deconvolve (FArrayBox &a_avgFab, const FArrayBox &a_cellFab, const Box &a_box, int a_sign=1)
	a_avgFab += a_sign * laplacian(a_cellFab) * m_dx^2 / 24, on a_box More...

void	deconvolveFace (FluxBox &a_avgFlux, const FluxBox &a_cellFlux, int a_sign=1)
	a_avgFlux += a_sign * laplacian(a_cellFlux) * m_dx^2 / 24, on faces of a_cellFlux.box() More...

void	deconvolveFace (FluxBox &a_avgFlux, const FluxBox &a_cellFlux, const Box &a_box, int a_sign=1)
	a_avgFlux += a_sign * laplacian(a_cellFlux) * m_dx^2 / 24, on faces of a_box More...

void	deconvolveCenterFace (FArrayBox &a_faceFab, const FArrayBox &a_faceExtFab, const Box &a_box, int a_dir, int a_sign=1)
	a_faceFab += a_sign * laplacian(a_faceExtFab) * m_dx^2 / 24, on faces of a_box, which is a_dir-face-centered More...

Protected Attributes
ProblemDomain	m_domain

Real	m_dx

bool	m_isDefined

bool	m_highOrderLimiter

Private Member Functions
void	operator= (const MOLUtilities &a_input)

	MOLUtilities (const MOLUtilities &a_input)

Detailed Description

Utility class for higher-order methods of lines: slopes, parabolic interpolants, limiters. Contains no physics-dependent methods, but one of the member functions (PPMFaceLimiter) may require a pointer to a physics class analysis class in order to perform limiting in characteristic variables.

Constructor & Destructor Documentation

◆ MOLUtilities() [1/2]

MOLUtilities::MOLUtilities ( )

Constructor.

◆ ~MOLUtilities()

MOLUtilities::~MOLUtilities ( )

Destructor.

◆ MOLUtilities() [2/2]

MOLUtilities::MOLUtilities ( const MOLUtilities & a_input )

inlineprivate

References MayDay::Error().

Member Function Documentation

◆ define()

void MOLUtilities::define	(	const ProblemDomain &	a_domain,
		const Real &	a_dx
	)

Define the object.

◆ computeFlattening()

void MOLUtilities::computeFlattening	(	FArrayBox &	a_flattening,
		const FArrayBox &	a_W,
		const Interval &	a_velInt,
		const int &	a_presInd,
		const Real &	a_smallPres,
		const int &	a_bulkModulusInd,
		const Box &	a_box
	)

Compute the slope flattening coefficients.

Compute the slope flattening coefficients, a_flattening, using the primitive variables, a_W, within a_box.

Parameters

a_flattening	flattening coeffs, 1 component on a_box
a_W	primitive variables, on a_box grown by 3 within m_domain
a_velInt	interval of a_W with velocity; length SpaceDim
a_presInd	index of a_W with pressure
a_smallPres	minimum pressure to use in ratio
a_bulkModulusInd	index of a_W with bulk modulus
a_box	cell-centered box on which a_flattening lives

◆ applyFlattening()

void MOLUtilities::applyFlattening	(	FArrayBox &	a_dW,
		const FArrayBox &	a_flat,
		const Box &	a_box
	)

Apply the flattening to slopes.

Multiply every component of a_dW by a_flat, on a_box.

Parameters

a_dW	slopes to be flattened, on at least a_box
a_flat	cell-centered flattening coefficients, on at least a_box
a_box	cell-centered box on which to flatten

◆ vanLeerSlopes()

void MOLUtilities::vanLeerSlopes	(	FArrayBox &	a_dW,
		const FArrayBox &	a_W,
		const int &	a_numSlopes,
		const bool &	a_useLimiting,
		const int &	a_dir,
		const Box &	a_box
	)

Compute componentwise van Leer slopes.

Given cell averages W, compute van Leer slopes dW on a component-by-component basis.

◆ fourthOrderSlopes()

void MOLUtilities::fourthOrderSlopes	(	FArrayBox &	a_dW4,
		const FArrayBox &	a_W,
		const FArrayBox &	a_dWvL,
		const int &	a_numSlopes,
		const int &	a_dir,
		const Box &	a_box
	)

Compute fourth-order slopes.

Given cell averages W and van Leer slopes dWvL, compute fourth-order slopes dW4. Limiting is performed in a separate pass.

◆ oneSidedDifferences()

void MOLUtilities::oneSidedDifferences	(	FArrayBox &	a_dWMinus,
		FArrayBox &	a_dWPlus,
		const FArrayBox &	a_W,
		const int &	a_dir,
		const Box &	a_box
	)

Compute slopes (dW- and dW+) using one sided differences.

◆ slopes()

void MOLUtilities::slopes	(	FArrayBox &	a_dWCent,
		FArrayBox &	a_dWMinus,
		FArrayBox &	a_dWPlus,
		const FArrayBox &	a_W,
		const int &	a_numSlopes,
		const int &	a_dir,
		const Box &	a_loBox,
		const Box &	a_hiBox,
		const Box &	a_centerBox,
		const Box &	a_entireBox,
		const int &	a_hasLo,
		const int &	a_hasHi
	)

Compute slopes (dW (center), dW-, and dW+)

a_dwCent, a_dwMinus, a_dWPlus, and a_dW all live on cell-centered a_entireBox.

For i in a_centerBox: a_dwCent[i] = (a_W[i+1] - a_W[i-1])/2; a_dWMinus[i] = a_W[i] - a_W[i-1]; a_dWPlus[i] = a_W[i+1] - a_W[i].

For i in a_loBox, set only a_dWPlus[i] = a_W[i+1] - a_W[i] and copy it to a_dWCent[i] and a_dWMinus[i].

For i in a_hiBox, set only a_dWMinus[i] = a_W[i] - a_W[i-1] and copy it to a_dWCent[i] and a_dWPlus[i].

◆ slopeLimiter()

void MOLUtilities::slopeLimiter	(	FArrayBox &	a_dW,
		const FArrayBox &	a_dWMinus,
		const FArrayBox &	a_dWPlus,
		const int &	a_numSlopes,
		const Box &	a_box
	)

van Leer slope limiter.

On input, dW contains the centered, unlimited slopes, and dW(Minus,Plus) contain the one-sided slopes from the minus, plus sides. On output, dW contains the limited slopes. slopes dW4. Limiting is performed in a separate pass.

◆ slopeLimiterExtPreserving()

void MOLUtilities::slopeLimiterExtPreserving	(	FArrayBox &	a_dW,
		const FArrayBox &	a_dWMinus,
		const FArrayBox &	a_dWPlus,
		const int &	a_numSlopes,
		const Box &	a_box,
		const int &	a_dir
	)

extremum-preserving van Leer slope limiter.

On input, dW contains the centered, unlimited slopes, and dW(Minus,Plus) contain the one-sided slopes from the minus, plus sides. On output, dW contains the limited slopes. slopes dW4. Limiting is performed in a separate pass.

◆ PPMFaceValues()

void MOLUtilities::PPMFaceValues	(	FArrayBox &	a_WFace,
		const FArrayBox &	a_W,
		const int &	a_numSlopes,
		const bool &	a_useLimiting,
		const int &	a_dir,
		const Box &	a_box,
		const Real &	a_time,
		const MOLPhysics *	a_physPtr = `NULL`
	)

PPM face-centered interpolant.

Given the cell average a_W, compute fourth-order accurate face-centered values WFace on a_box by differentiating the indefinite integral. Limiting is performed in a separate pass.

◆ PPMLimiter()

void MOLUtilities::PPMLimiter	(	FArrayBox &	a_dWMinus,
		FArrayBox &	a_dWPlus,
		const FArrayBox &	a_W,
		const int &	a_numSlopes,
		const int &	a_dir,
		const Box &	a_box
	)

PPM Limiter.

a_dWMinus and a_dWPlus are the differences between the face values on the minus and plus sides of cells and the average in the cell. That is, a_dWMinus[i] = WFace[i - e/2] - a_W[i] a_dWPlus[i] = WFace[i + e/2] - a_W[i] where e is the unit vector in dimension a_dir. The PPM limiter is applied to these values to obtain a monotone interpolant in the cell. The function returns the limited a_dWMinus and a_dWPlus on a_box. petermc, 4 Sep 2008: included a_W in argument list

If m_highOrderLimiter, then need a_dWMinus and a_dWPlus on a_box, and need a_W on on a_box grown by 3 in dimension a_dir. Returns limited a_dWMinus and a_dWPlus on a_box.

◆ divVel()

void MOLUtilities::divVel	(	FArrayBox &	a_divVel,
		const FArrayBox &	a_W,
		const Interval &	a_velInt,
		const int &	a_dir,
		const Box &	a_box
	)

Compute face-centered velocity divergence.

Returns face-centered velocity divergence on for faces in the direction a_dir. The velocities are the components a_velInterval of a_W.

◆ divVelHO()

void MOLUtilities::divVelHO	(	FArrayBox &	a_divVel,
		const FArrayBox &	a_W,
		const int &	a_dir,
		const Box &	a_box,
		MOLPhysics *	a_physPtr
	)

◆ artificialViscosity()

void MOLUtilities::artificialViscosity	(	FArrayBox &	a_F,
		const FArrayBox &	a_U,
		const FArrayBox &	a_divVel,
		const Real &	a_scale,
		const int &	a_dir,
		const Box &	a_box
	)

Compute face-centered artificial viscosity flux.

Increments face-centered flux in the a_dir direction with quadratic artificial viscosity.

Increments a_F on all non-boundary a_dir-faces of a_box using a_U on all cells of a_box and a_divVel on all non-boundary a_dir-faces of a_box.

◆ highOrderLimiter()

void MOLUtilities::highOrderLimiter ( bool a_highOrderLimiter )

Set whether to use high-order limiter.

◆ deconvolve() [1/2]

void MOLUtilities::deconvolve	(	FArrayBox &	a_avgFab,
		const FArrayBox &	a_cellFab,
		int	a_sign = `1`
	)

a_avgFab += a_sign * laplacian(a_cellFab) * m_dx^2 / 24, on a_cellFab.box()

◆ deconvolve() [2/2]

void MOLUtilities::deconvolve	(	FArrayBox &	a_avgFab,
		const FArrayBox &	a_cellFab,
		const Box &	a_box,
		int	a_sign = `1`
	)

a_avgFab += a_sign * laplacian(a_cellFab) * m_dx^2 / 24, on a_box

◆ deconvolveFace() [1/2]

void MOLUtilities::deconvolveFace	(	FluxBox &	a_avgFlux,
		const FluxBox &	a_cellFlux,
		int	a_sign = `1`
	)

a_avgFlux += a_sign * laplacian(a_cellFlux) * m_dx^2 / 24, on faces of a_cellFlux.box()

◆ deconvolveFace() [2/2]

void MOLUtilities::deconvolveFace	(	FluxBox &	a_avgFlux,
		const FluxBox &	a_cellFlux,
		const Box &	a_box,
		int	a_sign = `1`
	)

a_avgFlux += a_sign * laplacian(a_cellFlux) * m_dx^2 / 24, on faces of a_box

◆ deconvolveCenterFace()

void MOLUtilities::deconvolveCenterFace	(	FArrayBox &	a_faceFab,
		const FArrayBox &	a_faceExtFab,
		const Box &	a_box,
		int	a_dir,
		int	a_sign = `1`
	)

a_faceFab += a_sign * laplacian(a_faceExtFab) * m_dx^2 / 24, on faces of a_box, which is a_dir-face-centered

Convert a_faceFab from face-centered to face-averaged (a_sign = 1) or vice versa (a_sign = -1) on a_dir-face-centered a_box by using the second derivative from a_faceExtFab, which will typically extend farther than a_faceFab does.

◆ operator=()

void MOLUtilities::operator= ( const MOLUtilities & a_input )

inlineprivate

References MayDay::Error().

Member Data Documentation

◆ m_domain

ProblemDomain MOLUtilities::m_domain

protected

◆ m_dx

Real MOLUtilities::m_dx

protected

◆ m_isDefined

bool MOLUtilities::m_isDefined

protected

◆ m_highOrderLimiter

bool MOLUtilities::m_highOrderLimiter

protected

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

MOLUtilities.H

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MOLUtilities() [1/2]

◆ ~MOLUtilities()

◆ MOLUtilities() [2/2]

Member Function Documentation

◆ define()

◆ computeFlattening()

◆ applyFlattening()

◆ vanLeerSlopes()

◆ fourthOrderSlopes()

◆ oneSidedDifferences()

◆ slopes()

◆ slopeLimiter()

◆ slopeLimiterExtPreserving()

◆ PPMFaceValues()

◆ PPMLimiter()

◆ divVel()

◆ divVelHO()

◆ artificialViscosity()

◆ highOrderLimiter()

◆ deconvolve() [1/2]

◆ deconvolve() [2/2]

◆ deconvolveFace() [1/2]

◆ deconvolveFace() [2/2]

◆ deconvolveCenterFace()

◆ operator=()

Member Data Documentation

◆ m_domain

◆ m_dx

◆ m_isDefined

◆ m_highOrderLimiter