PolytropicPhysics Class Reference

#include <PolytropicPhysics.H>

Inheritance diagram for PolytropicPhysics:

[legend]

List of all members.

---

Detailed Description

The base class PolytropicPhysics provides the physics-dependent components for a higher-order method for a single patch: characteristic analysis, Riemann solver, quasilinear update, conservative update, and transformations between conserved, primitive, and flux variables. This class is essentially pure; i.e., all of its member functions are; and the ones that have default implementations are ones that are optionally defined; i.e., the default definition is to send an error message. Physics-dependent versions of this class that are required in real applications are derived from this class by inheritance.

Public Member Functions
	PolytropicPhysics (const Real &a_smallPressure)
	Constructor.
	~PolytropicPhysics ()
	Destructor.
Real	getMaxWaveSpeed (const FArrayBox &a_U, const Box &a_box)
	Compute the maximum wave speed.
void	soundSpeed (FArrayBox &a_speed, const FArrayBox &a_U, const Box &a_box)
	Compute the speed of sound.
virtual GodunovPhysics *	new_godunovPhysics () const
	Object factory for this class.
int	numConserved ()
	Number of conserved variables.
Vector< string >	stateNames ()
	Names of the conserved variables.
int	numFluxes ()
	Number of flux variables.
int	densityIndex ()
	Component index within the primitive variables of the density.
void	getFlux (FArrayBox &a_flux, const FArrayBox &a_whalf, const int &a_dir, const Box &a_box)
	Compute a flux from primitive variable values on a face.
int	numPrimitives ()
	Number of primitive variables.
void	charAnalysis (FArrayBox &a_dW, const FArrayBox &a_W, const int &a_dir, const Box &a_box)
	Transform a_dW from primitive to characteristic variables.
void	charSynthesis (FArrayBox &a_dW, const FArrayBox &a_W, const int &a_dir, const Box &a_box)
	Transform a_dW from characteristic to primitive variables.
void	charValues (FArrayBox &a_lambda, const FArrayBox &a_W, const int &a_dir, const Box &a_box)
	Compute the characteristic values (eigenvalues).
void	incrementSource (FArrayBox &a_S, const FArrayBox &a_W, const Box &a_box)
	Add to (increment) the source terms given the current state.
void	riemann (FArrayBox &a_WStar, const FArrayBox &a_WLeft, const FArrayBox &a_WRight, const FArrayBox &a_W, const Real &a_time, const int &a_dir, const Box &a_box)
	Compute the solution to the Riemann problem.
virtual void	postNormalPred (FArrayBox &a_dWMinus, FArrayBox &a_dWPlus, const FArrayBox &a_W, const Real &a_dt, const Real &a_dx, const int &a_dir, const Box &a_box)
	Post-normal predictor calculation.
void	quasilinearUpdate (FArrayBox &a_dWdx, const FArrayBox &a_WHalf, const FArrayBox &a_W, const Real &a_scale, const int &a_dir, const Box &a_box)
	Compute the quasilinear update A*dW/dx.
void	consToPrim (FArrayBox &a_W, const FArrayBox &a_U, const Box &a_box)
	Compute primitive variables from conserved variables.
virtual Interval	velocityInterval ()
	Interval within the primitive variables corresponding to the velocities.
virtual Interval	vectorFluxInterval ()
	Interval within the flux variables corresponding to vector flux.
virtual int	pressureIndex ()
	Component index within the primitive variables of the pressure.
virtual Real	smallPressure ()
	Used to limit the absolute value of a "pressure" difference (away from zero).
virtual int	bulkModulusIndex ()
	Component index within the primitive variables of the bulk modulus.
virtual void	expressions (HDF5HeaderData &a_holder) const
Protected Attributes
Real	m_smallPressure
Private Member Functions
void	operator= (const PolytropicPhysics &)
	PolytropicPhysics (const PolytropicPhysics &)

---

Constructor & Destructor Documentation

PolytropicPhysics::PolytropicPhysics

(

const Real &

a_smallPressure

)

Constructor.

PolytropicPhysics::~PolytropicPhysics

(

)

Destructor.

PolytropicPhysics::PolytropicPhysics

(

const PolytropicPhysics &

)

[private]

---

Member Function Documentation

Real PolytropicPhysics::getMaxWaveSpeed	(	const FArrayBox &	a_U,
		const Box &	a_box
	)			[virtual]

Compute the maximum wave speed.

Implements GodunovPhysics.

void PolytropicPhysics::soundSpeed	(	FArrayBox &	a_speed,
		const FArrayBox &	a_U,
		const Box &	a_box
	)			[virtual]

Compute the speed of sound.

Reimplemented from GodunovPhysics.

virtual GodunovPhysics* PolytropicPhysics::new_godunovPhysics

(

)

const [virtual]

Object factory for this class.

Implements GodunovPhysics.

int PolytropicPhysics::numConserved

(

)

[virtual]

Number of conserved variables.

Return the number of conserved variables.

Implements GodunovPhysics.

Vector<string> PolytropicPhysics::stateNames

(

)

[virtual]

Names of the conserved variables.

Return the names of the conserved variables. A default implementation is provided that puts in generic names (i.e., "variable#" which "#" ranges for 0 to numConserved()-1.

Implements GodunovPhysics.

int PolytropicPhysics::numFluxes

(

)

[virtual]

Number of flux variables.

Return the number of flux variables. This can be greater than the number of conserved variables if addition fluxes/face-centered quantities are computed.

Implements GodunovPhysics.

int PolytropicPhysics::densityIndex

(

)

[virtual]

Component index within the primitive variables of the density.

Return the component index within the primitive variables for the density. Used for fourth-order accurate artificial viscosity.

Reimplemented from GodunovPhysics.

void PolytropicPhysics::getFlux	(	FArrayBox &	a_flux,
		const FArrayBox &	a_whalf,
		const int &	a_dir,
		const Box &	a_box
	)			[virtual]

Compute a flux from primitive variable values on a face.

Reimplemented from GodunovPhysics.

int PolytropicPhysics::numPrimitives

(

)

[virtual]

Number of primitive variables.

Return the number of primitive variables. This may be greater than the number of conserved variables if derived/redundant quantities are also stored for convenience.

Implements GodunovPhysics.

void PolytropicPhysics::charAnalysis	(	FArrayBox &	a_dW,
		const FArrayBox &	a_W,
		const int &	a_dir,
		const Box &	a_box
	)			[virtual]

Transform a_dW from primitive to characteristic variables.

On input, a_dW contains the increments of the primitive variables. On output, it contains the increments in the characteristic variables.

IMPORTANT NOTE: It is assumed that the characteristic analysis puts the smallest eigenvalue first, the largest eigenvalue last, and orders the characteristic variables accordingly.

Implements GodunovPhysics.

void PolytropicPhysics::charSynthesis	(	FArrayBox &	a_dW,
		const FArrayBox &	a_W,
		const int &	a_dir,
		const Box &	a_box
	)			[virtual]

Transform a_dW from characteristic to primitive variables.

On input, a_dW contains the increments of the characteristic variables. On output, it contains the increments in the primitive variables.

IMPORTANT NOTE: It is assumed that the characteristic analysis puts the smallest eigenvalue first, the largest eigenvalue last, and orders the characteristic variables accordingly.

Implements GodunovPhysics.

void PolytropicPhysics::charValues	(	FArrayBox &	a_lambda,
		const FArrayBox &	a_W,
		const int &	a_dir,
		const Box &	a_box
	)			[virtual]

Compute the characteristic values (eigenvalues).

Compute the characteristic values (eigenvalues)

IMPORTANT NOTE: It is assumed that the characteristic analysis puts the smallest eigenvalue first, the largest eigenvalue last, and orders the characteristic variables accordingly.

Implements GodunovPhysics.

void PolytropicPhysics::incrementSource	(	FArrayBox &	a_S,
		const FArrayBox &	a_W,
		const Box &	a_box
	)			[virtual]

Add to (increment) the source terms given the current state.

On input, a_S contains the current source terms. On output, a_S has had any additional source terms (based on the current state, a_W) added to it. This should all be done on the region defined by a_box.

Implements GodunovPhysics.

void PolytropicPhysics::riemann	(	FArrayBox &	a_WStar,
		const FArrayBox &	a_WLeft,
		const FArrayBox &	a_WRight,
		const FArrayBox &	a_W,
		const Real &	a_time,
		const int &	a_dir,
		const Box &	a_box
	)			[virtual]

Compute the solution to the Riemann problem.

Given input left and right states in a direction, a_dir, compute a Riemann problem and generate fluxes at the faces within a_box.

Implements GodunovPhysics.

virtual void PolytropicPhysics::postNormalPred	(	FArrayBox &	a_dWMinus,
		FArrayBox &	a_dWPlus,
		const FArrayBox &	a_W,
		const Real &	a_dt,
		const Real &	a_dx,
		const int &	a_dir,
		const Box &	a_box
	)			[virtual]

Post-normal predictor calculation.

Add increment to normal predictor, e.g. to account for source terms due to spatially-varying coefficients, to bound primitive variable ranges.

Implements GodunovPhysics.

void PolytropicPhysics::quasilinearUpdate	(	FArrayBox &	a_dWdx,
		const FArrayBox &	a_WHalf,
		const FArrayBox &	a_W,
		const Real &	a_scale,
		const int &	a_dir,
		const Box &	a_box
	)			[virtual]

Compute the quasilinear update A*dW/dx.

Implements GodunovPhysics.

void PolytropicPhysics::consToPrim	(	FArrayBox &	a_W,
		const FArrayBox &	a_U,
		const Box &	a_box
	)			[virtual]

Compute primitive variables from conserved variables.

Implements GodunovPhysics.

virtual Interval PolytropicPhysics::velocityInterval

(

)

[virtual]

Interval within the primitive variables corresponding to the velocities.

Return the interval of component indices within the primitive variable of the velocities. Used for slope flattening (slope computation) and computing the divergence of the velocity (artificial viscosity).

Implements GodunovPhysics.

virtual Interval PolytropicPhysics::vectorFluxInterval

(

)

[virtual]

Interval within the flux variables corresponding to vector flux.

virtual int PolytropicPhysics::pressureIndex

(

)

[virtual]

Component index within the primitive variables of the pressure.

Return the component index withn the primitive variables for the pressure. Used for slope flattening (slope computation).

Implements GodunovPhysics.

virtual Real PolytropicPhysics::smallPressure

(

)

[virtual]

Used to limit the absolute value of a "pressure" difference (away from zero).

Return a value that is used by slope flattening to limit (away from zero) the absolute value of a slope in the pressureIndex() component (slope computation).

Implements GodunovPhysics.

virtual int PolytropicPhysics::bulkModulusIndex

(

)

[virtual]

Component index within the primitive variables of the bulk modulus.

Return the component index withn the primitive variables for the bulk modulus. Used for slope flattening (slope computation) used as a normalization to measure shock strength.

Implements GodunovPhysics.

virtual void PolytropicPhysics::expressions

(

HDF5HeaderData &

a_holder

)

const [virtual]

Reimplemented from GodunovPhysics.

void PolytropicPhysics::operator=

(

const PolytropicPhysics &

)

[private]

---

Member Data Documentation

Real PolytropicPhysics::m_smallPressure [protected]

---

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

• PolytropicPhysics.H