Muscl Class Reference
[Conservation Law Equations]

#include <Muscl.h>

Inheritance diagram for Muscl:

List of all members.

---

Detailed Description

Parent class for hyperbolic solvers with Muscl scheme.

Everything in here are common for both 2D and 3D muscl methods ! Virtual functions are implemented in Muscl2D and Muscl3D classes

Public Types
enum	Limiter {   MINMOD_LIMITER = 0,   SUPERBEE_LIMITER = 2,   VANLEER_LIMITER = 1,   VANALBADA_LIMITER = 3,   MAX_LIMITER = 4,   L_FORCE_WORD = 0xFFFFFFFF }
enum	Method {   FIRST_ORDER_METHOD = 0,   MULTI_SLOPE_M_METHOD = 2,   MULTI_SLOPE_Q_METHOD = 1,   M_FORCE_WORD = 0xFFFFFFFF }
Public Member Functions
double	getCFL () const
	Return CFL value.
Mesh &	getMesh () const
	Return reference to Mesh instance.
double	getReferenceLength () const
	Return reference length.
double	getTimeStep () const
	Return time step value.
	Muscl (Mesh &m)
	Constructor using mesh instance.
void	setCFL (double CFL)
	Assign CFL value.
void	setLimiter (Limiter l)
	Choose a flux limiter.
void	setMethod (const Method &s)
	Choose a flux solver.
bool	setReconstruction (const ElementVect< double > &U, SideVect< double > &GU, SideVect< double > &DU, int dof)
	Function to reconstruct by the Muscl method.
void	setReferenceLength (double dx)
	Assign reference length value.
void	setTimeStep (double dt)
	Assign time step value.
void	setVerbose (int v)
	Set verbosity parameter.
virtual	~Muscl ()
	Destructor.

---

Member Enumeration Documentation

enum Limiter

Enumerator:

MINMOD_LIMITER	MinMod limiter
SUPERBEE_LIMITER	Superbee limiter
VANLEER_LIMITER	Van Leer limiter
VANALBADA_LIMITER	Van Albada limiter
MAX_LIMITER	Max limiter
L_FORCE_WORD	for compatibity reason, gcc may return a warning anyway

enum Method

Enumerator:

FIRST_ORDER_METHOD	First Order upwind method
MULTI_SLOPE_M_METHOD	Multislope M method
MULTI_SLOPE_Q_METHOD	Multislope Q method
M_FORCE_WORD	for compatibity reasons, gcc may return a warning anyway

---

Member Function Documentation

void setCFL

(

double

CFL

)

Assign CFL value.

Parameters:

CFL

[in] Value of CFL

void setLimiter

(

Limiter

l

)

Choose a flux limiter.

Parameters:

[in]

l

Limiter to choose

void setMethod

(

const Method &

s

)

Choose a flux solver.

Parameters:

[in]

s

Solver to choose

bool setReconstruction	(	const ElementVect< double > &	U,
		SideVect< double > &	GU,
		SideVect< double > &	DU,
		int	dof
	)

Function to reconstruct by the Muscl method.

Parameters:

[in]	U	Field to reconstruct
[out]	GU	Left gradient vector
[out]	DU	Right gradient vector
[in]	dof	Label of dof to reconstruct

void setReferenceLength

(

double

dx

)

Assign reference length value.

Parameters:

dx

[in] Value of reference length

Reimplemented in LCL1D, and LCL3DT.

void setTimeStep

(

double

dt

)

Assign time step value.

Parameters:

dt

[in] Time step value

void setVerbose

(

int

v

)

Set verbosity parameter.

Parameters:

[in]

v

Value of verbosity parameter