SAMRAI::pdat::OuternodeDoubleConstantCoarsen< DIM > Class Template Reference

Class OuternodeDoubleConstantCoarsen implements constant averaging (i.e., injection) for outernode-centered double patch data defined over a mesh. More...

#include <source/patchdata/operators/constant/outernode/OuternodeDoubleConstantCoarsen.h>

Inheritance diagram for SAMRAI::pdat::OuternodeDoubleConstantCoarsen< DIM >:

[legend]List of all members.

Public Member Functions
	OuternodeDoubleConstantCoarsen ()
	Uninteresting default constructor.
virtual	~OuternodeDoubleConstantCoarsen ()
	Uninteresting virtual destructor.
bool	findCoarsenOperator (const tbox::Pointer< hier::Variable< DIM > > &var, const std::string &op_name) const
	Determine if object is for coarsening the specified hier_Variable type using the given descriptive operator name.
const std::string &	getOperatorName () const
	Return descriptive name string identifier of this coarsening operator.
int	getOperatorPriority () const
	Give the operator priority.
hier::IntVector< DIM >	getStencilWidth () const
	Give the operator stencil width.
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
	Coarsen the source component on the fine patch to the destination component on the coarse patch using the outernode-centered double constant averaging operator.

---

Detailed Description

template<int DIM>
class SAMRAI::pdat::OuternodeDoubleConstantCoarsen< DIM >

Class OuternodeDoubleConstantCoarsen implements constant averaging (i.e., injection) for outernode-centered double patch data defined over a mesh.

It is derived from the xfer::CoarsenOperator base class. The numerical operations for the averaging use FORTRAN numerical routines.

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

See also:

xfer::CoarsenOperator

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::pdat::OuternodeDoubleConstantCoarsen< DIM >::OuternodeDoubleConstantCoarsen

(

)

Uninteresting default constructor.

template<int DIM>

SAMRAI::pdat::OuternodeDoubleConstantCoarsen< DIM >::~OuternodeDoubleConstantCoarsen

(

)

[virtual]

Uninteresting virtual destructor.

---

Member Function Documentation

template<int DIM>

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

Determine if object is for coarsening the specified hier_Variable type using the given descriptive operator name.

Returns:

True if the variable and name string match the outernode-centered constant averaging; otherwise, return false.

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

template<int DIM>

const std::string & SAMRAI::pdat::OuternodeDoubleConstantCoarsen< DIM >::getOperatorName

(

)

const [virtual]

Return descriptive name string identifier of this coarsening operator.

Returns:

descriptive name string identifier of this coarsening operator.

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

template<int DIM>

int SAMRAI::pdat::OuternodeDoubleConstantCoarsen< DIM >::getOperatorPriority

(

)

const [virtual]

Give the operator priority.

The priority of outernode-centered constant 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::pdat::OuternodeDoubleConstantCoarsen< DIM >::getStencilWidth

(

)

const [virtual]

Give the operator stencil width.

The stencil width of the constant 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::pdat::OuternodeDoubleConstantCoarsen< 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 outernode-centered double constant 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/patchdata/operators/constant/outernode/OuternodeDoubleConstantCoarsen.h
• source/patchdata/operators/constant/outernode/OuternodeDoubleConstantCoarsen.C

---