CoordSys< T, Tface > Class Template Reference

#include <CoordSys.H>

Inheritance diagram for CoordSys< T, Tface >:

[legend]

List of all members.

---

Detailed Description

template<class T, class Tface>
class CoordSys< T, Tface >

Virtual base class encapsulating mapped-grid coordinate systems.

The CoordSys class is a virtual base class providing an API for performing operations in a mapped grid coordinate space. Implementations of specific coordinate systems will be provided by derived classes.

Public Member Functions
	CoordSys ()
	default constructor
virtual	~CoordSys ()
virtual void	define (const DisjointBoxLayout &a_grids, const ProblemDomain &a_domain, const RealVect &a_cellSpacing, const IntVect &a_ghostVect)=0
virtual void	regrid (const DisjointBoxLayout &a_newGrids)=0
virtual RealVect	realCoord (const RealVect &a_X) const =0
	given coordinate in mapped space, return its location in real space
virtual RealVect	mappedCoord (const RealVect &a_x) const =0
	given coordinate in real space, return its location in the mapped space
virtual void	realCoord (T &a_x, const T &a_X) const =0
	given coordinates in mapped space, return locations in real space
virtual void	mappedCoord (T &a_X, const T &a_x) const =0
	given coordinate in real space, return its location in the mapped space
virtual Real	pointwiseJ (const RealVect &a_X) const =0
	Jacobian evaluated at location X in real space.
virtual void	pointwiseJ (T &a_J, const T &a_Xi) const =0
	Jacobian evaluated at locations Xi in mapped space.
virtual void	mappedGridDivergence (LevelData< T > &a_divF, const LevelData< Tface > &a_F) const =0
	returns integral of divergence over mapped-grid cells
virtual const LevelData< Tface > &	getFaceMetricTerms () const =0
	reuturns reference to face-averaged N metric terms
virtual const LevelData< T > &	getCellVolumes () const =0
virtual const LevelData< T > &	getJ () const =0
	returns second-order averaged cell-centered J
virtual const LevelData< Tface > &	getJInverse () const =0
	returns averaged face-centered 1/J
virtual const LevelData< Tface > &	getNJinverse () const =0
	returns averaged face-centered N/J

---

Constructor & Destructor Documentation

template<class T, class Tface>

CoordSys< T, Tface >::CoordSys

(

)

[inline]

default constructor

template<class T, class Tface>

virtual CoordSys< T, Tface >::~CoordSys

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

template<class T, class Tface>

virtual void CoordSys< T, Tface >::define	(	const DisjointBoxLayout &	a_grids,
		const ProblemDomain &	a_domain,
		const RealVect &	a_cellSpacing,
		const IntVect &	a_ghostVect
	)			[pure virtual]

Implemented in CartesianCoordSys, and FourthOrderCoordSys.

template<class T, class Tface>

virtual void CoordSys< T, Tface >::regrid

(

const DisjointBoxLayout &

a_newGrids

)

[pure virtual]

Implemented in CartesianCoordSys, and FourthOrderCoordSys.

template<class T, class Tface>

virtual RealVect CoordSys< T, Tface >::realCoord

(

const RealVect &

a_X

)

const [pure virtual]

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

Implemented in CartesianCoordSys, and FourthOrderCoordSys.

template<class T, class Tface>

virtual RealVect CoordSys< T, Tface >::mappedCoord

(

const RealVect &

a_x

)

const [pure virtual]

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

Implemented in CartesianCoordSys, and FourthOrderCoordSys.

template<class T, class Tface>

virtual void CoordSys< T, Tface >::realCoord	(	T &	a_x,
		const T &	a_X
	)			const [pure virtual]

given coordinates in mapped space, return locations in real space

Implemented in FourthOrderCoordSys.

template<class T, class Tface>

virtual void CoordSys< T, Tface >::mappedCoord	(	T &	a_X,
		const T &	a_x
	)			const [pure virtual]

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

Implemented in FourthOrderCoordSys.

template<class T, class Tface>

virtual Real CoordSys< T, Tface >::pointwiseJ

(

const RealVect &

a_X

)

const [pure virtual]

Jacobian evaluated at location X in real space.

Implemented in CartesianCoordSys, and FourthOrderCoordSys.

template<class T, class Tface>

virtual void CoordSys< T, Tface >::pointwiseJ	(	T &	a_J,
		const T &	a_Xi
	)			const [pure virtual]

Jacobian evaluated at locations Xi in mapped space.

Implemented in FourthOrderCoordSys.

template<class T, class Tface>

virtual void CoordSys< T, Tface >::mappedGridDivergence	(	LevelData< T > &	a_divF,
		const LevelData< Tface > &	a_F
	)			const [pure virtual]

returns integral of divergence over mapped-grid cells

Implemented in CartesianCoordSys, and FourthOrderCoordSys.

template<class T, class Tface>

virtual const LevelData<Tface>& CoordSys< T, Tface >::getFaceMetricTerms

(

)

const [pure virtual]

reuturns reference to face-averaged N metric terms

Implemented in FourthOrderCoordSys.

template<class T, class Tface>

virtual const LevelData<T>& CoordSys< T, Tface >::getCellVolumes

(

)

const [pure virtual]

Implemented in FourthOrderCoordSys.

template<class T, class Tface>

virtual const LevelData<T>& CoordSys< T, Tface >::getJ

(

)

const [pure virtual]

returns second-order averaged cell-centered J

Implemented in FourthOrderCoordSys.

template<class T, class Tface>

virtual const LevelData<Tface>& CoordSys< T, Tface >::getJInverse

(

)

const [pure virtual]

returns averaged face-centered 1/J

Implemented in FourthOrderCoordSys.

template<class T, class Tface>

virtual const LevelData<Tface>& CoordSys< T, Tface >::getNJinverse

(

)

const [pure virtual]

returns averaged face-centered N/J

Implemented in FourthOrderCoordSys.

---

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

• CoordSys.H