SAMRAI::geom::CartesianCellDoubleWeightedAverage< DIM > Class Template Reference

#include <source/geometry/cartesian/operators/cell/CartesianCellDoubleWeightedAverage.h>

Inheritance diagram for SAMRAI::geom::CartesianCellDoubleWeightedAverage< DIM >:

[legend]List of all members.

Public Member Functions
	CartesianCellDoubleWeightedAverage ()
virtual	~CartesianCellDoubleWeightedAverage ()
bool	findCoarsenOperator (const tbox::Pointer< hier::Variable< DIM > > &var, const std::string &op_name) const
const std::string &	getOperatorName () const
int	getOperatorPriority () const
hier::IntVector< DIM >	getStencilWidth () const
void	coarsen (hier::Patch< DIM > &coarse, const hier::Patch< DIM > &fine, const int dst_component, const int src_component, const hier::Box< DIM > &coarse_box, const hier::IntVector< DIM > &ratio) const

---

Detailed Description

template<int DIM>
class SAMRAI::geom::CartesianCellDoubleWeightedAverage< DIM >

Class CartesianCellDoubleWeightedAverage implements conservative cell-weighted averaging for cell-centered double patch data defined over a Cartesian mesh. It is derived from the xfer::CoarsenOperator<DIM> base class. The numerical operations for the averaging use FORTRAN numerical routines.

The findCoarsenOperator() operator function returns true if the input variable is cell-centered double, and the string is "CONSERVATIVE_COARSEN".

See also:

xfer::CoarsenOperator

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::geom::CartesianCellDoubleWeightedAverage< DIM >::CartesianCellDoubleWeightedAverage

(

)

Uninteresting default constructor.

template<int DIM>

SAMRAI::geom::CartesianCellDoubleWeightedAverage< DIM >::~CartesianCellDoubleWeightedAverage

(

)

[virtual]

Uninteresting virtual destructor.

---

Member Function Documentation

template<int DIM>

bool SAMRAI::geom::CartesianCellDoubleWeightedAverage< DIM >::findCoarsenOperator	(	const tbox::Pointer< hier::Variable< DIM > > &	var,
		const std::string &	op_name
	)			const [virtual]

Return true if the variable and name string match cell-centered double weighted averaging; otherwise, return false.

Implements SAMRAI::xfer::CoarsenOperator< DIM >.

template<int DIM>

const std::string & SAMRAI::geom::CartesianCellDoubleWeightedAverage< DIM >::getOperatorName

(

)

const [virtual]

Return name string identifier of this coarsening operation.

Implements SAMRAI::xfer::CoarsenOperator< DIM >.

template<int DIM>

int SAMRAI::geom::CartesianCellDoubleWeightedAverage< DIM >::getOperatorPriority

(

)

const [virtual]

The priority of cell-centered double weighted averaging is 0. It will be performed before any user-defined coarsen operations.

Implements SAMRAI::xfer::CoarsenOperator< DIM >.

template<int DIM>

hier::IntVector< DIM > SAMRAI::geom::CartesianCellDoubleWeightedAverage< DIM >::getStencilWidth

(

)

const [virtual]

The stencil width of the weighted averaging operator is the vector of zeros. That is, its stencil does not extend outside the fine box.

Implements SAMRAI::xfer::CoarsenOperator< DIM >.

template<int DIM>

void SAMRAI::geom::CartesianCellDoubleWeightedAverage< DIM >::coarsen	(	hier::Patch< DIM > &	coarse,
		const hier::Patch< DIM > &	fine,
		const int	dst_component,
		const int	src_component,
		const hier::Box< DIM > &	coarse_box,
		const hier::IntVector< DIM > &	ratio
	)			const [virtual]

Coarsen the source component on the fine patch to the destination component on the coarse patch using the cell-centered double weighted averaging operator. Coarsening is performed on the intersection of the destination patch and the coarse box. It is assumed that the fine patch contains sufficient data for the stencil width of the coarsening operator.

Implements SAMRAI::xfer::CoarsenOperator< DIM >.

---

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

• source/geometry/cartesian/operators/cell/CartesianCellDoubleWeightedAverage.h
• source/geometry/cartesian/operators/cell/CartesianCellDoubleWeightedAverage.C

---