An object Cell contains all the informations of a cell for both multiresolution and finite volume computations. More...

#include <Cell.h>

Collaboration diagram for Cell:

Public Member Functions
	Cell ()
	Cell constructor. More...

	~Cell ()
	Cell distructor. More...

void	operator= (const Cell &C)
	Defines the cell operators. It is possible to obtain the cell values as: More...

void	setSize (const int AxisNo, const real UserSize)
	Sets the size of the cell in the direction AxisNo to UserSize. Example: More...

void	setSize (const Vector &UserSize)
	Sets the size of the cell in every direction to the vector UserSize . Example: More...

void	setCenter (const int AxisNo, const real UserX)
	Sets the coordinate of the cell-center in the direction AxisNo to UserX. Example: More...

void	setCenter (const Vector &UserX)
	Sets the position of the cell-center to the vector UserX. Example: More...

void	setAverage (const int QuantityNo, const real UserAverage)
	Sets the cell-average of the quantity QuantityNo to UserAverage. Example: More...

void	setAverage (const Vector &UserAverage)
	Sets all the cell-average quantities to the vector UserAverage. Example: More...

void	setAverageZero ()
	Sets all the cell-average values to zero. More...

void	setTempAverage (const int QuantityNo, const real UserAverage)
	Identical to setAverage (int QuantityNo, real UserAverage), but for the vector of the temporary cell-average values. More...

void	setTempAverage (const Vector &UserAverage)
	Identical to void setAverage (const Vector& UserAverage), but for the vector of the temporary cell-average values. More...

void	setTempAverageZero ()
	Sets all the temmporary cell-average values to zero. More...

void	setLowAverage (const int QuantityNo, const real UserAverage)
	Identical to setAverage (int QuantityNo, real UserAverage), but for the vector of the cell-average values with low precision in the Runge-Kutta-Fehlberg method. More...

void	setLowAverage (const Vector &UserAverage)
	Identical to void setAverage (const Vector& UserAverage), void setAverage (const Vector& UserAverage), but for the vector of the cell-average values with low precision in the Runge-Kutta-Fehlberg method. More...

void	setOldAverage (const int QuantityNo, const real UserAverage)
	Identical to setAverage (int QuantityNo, real UserAverage), but for the vector of the old cell-average values. More...

void	setOldAverage (const Vector &UserAverage)
	Identical to void setAverage (const Vector& UserAverage), but for the vector of the cell-average values. More...

void	setDivergence (const int QuantityNo, const real UserAverage)
	Identical to void setAverage (int QuantityNo, real UserAverage), but for the divergence vector. More...

void	setDivergence (const Vector &UserAverage)
	Identical to void setAverage (const Vector& UserAverage), but for the divergence vector. More...

void	setPsiGrad (const int Dimension, const real UserAverage)
	Identical to void setAverage (int QuantityNo, real UserAverage), but for the gradient of psi vector. More...

void	setPsiGrad (const Vector &UserAverage)
	Identical to void setAverage (int QuantityNo, real UserAverage), but for the gradient of psi vector. More...

void	setRes (const real UserAverage)
	Set resistivity. More...

void	setDivergenceZero ()
	Sets all the components of the divergence vector to zero. More...

void	setGradient (const int i, const int j, const real UserAverage)
	Sets the component no. i, j of the quantity gradient to UserAverage. More...

void	setTempGradient (const int i, const int j, const real UserAverage)
	Identical to the previous one for the temporary values. Does not work for MHD! More...

void	setGradient (const Matrix &UserAverage)
	Sets the quantity gradient to the matrix UserAverage. Does not work for MHD! Example: More...

void	setTempGradient (const Matrix &UserAverage)
	dentical to the previous one for the temporary values. More...

void	setGradientZero ()
	Sets all the components of the velocity gradient to zero. More...

bool	isInsideBoundary () const
	Returns true if the cell is inside the boundary. More...

bool	isInFluid () const
	Returns true if the cell is inside the fluid. More...

real	size (const int AxisNo) const
	Returns the cell size in the direction AxisNo. More...

Vector	size () const
	Returns the vector cointaining the cell size in every direction. More...

real	center (const int AxisNo) const
	Returns the component no. AxisNo of the cell-center position. More...

Vector	center () const
	Returns the cell-center position vector. More...

real	average (const int QuantityNo) const
	Returns the component no. QuantityNo of the cell-average value. More...

Vector	average () const
	Returns the cell-average value vector. More...

real	tempAverage (const int QuantityNo) const
	Returns the component no. QuantityNo of the temporary cell-average value. More...

Vector	tempAverage () const
	Returns the temporary cell-average value vector. More...

real	lowAverage (const int QuantityNo) const
	Returns the component no. QuantityNo of the cell-average value with low precision in the Runge-Kutta-Fehlberg method. More...

Vector	lowAverage () const
	Returns the cell-average vector with low precision in the Runge-Kutta-Fehlberg method. More...

real	oldAverage (const int QuantityNo) const
	Returns the component no. QuantityNo of the old cell-average values. More...

Vector	oldAverage () const
	Returns the old cell-average values. More...

real	divergence (const int QuantityNo) const
	Returns the component no. QuantityNo of the divergence vector. More...

Vector	divergence () const
	Returns the divergence vector. More...

real	PsiGrad (const int Dimension) const
	Returns the component of PsiGrad vector. More...

Vector	PsiGrad () const
	Returns the PsiGrad vector. More...

real	gradient (const int i, const int j) const
	Returns the component no. i, j of the velocity gradient. Does not work for MHD! More...

real	tempGradient (const int i, const int j) const
	Identical to the previous one for the temporary values. More...

Matrix	gradient () const
	Returns the velocity gradient in matrix form. More...

Matrix	tempGradient () const
	Identical to the previous one for the temporary values. More...

real	density () const
	Returns the cell-average density. More...

real	tempDensity () const
	Identical to the previous one for the temporary values. More...

real	psi () const
	Returns the cell-average density. More...

real	tempPsi () const
	Identical to the previous one for the temporary values. More...

real	etaConst () const
	Returns the cell-average resistivity. More...

real	pressure () const
	Returns the cell-average pressure. More...

real	tempPressure () const
	Identical to the previous one for the temporary values. More...

real	oldPressure () const
	Identical to the previous one for the values at the instant n-1. More...

real	temperature () const
	Returns the cell-average temperature. Does not work for MHD! More...

real	tempTemperature () const
	Identical to the previous one for the temporary values. Does not work for MHD! More...

real	concentration () const
	Returns the cell-average concentration of the limiting reactant. Does not work for MHD! More...

real	energy () const
	Returns the cell-average energy per unit of volume. More...

real	tempEnergy () const
	Identical to the previous one for the temporary values. More...

real	magField (const int AxisNo) const
	Returns the component no. AxisNo of the cell-average magnetic field. More...

real	tempMagField (const int AxisNo) const
	Identical to the previous one for the temporary values. More...

Vector	magField () const
	Returns the cell-average magnetic field vector. More...

Vector	tempMagField () const
	Identical to the previous one for the temporary values. More...

real	velocity (const int AxisNo) const
	Returns the component no. AxisNo of the cell-average velocity. More...

real	tempVelocity (const int AxisNo) const
	Identical to the previous one for the temporary values. More...

Vector	velocity () const
	Returns the cell-average velocity vector. More...

Vector	tempVelocity () const
	Identical to the previous one for the temporary values. More...

real	speedOfSound () const
	Returns the cell-average speed of sound. More...

real	entropy () const
	Returns the entropy (p/rho^Gamma). Does not work for MHD! More...

real	fastSpeed (const int AxisNo) const
	Returns the fast speed vector. More...

real	volume () const
	Returns the volume of the cell (length in 1D, area in 2D, volume in 3D). More...

bool	isOverflow () const
	Return true if one of the cell-average quantities is greater than the maximum. This usually means the computation is numerically unstable. More...

Public Attributes
Vector	X

Vector	dX

Vector	Q

Vector	Qs

Vector	Qlow

Vector	Qold

Vector	D

real	Res

Vector	PGrad

Matrix	Grad

Matrix	Grads

Detailed Description

An object Cell contains all the informations of a cell for both multiresolution and finite volume computations.

Constructor & Destructor Documentation

Cell::Cell ( )

Cell constructor.

             :
     X(Dimension),
     dX(Dimension),
     Q(QuantityNb),
     Qs(QuantityNb),
     Qlow(((!ConstantTimeStep && StepNb > 2) || TimeAdaptivity)? QuantityNb:0),
     Qold((UseBoundaryRegions)? QuantityNb:0),
     D(QuantityNb),
     Res(),
     PGrad(Dimension),
     Grad(((EquationType==6))? Dimension:0, ((EquationType==6))? QuantityNb:0),
     Grads(((EquationType==6) && SchemeNb > 5)? Dimension:0, ((EquationType==6) && SchemeNb > 5)? QuantityNb:0)
 {
     // Empty constructor
     ;
 }

Cell::~Cell ( )

Cell distructor.

 {
     // Empty distructor
 }

Member Function Documentation

real Cell::average ( const int QuantityNo ) const

inline

Returns the component no. QuantityNo of the cell-average value.

Parameters

QuantityNo Number of MHD variables = 9.

Returns: real

 {
     return Q.value(QuantityNo);
 }

Here is the caller graph for this function:

Vector Cell::average ( ) const

inline

Returns the cell-average value vector.

Returns: Vector

 {
     return Q;
 }

Here is the caller graph for this function:

real Cell::center ( const int AxisNo ) const

inline

Returns the component no. AxisNo of the cell-center position.

Parameters

AxisNo Space direction the function is computed.

Returns: real

 {
     return X.value(AxisNo);
 }

Here is the caller graph for this function:

Vector Cell::center ( ) const

inline

Returns the cell-center position vector.

Returns: Vector

 {
     return X;
 }

Here is the caller graph for this function:

real Cell::concentration ( ) const

inline

Returns the cell-average concentration of the limiting reactant. Does not work for MHD!

Returns: real

 {
     // Warning: only for flame ball, flame front and flame-vortex equations
 
     return  Q.value(2);
 }

real Cell::density ( ) const

inline

Returns the cell-average density.

Returns: real

 {
     return  Q.value(1);
 }

Here is the caller graph for this function:

real Cell::divergence ( const int QuantityNo ) const

inline

Returns the component no. QuantityNo of the divergence vector.

Parameters

QuantityNo Number of MHD variables = 9.

Returns: real

 {
     return D.value(QuantityNo);
 }

Here is the caller graph for this function:

Vector Cell::divergence ( ) const

inline

Returns the divergence vector.

Returns: Vector

 {
     return D;
 }

real Cell::energy ( ) const

inline

Returns the cell-average energy per unit of volume.

Returns: real

 {
     return  Q.value(5);
 }

Here is the caller graph for this function:

real Cell::entropy ( ) const

inline

Returns the entropy (p/rho^Gamma). Does not work for MHD!

Returns: real

 {
     return pressure()*exp(-Gamma*log(density()));
 }

real Cell::etaConst ( ) const

inline

Returns the cell-average resistivity.

Returns: real

 {
     return  Res;
 }

real Cell::fastSpeed ( const int AxisNo ) const

Returns the fast speed vector.

Computes the fast magnetoacoustic wave at each direction.

Parameters

AxisNo

Returns: real

Parameters

AxisNo Number of axis of interest. 1: x-direction, 2: y-direction, 3: z-direction.

Returns: double

 {
     real result;
     real a = Gamma*pressure()/density();
     real b = (magField()*magField())/density();
     real bk= (magField(AxisNo)*magField(AxisNo))/density();
 
 
     result = sqrt(.5*(a+b+sqrt((a+b)*(a+b) - 4.0*a*bk)));
 
     return result;
 }

Here is the caller graph for this function:

real Cell::gradient	(	const int	i,
		const int	j
	)		const

inline

Returns the component no. i, j of the velocity gradient. Does not work for MHD!

Parameters

i
j

Returns: real

 {
     return Grad.value(i,j);
 }

Here is the caller graph for this function:

Matrix Cell::gradient ( ) const

inline

Returns the velocity gradient in matrix form.

Returns: Matrix

 {
     return Grad;
 }

bool Cell::isInFluid ( ) const

Returns true if the cell is inside the fluid.

Returns: bool

brief Returns true if the cell is inside the boundary

return bool

 {
     return (!isInsideBoundary());
 }

bool Cell::isInsideBoundary ( ) const

Returns true if the cell is inside the boundary.

Returns: bool

 {
     int ei = 1;
     int ej = (Dimension > 1) ? 1:0;
     int ek = (Dimension > 2) ? 1:0;
 
     int i, j, k;
 
     Vector Edge(Dimension);
 
     bool result=false;
 
     // Loop: if one edge of the cell is in the boundary, return true
     for (i=-ei; i <= ei; i+=2)
     for (j=-ej; j <= ej; j+=2)
     for (k=-ek; k <= ek; k+=2)
     {
         Edge.setValue(1,center(1) + i*0.5*size(1));
 
         if (Dimension > 1)
             Edge.setValue(2,center(2) + j*0.5*size(2));
         if (Dimension > 2)
             Edge.setValue(3,center(3) + k*0.5*size(3));
 
         if (BoundaryRegion(Edge) != 0) result = true;
     }
 
     return result;
 
 }

Here is the caller graph for this function:

bool Cell::isOverflow ( ) const

Return true if one of the cell-average quantities is greater than the maximum. This usually means the computation is numerically unstable.

Returns: bool

 {
     // --- Local variables ---
 
     int n;                  // Counter on the quantities
 
     // --- If one of the values is overflow, return true ---
 
     for (n = 1; n <= QuantityNb; n++)
         if (average().isNaN()) return true;
 
     return false;
 }

Here is the caller graph for this function:

real Cell::lowAverage ( const int QuantityNo ) const

inline

Returns the component no. QuantityNo of the cell-average value with low precision in the Runge-Kutta-Fehlberg method.

Parameters

QuantityNo Number of MHD variables = 9.

Returns: real

 {
     return Qlow.value(QuantityNo);
 }

Here is the caller graph for this function:

Vector Cell::lowAverage ( ) const

inline

Returns the cell-average vector with low precision in the Runge-Kutta-Fehlberg method.

Returns: Vector

 {
     return Qlow;
 }

real Cell::magField ( const int AxisNo ) const

inline

Returns the component no. AxisNo of the cell-average magnetic field.

Parameters

AxisNo

Returns: real

 {
     return  Q.value(6+AxisNo);
 }

Here is the caller graph for this function:

Vector Cell::magField ( ) const

Returns the cell-average magnetic field vector.

Computes the magnetic field. Allocates the magnetic field initial condition Q[i+6] to its components.

Returns: Vector

 {
 
     // Local variables
     Vector B(3);
     int i;
 
     for (i=1; i<=3; i++)
         B.setValue(i,Q.value(i+6));
 
     return  B;
 }

Here is the caller graph for this function:

real Cell::oldAverage ( const int QuantityNo ) const

inline

Returns the component no. QuantityNo of the old cell-average values.

Parameters

QuantityNo Number of MHD variables = 9.

Returns: real

 {
     return Qold.value(QuantityNo);
 }

Here is the caller graph for this function:

Vector Cell::oldAverage ( ) const

inline

Returns the old cell-average values.

Returns: Vector

 {
     return Qold;
 }

real Cell::oldPressure ( ) const

Identical to the previous one for the values at the instant n-1.

Computes the pressure of the fluid at the instant n-1. This value is useful for time integration computations.

Returns: real; double

 {
     // Conservative quantities;
 
     real rho, rhoE;
     Vector rhoV(3), B(3);
 
     // Get conservative quantities
 
         rho = Qold.value(1);
 
     for (int i=1 ; i<=3 ; i++){
         rhoV.setValue(i,Qold.value(i+1));
         B.setValue(i, Qold.value(i+6));
     }
     rhoE = Qold.value(5);
 
     // Return pressure
 
     return (Gamma-1.)*(rhoE - .5*(rhoV*rhoV)/rho -.5*(B*B));
 
 }

Here is the caller graph for this function:

void Cell::operator= ( const Cell & C )

Defines the cell operators. It is possible to obtain the cell values as:

Center coordinates
Size
Average
Temporary average
Divergence
Gradient of Psi

Parameters

C	Cell of interest

Returns: void

 {
     // local cell becomes equal to cell C
 
     setCenter(C.center());
     setSize(C.size());
     setAverage(C.average());
     setTempAverage(C.tempAverage());
     setDivergence(C.divergence());
         setPsiGrad(C.PsiGrad());
 
     return;
     
 }

real Cell::pressure ( ) const

Returns the cell-average pressure.

Computes the pressure of the fluid. The pressure is computed in terms of the energy density, velocity and magnetic field. It is given by (Gamma-1.)*(rhoE - .5*(rhoV*rhoV)/rho - .5*(B*B)); return double.

Returns: real

 {
     // Conservative quantities;
 
     real rho, rhoE;
     Vector rhoV(3), B(3);
 
     // Get conservative quantities
 
         rho = Q.value(1);
 
     for (int i=1 ; i<=3; i++){
       B.setValue(i, Q.value(i+6));
       rhoV.setValue(i,Q.value(i+1));
     }
     rhoE = Q.value(5);
 
     // Return pressure
 
     return (Gamma-1.)*(rhoE - .5*(rhoV*rhoV)/rho - .5*(B*B));
 
 
 }

Here is the caller graph for this function:

real Cell::psi ( ) const

inline

Returns the cell-average density.

Returns: real

 {
     return  Q.value(6);
 }

Here is the caller graph for this function:

real Cell::PsiGrad ( const int Dimension ) const

inline

Returns the component of PsiGrad vector.

Parameters

Dimension

Returns: real

 {
     return PGrad.value(Dimension);
 }

Here is the caller graph for this function:

Vector Cell::PsiGrad ( ) const

inline

Returns the PsiGrad vector.

Returns: Vector

 {
     return PGrad;
 }

void Cell::setAverage	(	const int	QuantityNo,
		const real	UserAverage
	)

inline

Sets the cell-average of the quantity QuantityNo to UserAverage. Example:

#include "Carmen.h"

QuantityNb = 2; real T=0.,Y=1.; Cell c; c.setAverage(1,T); c.setAverage(2,Y);


Parameters

  
    QuantityNo Number of MHD variables 
    UserAverage Average value 
  
  

Returns
void

 {
     Q.setValue(QuantityNo, UserAverage);
 }

Here is the caller graph for this function:

void Cell::setAverage ( const Vector & UserAverage )

inline

Sets all the cell-average quantities to the vector UserAverage. Example:

#include "Carmen.h"

QuantityNb = 2; Vector Q(1.,0.); Cell c; c.setAverage(Q);


Parameters

  
    UserAverage Average value 
  
  

Returns
void

 {
     Q = UserAverage;
 }

void Cell::setAverageZero ( )

inline

Sets all the cell-average values to zero.

Returns: void

 {
     Q.setZero();
 }

Here is the caller graph for this function:

void Cell::setCenter	(	const int	AxisNo,
		const real	UserX
	)

inline

Sets the coordinate of the cell-center in the direction AxisNo to UserX. Example:

#include "Carmen.h"

Dimension = 3; real x=1., y=0., z=0.; Cell c; c.setCenter(1,x); c.setCenter(2,y); c.setCenter(3,z);


Parameters

  
    AxisNo Number of axis of interest. 1: x-direction, 2: y-direction, 3: z-direction. 
    UserX Center of the cell. 
  
  

Returns
void

 {
     X.setValue(AxisNo, UserX);
 }

Here is the caller graph for this function:

void Cell::setCenter ( const Vector & UserX )

inline

Sets the position of the cell-center to the vector UserX. Example:

#include "Carmen.h"

Dimension = 3; Vector V(1.,0.,0.); Cell c; c.setCenter(V);


Parameters

  
    UserX Center of the cell. 
  
  

Returns
void

 {
     X = UserX;
 }

void Cell::setDivergence	(	const int	QuantityNo,
		const real	UserAverage
	)

inline

Identical to void setAverage (int QuantityNo, real UserAverage), but for the divergence vector.

Parameters

QuantityNo	Number of MHD variables
UserAverage	Divergence values

Returns: void

 {
     D.setValue(QuantityNo, UserAverage);
 }

Here is the caller graph for this function:

void Cell::setDivergence ( const Vector & UserAverage )

inline

Identical to void setAverage (const Vector& UserAverage), but for the divergence vector.

Parameters

UserAverage Divergence values

Returns: void

 {
     D = UserAverage;
 }

void Cell::setDivergenceZero ( )

inline

Sets all the components of the divergence vector to zero.

Returns: void

 {
     D.setZero();
 }

void Cell::setGradient	(	const int	i,
		const int	j,
		const real	UserAverage
	)

inline

Sets the component no. i, j of the quantity gradient to UserAverage.

Does not work for MHD!

Example:

#include "Carmen.h"

QuantityNb = 2; real Gxx=0., Gxy=1., Gyx=1., Gyy=0.; Cell c; c.setGradient(1,1,Gxx); c.setGradient(1,2,Gxy); c.setGradient(2,1,Gyx); c.setGradient(2,2,Gyy);


Parameters

  
    i 
    j 
    UserAverage Gradient value 
  
  

Returns
void

 {
     Grad.setValue(i, j, UserAverage);
 }

Here is the caller graph for this function:

void Cell::setGradient ( const Matrix & UserAverage )

inline

Sets the quantity gradient to the matrix UserAverage. Does not work for MHD! Example:

#include "Carmen.h"

QuantityNb = 5; Dimension = 3; Matrix G(3,5);



Cell c


...

 c.SetGradient(G);

 
Parameters

  
    UserAverage Gradient value 
  
  

Returns
void

 {
     Grad = UserAverage;
 }

void Cell::setGradientZero ( )

inline

Sets all the components of the velocity gradient to zero.

Returns: void

 {
     Grad.setZero();
 }

void Cell::setLowAverage	(	const int	QuantityNo,
		const real	UserAverage
	)

inline

Identical to setAverage (int QuantityNo, real UserAverage), but for the vector of the cell-average values with low precision in the Runge-Kutta-Fehlberg method.

Parameters

QuantityNo	Number of MHD variables
UserAverage	Average value

Returns: void

 {
     Qlow.setValue(QuantityNo, UserAverage);
 }

Here is the caller graph for this function:

void Cell::setLowAverage ( const Vector & UserAverage )

inline

Identical to void setAverage (const Vector& UserAverage), void setAverage (const Vector& UserAverage), but for the vector of the cell-average values with low precision in the Runge-Kutta-Fehlberg method.

Parameters

UserAverage Average value

Returns: void

 {
     Qlow = UserAverage;
 }

void Cell::setOldAverage	(	const int	QuantityNo,
		const real	UserAverage
	)

inline

Identical to setAverage (int QuantityNo, real UserAverage), but for the vector of the old cell-average values.

Parameters

QuantityNo	Number of MHD variables
UserAverage	Average value

Returns: void

 {
     Qold.setValue(QuantityNo, UserAverage);
 }

Here is the caller graph for this function:

void Cell::setOldAverage ( const Vector & UserAverage )

inline

Identical to void setAverage (const Vector& UserAverage), but for the vector of the cell-average values.

Parameters

UserAverage Average value

Returns: void

 {
     Qold = UserAverage;
 }

void Cell::setPsiGrad	(	const int	Dimension,
		const real	UserAverage
	)

inline

Identical to void setAverage (int QuantityNo, real UserAverage), but for the gradient of psi vector.

Parameters

Dimension	Dimension of the system
UserAverage	Gradient of psi value

Returns: void

 {
     PGrad.setValue(Dimension, UserAverage);
 }

Here is the caller graph for this function:

void Cell::setPsiGrad ( const Vector & UserAverage )

inline

Identical to void setAverage (int QuantityNo, real UserAverage), but for the gradient of psi vector.

Parameters

UserAverage Gradient of psi value

Returns: void

 {
     PGrad = UserAverage;
 }

void Cell::setRes ( const real UserAverage )

inline

Set resistivity.

Parameters

UserAverage Resistivity values

Returns: void

 {
     Res = UserAverage;
 }

Here is the caller graph for this function:

void Cell::setSize	(	const int	AxisNo,
		const real	UserSize
	)

inline

Sets the size of the cell in the direction AxisNo to UserSize. Example:

#include "Carmen.h"

Dimension = 2; real dx=1., dy=2.; Cell c; c.setSize(1, dx); c.setSize(2, dy);


Parameters

  
    AxisNo Number of axis of interest. 1: x-direction, 2: y-direction, 3: z-direction. 
    UserSize Size of the cell. 
  
  

Returns
void

 {
     dX.setValue(AxisNo, UserSize);
 }

Here is the caller graph for this function:

void Cell::setSize ( const Vector & UserSize )

inline

Sets the size of the cell in every direction to the vector UserSize . Example:

#include "Carmen.h"

Dimension = 2; Vector W(1.,2.); Cell c; c.setSize(W);


Parameters

  
    UserSize Size of the cell (vector) 
  
  

Returns
void

 {
     dX = UserSize;
 }

void Cell::setTempAverage	(	const int	QuantityNo,
		const real	UserAverage
	)

inline

Identical to setAverage (int QuantityNo, real UserAverage), but for the vector of the temporary cell-average values.

Parameters

QuantityNo	Number of MHD variables
UserAverage	Average value

Returns: void

 {
     Qs.setValue(QuantityNo, UserAverage);
 }

Here is the caller graph for this function:

void Cell::setTempAverage ( const Vector & UserAverage )

inline

Identical to void setAverage (const Vector& UserAverage), but for the vector of the temporary cell-average values.

Parameters

UserAverage Average value

Returns: void

 {
     Qs = UserAverage;
 }

void Cell::setTempAverageZero ( )

inline

Sets all the temmporary cell-average values to zero.

Returns: void

 {
     Qs.setZero();
 }

void Cell::setTempGradient	(	const int	i,
		const int	j,
		const real	UserAverage
	)

inline

Identical to the previous one for the temporary values. Does not work for MHD!

Parameters

i
j
UserAverage	Gradient value

Returns: void

 {
     Grads.setValue(i, j, UserAverage);
 }

Here is the caller graph for this function:

void Cell::setTempGradient ( const Matrix & UserAverage )

inline

dentical to the previous one for the temporary values.

Parameters

UserAverage Gradient value

Returns: void

 {
     Grads = UserAverage;
 }

real Cell::size ( const int AxisNo ) const

inline

Returns the cell size in the direction AxisNo.

Parameters

AxisNo Space direction the function is computed.

Returns: real

 {
     return dX.value(AxisNo);
 }

Here is the caller graph for this function:

Vector Cell::size ( ) const

inline

Returns the vector cointaining the cell size in every direction.

Returns: Vector

 {
     return dX;
 }

Here is the caller graph for this function:

real Cell::speedOfSound ( ) const

inline

Returns the cell-average speed of sound.

Returns: real

 {
     return sqrt(Gamma*pressure()/density());
 }

real Cell::tempAverage ( const int QuantityNo ) const

inline

Returns the component no. QuantityNo of the temporary cell-average value.

Parameters

QuantityNo Number of MHD variables = 9.

Returns: real

 {
     return Qs.value(QuantityNo);
 }

Here is the caller graph for this function:

Vector Cell::tempAverage ( ) const

inline

Returns the temporary cell-average value vector.

Returns: Vector

 {
     return Qs;
 }

real Cell::tempDensity ( ) const

inline

Identical to the previous one for the temporary values.

Returns: real

 {
     return  Qs.value(1);
 }

Here is the caller graph for this function:

real Cell::tempEnergy ( ) const

inline

Identical to the previous one for the temporary values.

Returns: real

 {
     return  Qs.value(5);
 }

real Cell::temperature ( ) const

Returns the cell-average temperature. Does not work for MHD!

Computes the temperature. Not useful for MHD computarions.

Returns: real; double

 {
 
     if(!ComputeTemp) exit(1);
     
    // Conservative quantities;
     real rho, p, T;
 
     // Get conservative quantities
     rho = density();
     p = pressure();
     T = p/rho;
 
     // Return temperature
 
     return T;
 }

Here is the caller graph for this function:

real Cell::tempGradient	(	const int	i,
		const int	j
	)		const

inline

Identical to the previous one for the temporary values.

Parameters

i
j

Returns: real

 {
     return Grads.value(i,j);
 }

Matrix Cell::tempGradient ( ) const

inline

Identical to the previous one for the temporary values.

Returns: Matrix

 {
     return Grads;
 }

real Cell::tempMagField ( const int AxisNo ) const

inline

Identical to the previous one for the temporary values.

Parameters

AxisNo

Returns: real

 {
     return  Qs.value(6+AxisNo);
 }

Vector Cell::tempMagField ( ) const

Identical to the previous one for the temporary values.

Computes temporary the magnetic field. This value is useful for time integration computations.

Returns: Vector

 {
 
     // Local variables
 
     Vector B(3);
     int i;
 
     for (i=1; i<=3; i++)
         B.setValue(i,Qs.value(i+6));
 
     return  B;
 }

real Cell::tempPressure ( ) const

Identical to the previous one for the temporary values.

Computes the temporary pressure of the fluid. This computation is needed for the Runge-Kutta time integration.

Returns: real; double

 {
     // Conservative quantities;
 
     real rho, rhoE;
     Vector rhoV(3), B(3);
 
     // Get conservative quantities
 
     rho = Qs.value(1);
 
     for (int i=1 ; i<=3 ; i++){
         rhoV.setValue(i,Qs.value(i+1));
             B.setValue(i, Qs.value(i+6));
     }
     
     rhoE = Qs.value(5);
 
     // Return pressure
 
     return (Gamma-1.)*(rhoE - .5*(rhoV*rhoV)/rho - .5*(B*B));
 
 }

Here is the caller graph for this function:

real Cell::tempPsi ( ) const

inline

Identical to the previous one for the temporary values.

Returns: real

 {
     return  Qs.value(6);
 }

real Cell::tempTemperature ( ) const

Identical to the previous one for the temporary values. Does not work for MHD!

Computes the temporary temperature. Not useful for MHD computarions.

Returns: real; double

 {
 
     if(!ComputeTemp) exit(1);
     
     // Conservative quantities;
     real rho, p, T;
     T = Qs.value(1);
 
     // Get conservative quantities
     rho = tempDensity();
     p = tempPressure();
     T = Gamma*Ma*Ma*p/rho;
 
 
     // Return temperature
 
     return T;
 }

real Cell::tempVelocity ( const int AxisNo ) const

inline

Identical to the previous one for the temporary values.

Parameters

AxisNo

Returns: real

 {
     return  Qs.value(1+AxisNo)/Qs.value(1);
 }

Vector Cell::tempVelocity ( ) const

Identical to the previous one for the temporary values.

Computes the temporary velocity of the fluid. This value is useful for time integration computations.

Returns: Vector

 {
 
     // Local variables
 
     Vector V(3);
     int i;
 
     for (i=1; i<=3; i++)
         V.setValue(i,Qs.value(i+1)/Qs.value(1));
 
     return  V;
 }

real Cell::velocity ( const int AxisNo ) const

inline

Returns the component no. AxisNo of the cell-average velocity.

Parameters

AxisNo

Returns: real

 {
     return  Q.value(1+AxisNo)/Q.value(1);
 }

Here is the caller graph for this function:

Vector Cell::velocity ( ) const

Returns the cell-average velocity vector.

Computes the velocity of the fluid. Allocates the velocity initial condition Q[i+6] to its components.

Returns: Vector

 {
 
     // Local variables
 
     Vector V(3);
     int i;
 
     for (i=1; i<=3; i++)
         V.setValue(i,Q.value(i+1)/Q.value(1));
 
     return  V;
 }

real Cell::volume ( ) const

Returns the volume of the cell (length in 1D, area in 2D, volume in 3D).

Computes the volume of a cell.

Returns: real; double

 {
     int AxisNo = 1;
     real result = 1.;
 
     for (AxisNo = 1; AxisNo <= Dimension; AxisNo++)
         result *= size(AxisNo);
 
     return result;
 
 }

Member Data Documentation

Vector Cell::D

Divergence vector. Its dimension is QuantityNb.

Vector Cell::dX

Cell size in each direction. Its dimension is Dimension.

Matrix Cell::Grad

Quantity gradient. Only necessary for a Navier-Stokes computation. Not working!

Matrix Cell::Grads

Temporary quantity gradient. Only necessary for a Navier-Stokes computation. Not working!

Vector Cell::PGrad

Gradient of psi scalar function. Its dimension is Dimension.

Vector Cell::Q

Vector containing the cell-average values. Its dimension is QuantityNb.

Vector Cell::Qlow

This vector is used to store the cell-averages computed with the N-stage Runge-Kutta-Fehlberg N(N+1) method.

Vector Cell::Qold

Cell-average values at the instant n-1.

Vector Cell::Qs

Temporary cell-average values. This vector is used to store the intermediary value in a multi-step Runge-Kutta or McCormack time integration.

real Cell::Res

Resistivity scalar function.

Vector Cell::X

Position of the cell center. Its dimension is Dimension.

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

AxisNo	Number of axis of interest. 1: x-direction, 2: y-direction, 3: z-direction.
UserX	Center of the cell.

AxisNo	Number of axis of interest. 1: x-direction, 2: y-direction, 3: z-direction.
UserSize	Size of the cell.

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation