CoarseAverageFace Class Reference

replaces face-centered coarse-level data w/ averaged fine-level data More...

#include <CoarseAverageFace.H>

Public Types
enum	averageType { arithmetic = 0, harmonic, NUM_AVERAGE_TYPES }

Public Member Functions
	CoarseAverageFace ()
	Default constructor. More...
	CoarseAverageFace (const DisjointBoxLayout &a_fineGrids, int a_nComp, int a_nRef)
	defining constructor More...
	~CoarseAverageFace ()
	destructor More...
void	define (const DisjointBoxLayout &a_fineGrids, int a_nComp, int a_nRef)
	defines the object More...
bool	isDefined () const
void	average (const LevelData< FluxBox > &a_fineData)
	averages fine-level data to internal coarse representation of fine grid More...
void	averageHarmonic (const LevelData< FluxBox > &a_fineData)
void	sum (const LevelData< FluxBox > &a_fineData, const int a_refFactor=1)
	sums fine-level data to internal coarse representation of fine grid More...
void	copyTo (LevelData< FluxBox > &a_coarseData)
	obtain averaged results by copying to the destination More...
void	averageToCoarse (LevelData< FluxBox > &a_coarse_data, const LevelData< FluxBox > &a_fine_data)
	averages fine-level data to coarse level More...
void	averageToCoarseHarmonic (LevelData< FluxBox > &a_coarse_data, const LevelData< FluxBox > &a_fine_data)
	averages fine-level data to coarse level using harmonic averaging More...

Protected Member Functions
void	computeAverages (LevelData< FluxBox > &a_coarse_data, const LevelData< FluxBox > &a_fine_data, int a_averageType)
	utility function to completely determine averages. More...
void	average (const LevelData< FluxBox > &a_fineData, const int a_averageType, const int a_refFactor)
void	averageGridData (FluxBox &a_coarsenedFine, const FluxBox &a_fine, int a_averageType, const int a_refFactor) const
	averages entire single grid data from fine->crse More...

Protected Attributes
bool	m_isDefined
bool	m_isAveraged
int	m_nRef
LevelData< FluxBox >	m_coarsenedFineData

Detailed Description

replaces face-centered coarse-level data w/ averaged fine-level data

This class replaces face-centered data on a coarse level of refinement with the average of the finer-level data which overlays the face. This class is similar to CoarseAverage

Member Enumeration Documentation

averageType

enum CoarseAverageFace::averageType

Enumerator
arithmetic
harmonic
NUM_AVERAGE_TYPES

Constructor & Destructor Documentation

CoarseAverageFace() [1/2]

CoarseAverageFace::CoarseAverageFace

(

)

Default constructor.

CoarseAverageFace() [2/2]

CoarseAverageFace::CoarseAverageFace	(	const DisjointBoxLayout &	a_fineGrids,
		int	a_nComp,
		int	a_nRef
	)

defining constructor

~CoarseAverageFace()

CoarseAverageFace::~CoarseAverageFace

(

)

destructor

Member Function Documentation

define()

void CoarseAverageFace::define	(	const DisjointBoxLayout &	a_fineGrids,
		int	a_nComp,
		int	a_nRef
	)

defines the object

isDefined()

bool CoarseAverageFace::isDefined

(

)

const

average() [1/2]

void CoarseAverageFace::average

(

const LevelData< FluxBox > &

a_fineData

)

averages fine-level data to internal coarse representation of fine grid

averageHarmonic()

void CoarseAverageFace::averageHarmonic

(

const LevelData< FluxBox > &

a_fineData

)

harmonic averaging of fine-level data to internal coarse representation of fine grid

sum()

void CoarseAverageFace::sum	(	const LevelData< FluxBox > &	a_fineData,
		const int	a_refFactor = 1
	)

sums fine-level data to internal coarse representation of fine grid

copyTo()

void CoarseAverageFace::copyTo

(

LevelData< FluxBox > &

a_coarseData

)

obtain averaged results by copying to the destination

averageToCoarse()

void CoarseAverageFace::averageToCoarse	(	LevelData< FluxBox > &	a_coarse_data,
		const LevelData< FluxBox > &	a_fine_data
	)

averages fine-level data to coarse level

averageToCoarseHarmonic()

void CoarseAverageFace::averageToCoarseHarmonic	(	LevelData< FluxBox > &	a_coarse_data,
		const LevelData< FluxBox > &	a_fine_data
	)

averages fine-level data to coarse level using harmonic averaging

computeAverages()

void CoarseAverageFace::computeAverages ( LevelData< FluxBox > &  a_coarse_data, const LevelData< FluxBox > &  a_fine_data, int  a_averageType  )

protected

utility function to completely determine averages.

average() [2/2]

void CoarseAverageFace::average ( const LevelData< FluxBox > &  a_fineData, const int  a_averageType, const int  a_refFactor  )

protected

utility for averaging fine-level data to internal coarse representation of fine grid

averageGridData()

void CoarseAverageFace::averageGridData ( FluxBox &  a_coarsenedFine, const FluxBox &  a_fine, int  a_averageType, const int  a_refFactor  ) const

protected

averages entire single grid data from fine->crse

Member Data Documentation

m_isDefined

bool CoarseAverageFace::m_isDefined

protected

m_isAveraged

bool CoarseAverageFace::m_isAveraged

protected

m_nRef

int CoarseAverageFace::m_nRef

protected

m_coarsenedFineData

LevelData<FluxBox> CoarseAverageFace::m_coarsenedFineData

protected

---

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

• CoarseAverageFace.H