plb::DotProcessorGenerator3D Class Reference

An automatically created generator for the DotProcessor3D. More...

#include <dataProcessingFunctional3D.h>

Inheritance diagram for plb::DotProcessorGenerator3D:

[legend]

Collaboration diagram for plb::DotProcessorGenerator3D:

[legend]

List of all members.

Public Member Functions
	DotProcessorGenerator3D (DotProcessingFunctional3D *functional_, DotList3D const &dotList)
	~DotProcessorGenerator3D ()
	DotProcessorGenerator3D (DotProcessorGenerator3D const &rhs)
DotProcessorGenerator3D &	operator= (DotProcessorGenerator3D const &rhs)
virtual BlockDomain::DomainT	appliesTo () const
	Indicates whether data processor should be applied on envelope or not. Defaults to false.
virtual void	rescale (double dxScale, double dtScale)
	This function is obsolete, and has been replaced by setscale.
virtual void	setscale (int dxScale, int dtScale)
	Specify the scale of the block on which the data processor is acting. Defaults to no rescaling.
virtual void	getModificationPattern (std::vector< bool > &isWritten) const
	Tell which blocks are modified (written) when the processor is applied on them.
virtual void	getTypeOfModification (std::vector< modif::ModifT > &modified) const
virtual DataProcessor3D *	generate (std::vector< AtomicBlock3D * > atomicBlocks) const
	Generate the data processor.
virtual DotProcessorGenerator3D *	clone () const
	Clone DataProcessorGenerator, based on its dynamics type.

---

Detailed Description

An automatically created generator for the DotProcessor3D.

---

Constructor & Destructor Documentation

plb::DotProcessorGenerator3D::DotProcessorGenerator3D	(	DotProcessingFunctional3D *	functional_,
		DotList3D const &	dotList
	)

Referenced by clone().

plb::DotProcessorGenerator3D::~DotProcessorGenerator3D

(

)

plb::DotProcessorGenerator3D::DotProcessorGenerator3D

(

DotProcessorGenerator3D const &

rhs

)

---

Member Function Documentation

BlockDomain::DomainT plb::DotProcessorGenerator3D::appliesTo

(

)

const [virtual]

Indicates whether data processor should be applied on envelope or not. Defaults to false.

Reimplemented from plb::DataProcessorGenerator3D.

References plb::DotProcessingFunctional3D::appliesTo().

DotProcessorGenerator3D * plb::DotProcessorGenerator3D::clone

(

)

const [virtual]

Clone DataProcessorGenerator, based on its dynamics type.

Implements plb::DataProcessorGenerator3D.

References DotProcessorGenerator3D().

DataProcessor3D * plb::DotProcessorGenerator3D::generate

(

std::vector< AtomicBlock3D * >

atomicBlocks

)

const [virtual]

Generate the data processor.

Implements plb::DataProcessorGenerator3D.

References plb::DotProcessingFunctional3D::clone(), and plb::DottedDataProcessorGenerator3D::getDotList().

void plb::DotProcessorGenerator3D::getModificationPattern

(

std::vector< bool > &

isWritten

)

const [virtual]

Tell which blocks are modified (written) when the processor is applied on them.

This function is obsolete and should be replaced by getTypeOfModification().

Reimplemented from plb::DataProcessorGenerator3D.

References plb::DotProcessingFunctional3D::getModificationPattern().

void plb::DotProcessorGenerator3D::getTypeOfModification

(

std::vector< modif::ModifT > &

modified

)

const [virtual]

Tell which blocks are modified and how by the processor. This method must be implemented in each data processor.

Implements plb::DataProcessorGenerator3D.

References plb::DotProcessingFunctional3D::getTypeOfModification().

DotProcessorGenerator3D & plb::DotProcessorGenerator3D::operator=

(

DotProcessorGenerator3D const &

rhs

)

References plb::DotProcessingFunctional3D::clone().

void plb::DotProcessorGenerator3D::rescale	(	double	dxScale,
		double	dtScale
	)			[virtual]

This function is obsolete, and has been replaced by setscale.

Reimplemented from plb::DataProcessorGenerator3D.

References plb::DotProcessingFunctional3D::rescale().

void plb::DotProcessorGenerator3D::setscale	(	int	dxScale_,
		int	dtScale_
	)			[virtual]

Specify the scale of the block on which the data processor is acting. Defaults to no rescaling.

Parameters:

	dxScale	Scale factor for space scale dx.
	dtScale	Scale factor for time scale dt.

Reimplemented from plb::DataProcessorGenerator3D.

References plb::DotProcessingFunctional3D::setscale().

---

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

• dataProcessingFunctional3D.h
• dataProcessingFunctional3D.cpp