Basic Cartesian Coordinates. More...

#include <CartesianCoordSys.H>

Inheritance diagram for CartesianCoordSys:

Public Member Functions
	CartesianCoordSys ()
	default constructor More...

virtual	~CartesianCoordSys ()

void	define (const DisjointBoxLayout &a_grids, const ProblemDomain &a_domain, const RealVect &a_cellSpacing, const IntVect &a_ghostVect)
	this define should probably be called from the derived-class define More...

void	stretch (const RealVect &a_stretch)

void	regrid (const DisjointBoxLayout &a_newGrids)

RealVect	realCoord (const RealVect &a_X) const
	given coordinate in mapped space, return its location in real space More...

RealVect	mappedCoord (const RealVect &a_x) const
	given coordinate in real space, return its location in the mapped space More...

Real	pointwiseJ (const RealVect &a_X) const
	Jacobian evaluated at location X in real space. More...

RealVect	stretch () const

void	mappedGridDivergence (LevelData< FArrayBox > &a_divF, const LevelData< FluxBox > &a_F) const
	returns integral of divergence over mapped-grid cells More...

virtual Real	dXdXi (const RealVect &a_X, int a_dirX, int a_dirXi) const
	note that a_X is in real (not mapped) space. More...

Public Member Functions inherited from FourthOrderCoordSys
	FourthOrderCoordSys ()
	default constructor More...

virtual	~FourthOrderCoordSys ()

virtual void	realCoord (FArrayBox &a_x, const FArrayBox &a_Xi) const
	given coordinates in mapped space, return locations in real space More...

virtual void	mappedCoord (FArrayBox &a_Xi, const FArrayBox &a_x) const
	given coordinate in real space, return its location in the mapped space More...

virtual void	pointwiseJ (FArrayBox &a_J) const
	Jacobian evaluated at index locations of a_J. More...

virtual void	pointwiseJ (FArrayBox &a_J, const FArrayBox &a_Xi) const
	Jacobian evaluated at locations Xi in mapped space. More...

virtual void	simpleDivergence (LevelData< FArrayBox > &a_divF, const LevelData< FluxBox > &a_F) const

virtual void	setQuadrature (const EdgeQuadrature *a_quadrature)

virtual const LevelData< FluxBox > &	getFaceMetricTerms () const
	reuturns reference to face-averaged N More...

virtual const LevelData< FluxBox > &	getTanGranNTerms () const
	returns reference to tangential gradients of N More...

virtual int	tanGradComp (const int a_faceDir, const int a_tanDir, const int a_comp) const

virtual const LevelData< FArrayBox > &	getCellVolumes () const

virtual const LevelData< FArrayBox > &	getJ () const
	returns fourth-order averaged cell-centered J More...

virtual const LevelData< FluxBox > &	getJInverse () const
	returns fourth-order averaged face-centered 1/J More...

virtual const LevelData< FluxBox > &	getNJinverse () const
	returns fourth-order averaged face-centered N/J More...

virtual void	computeTangentialGrad (LevelData< FluxBox > &a_gradPhi, const LevelData< FluxBox > &a_phiFace) const

virtual void	computeProductAverage (LevelData< FluxBox > &a_product, const LevelData< FluxBox > &a_F, const LevelData< FluxBox > &a_G, bool a_fourthOrder=true) const
	helper function More...

virtual void	computeMetricTermProductAverage (LevelData< FluxBox > &a_product, const LevelData< FluxBox > &a_F, bool a_fourthOrder=true) const
	computes 4th-order average of product = N^T*F More...

virtual void	dXdXi (FArrayBox &a_dxdXi, const FArrayBox &a_X, int a_destComp, int a_dirX, int a_dirXi) const
	note that a_X is in real (not mapped) space. More...

const RealVect &	dx () const
	access function to simplify things – returns mapped-space cell spacing More...

const ProblemDomain &	domain () const
	access function, returns mapped-space problem domain More...

const DisjointBoxLayout &	grids () const
	access function – returns const reference to grids More...

const IntVect &	ghostVect () const
	access function – returns const reference to number of ghost cells More...

Public Member Functions inherited from CoordSys< FArrayBox, FluxBox >
	CoordSys ()
	default constructor More...

virtual	~CoordSys ()

Protected Attributes
Vector< LevelData< FluxBox > *>	m_dNdXi

RealVect	m_stretch

bool	m_isDefined

Protected Attributes inherited from FourthOrderCoordSys
DisjointBoxLayout	m_grids

RealVect	m_dx

ProblemDomain	m_domain

IntVect	m_ghostVect

LevelData< FluxBox >	m_faceMetricTerms

LevelData< FluxBox >	m_tanGradNTerms

LevelData< FArrayBox >	m_cellVolumes

LevelData< FArrayBox >	m_J

LevelData< FluxBox >	m_JInverse

LevelData< FluxBox >	m_NinverseJ

EdgeQuadrature *	m_quadraturePtr

Additional Inherited Members
Static Public Member Functions inherited from FourthOrderCoordSys
static int	getMetricTermComponent (const int a_row, const int a_col)
	index function into face-centered metric terms More...

Public Attributes inherited from FourthOrderCoordSys
Interval	m_volInterval
	which component directions to use when computing cell volumes More...

Protected Member Functions inherited from FourthOrderCoordSys
virtual Real	getN (const RealVect &a_X, int a_s, int a_d, int a_d1) const
	note that a_X is in real (not mapped) space. More...

virtual Real	getNMatrixEntry (const RealVect &a_X, int a_s, int a_d, int a_d1, int a_row, int a_column) const
	note that a_X is in real (not mapped) space. More...

virtual void	defineFaceMetricTerms (LevelData< FluxBox > &a_faceMetricTerms)

virtual void	incrementFaceMetricWithEdgeTerm (FArrayBox &a_faceMetrics, int a_faceDir, int a_edgeDir, const Side::LoHiSide &a_side)

virtual void	computeTransverseFaceMetric (FArrayBox &a_faceMetrics, int a_faceDir, int a_dDir)

virtual void	computeCellVolumes (LevelData< FArrayBox > &a_cellVolumes)

virtual void	computeJ (LevelData< FArrayBox > &a_J)

virtual void	computeJinverse (LevelData< FluxBox > &a_Jinverse)

virtual void	computeNJinverse (LevelData< FluxBox > &a_NJinverse)

Detailed Description

Basic Cartesian Coordinates.

The CartesianCoordSys class implements the FourthOrderCoordSys class for simple Cartesian coordinates

Constructor & Destructor Documentation

◆ CartesianCoordSys()

CartesianCoordSys::CartesianCoordSys ( )

inline

default constructor

References define(), m_isDefined, and ~CartesianCoordSys().

◆ ~CartesianCoordSys()

virtual CartesianCoordSys::~CartesianCoordSys ( )

virtual

Destructor.

Referenced by CartesianCoordSys().

Member Function Documentation

◆ define()

void CartesianCoordSys::define	(	const DisjointBoxLayout &	a_grids,
		const ProblemDomain &	a_domain,
		const RealVect &	a_cellSpacing,
		const IntVect &	a_ghostVect
	)

virtual

this define should probably be called from the derived-class define

Reimplemented from FourthOrderCoordSys.

Referenced by CartesianCoordSys().

◆ stretch() [1/2]

void CartesianCoordSys::stretch ( const RealVect & a_stretch )

inline

References m_stretch, mappedCoord(), pointwiseJ(), realCoord(), and regrid().

◆ regrid()

void CartesianCoordSys::regrid ( const DisjointBoxLayout & a_newGrids )

virtual

Implements FourthOrderCoordSys.

Referenced by stretch().

◆ realCoord()

RealVect CartesianCoordSys::realCoord ( const RealVect & a_X ) const

virtual

given coordinate in mapped space, return its location in real space

Implements FourthOrderCoordSys.

Referenced by stretch().

◆ mappedCoord()

RealVect CartesianCoordSys::mappedCoord ( const RealVect & a_x ) const

virtual

given coordinate in real space, return its location in the mapped space

Implements FourthOrderCoordSys.

Referenced by stretch().

◆ pointwiseJ()

Real CartesianCoordSys::pointwiseJ ( const RealVect & a_X ) const

virtual

Jacobian evaluated at location X in real space.

Reimplemented from FourthOrderCoordSys.

Referenced by stretch().

◆ stretch() [2/2]

RealVect CartesianCoordSys::stretch ( ) const

inline

References dXdXi(), m_stretch, and mappedGridDivergence().

◆ mappedGridDivergence()

void CartesianCoordSys::mappedGridDivergence	(	LevelData< FArrayBox > &	a_divF,
		const LevelData< FluxBox > &	a_F
	)		const

virtual

returns integral of divergence over mapped-grid cells

Reimplemented from FourthOrderCoordSys.

Referenced by stretch().

◆ dXdXi()

virtual Real CartesianCoordSys::dXdXi	(	const RealVect &	a_X,
		int	a_dirX,
		int	a_dirXi
	)		const

virtual

note that a_X is in real (not mapped) space.

Implements FourthOrderCoordSys.

Referenced by stretch().

Member Data Documentation

◆ m_dNdXi

Vector<LevelData<FluxBox>* > CartesianCoordSys::m_dNdXi

protected

◆ m_stretch

RealVect CartesianCoordSys::m_stretch

protected

Referenced by stretch().

◆ m_isDefined

bool CartesianCoordSys::m_isDefined

protected

Referenced by CartesianCoordSys().

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

CartesianCoordSys.H

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CartesianCoordSys()

◆ ~CartesianCoordSys()

Member Function Documentation

◆ define()

◆ stretch() [1/2]

◆ regrid()

◆ realCoord()

◆ mappedCoord()

◆ pointwiseJ()

◆ stretch() [2/2]

◆ mappedGridDivergence()

◆ dXdXi()

Member Data Documentation

◆ m_dNdXi

◆ m_stretch

◆ m_isDefined