EdgeDataBox Class Reference

#include <EdgeDataBox.H>

List of all members.

---

Detailed Description

A FArrayBox-like container for edge-centered fluxes.

This is a class to contain edge-centered fluxes on a box.

Public Member Functions
	EdgeDataBox ()
	default constructor
	EdgeDataBox (const Box &bx, int n=1)
	constructs EdgeDataBox on cell-centered box with n components
	~EdgeDataBox ()
	destructor
void	define (const Box &bx, int n=1)
	resize EdgeDataBox similar to BaseFab::resize()
void	clear ()
	this function returns the EdgeDataBox to the undefined state
int	nComp () const
	{ access functions}
const Box &	box () const
	returns cell-centered box which defines EdgeDataBox
FArrayBox &	getData (const int dir)
	returns edge-centered data in direction dir
const FArrayBox &	getData (const int dir) const
FArrayBox &	operator[] (const int dir)
	returns FArrayBox in direction dir
const FArrayBox &	operator[] (const int dir) const
	constant version
void	setVal (const Real val)
void	setVal (const Real val, const int dir)
	set fluxes in direction dir to val
void	setVal (const Real val, const int dir, const int startComp, const int nComp)
	more specific setVal
void	setVal (const Real val, const Box &bx)
	sets fluxes on edges surrounding cell-centered box bx
void	setVal (const Real val, const Box &bx, const int dir, const int startComp, const int nComp)
void	copy (const EdgeDataBox &src)
	copy from src to this EdgeDataBox -- sizes must be identical
void	copy (const EdgeDataBox &src, const int srcComp, const int destComp, const int numComp)
	copy on overlap, for all directions
void	copy (const EdgeDataBox &src, const int dir, const int srcComp, const int destComp, const int numComp)
	copy on overlap of EdgeDataBoxes, in direction dir
void	copy (const Box &RegionFrom, const Interval &Cdest, const Box &RegionTo, const EdgeDataBox &src, const Interval &Csrc)
size_t	size (const Box &bx, const Interval &comps) const
	{ Linearization Functions}
void	linearOut (void *buf, const Box &R, const Interval &comps) const
void	linearIn (void *buf)
void	linearIn (void *buf, const Box &R, const Interval &comps)
Static Public Member Functions
static bool	preAllocatable ()
Protected Attributes
Box	m_bx
int	m_nvar
Vector< FArrayBox * >	m_data
	BL_SPACEDIM FArrayBoxes which hold fluxes.
Private Member Functions
	EdgeDataBox (const EdgeDataBox &)
	these are disallowed
EdgeDataBox &	operator= (const EdgeDataBox &)

---

Constructor & Destructor Documentation

EdgeDataBox::EdgeDataBox

(

)

default constructor

EdgeDataBox::EdgeDataBox	(	const Box &	bx,
		int	n = 1
	)

constructs EdgeDataBox on cell-centered box with n components

EdgeDataBox::~EdgeDataBox

(

)

destructor

EdgeDataBox::EdgeDataBox

(

const EdgeDataBox &

)

[private]

these are disallowed

---

Member Function Documentation

void EdgeDataBox::define	(	const Box &	bx,
		int	n = 1
	)

resize EdgeDataBox similar to BaseFab::resize()

void EdgeDataBox::clear

(

)

this function returns the EdgeDataBox to the undefined state

int EdgeDataBox::nComp

(

)

const

{ access functions}

number of components

const Box& EdgeDataBox::box

(

)

const

returns cell-centered box which defines EdgeDataBox

FArrayBox& EdgeDataBox::getData

(

const int

dir

)

returns edge-centered data in direction dir

const FArrayBox& EdgeDataBox::getData

(

const int

dir

)

const

FArrayBox& EdgeDataBox::operator[]

(

const int

dir

)

returns FArrayBox in direction dir

const FArrayBox& EdgeDataBox::operator[]

(

const int

dir

)

const

constant version

void EdgeDataBox::setVal

(

const Real

val

)

{ data modification functions} set all fluxes to val

void EdgeDataBox::setVal	(	const Real	val,
		const int	dir
	)

set fluxes in direction dir to val

void EdgeDataBox::setVal	(	const Real	val,
		const int	dir,
		const int	startComp,
		const int	nComp
	)

more specific setVal

void EdgeDataBox::setVal	(	const Real	val,
		const Box &	bx
	)

sets fluxes on edges surrounding cell-centered box bx

void EdgeDataBox::setVal	(	const Real	val,
		const Box &	bx,
		const int	dir,
		const int	startComp,
		const int	nComp
	)

void EdgeDataBox::copy

(

const EdgeDataBox &

src

)

copy from src to this EdgeDataBox -- sizes must be identical

void EdgeDataBox::copy	(	const EdgeDataBox &	src,
		const int	srcComp,
		const int	destComp,
		const int	numComp
	)

copy on overlap, for all directions

void EdgeDataBox::copy	(	const EdgeDataBox &	src,
		const int	dir,
		const int	srcComp,
		const int	destComp,
		const int	numComp
	)

copy on overlap of EdgeDataBoxes, in direction dir

void EdgeDataBox::copy	(	const Box &	RegionFrom,
		const Interval &	Cdest,
		const Box &	RegionTo,
		const EdgeDataBox &	src,
		const Interval &	Csrc
	)

size_t EdgeDataBox::size	(	const Box &	bx,
		const Interval &	comps
	)			const

{ Linearization Functions}

void EdgeDataBox::linearOut	(	void *	buf,
		const Box &	R,
		const Interval &	comps
	)			const

void EdgeDataBox::linearIn

(

void *

buf

)

void EdgeDataBox::linearIn	(	void *	buf,
		const Box &	R,
		const Interval &	comps
	)

static bool EdgeDataBox::preAllocatable

(

)

[inline, static]

EdgeDataBox& EdgeDataBox::operator=

(

const EdgeDataBox &

)

[private]

---

Member Data Documentation

Box EdgeDataBox::m_bx [protected]

int EdgeDataBox::m_nvar [protected]

Vector<FArrayBox*> EdgeDataBox::m_data [protected]

BL_SPACEDIM FArrayBoxes which hold fluxes.

---

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

• EdgeDataBox.H