plb::BoxProcessorGenerator3D Class Reference

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

#include <dataProcessingFunctional3D.h>

Inheritance diagram for plb::BoxProcessorGenerator3D:

[legend]

Collaboration diagram for plb::BoxProcessorGenerator3D:

[legend]

List of all members.

Public Member Functions
	BoxProcessorGenerator3D (BoxProcessingFunctional3D *functional_, Box3D domain)
	~BoxProcessorGenerator3D ()
	BoxProcessorGenerator3D (BoxProcessorGenerator3D const &rhs)
BoxProcessorGenerator3D &	operator= (BoxProcessorGenerator3D 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)
	Obsolete: 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 BoxProcessorGenerator3D *	clone () const
	Clone DataProcessorGenerator, based on its dynamics type.
virtual void	serialize (Box3D &domain, std::string &data) const
	Serialize content into a string-stream and overwrite data with result.
virtual int	getStaticId () const

---

Detailed Description

An automatically created generator for the BoxProcessor3D.

---

Constructor & Destructor Documentation

plb::BoxProcessorGenerator3D::BoxProcessorGenerator3D	(	BoxProcessingFunctional3D *	functional_,
		Box3D	domain
	)

Referenced by clone().

plb::BoxProcessorGenerator3D::~BoxProcessorGenerator3D

(

)

plb::BoxProcessorGenerator3D::BoxProcessorGenerator3D

(

BoxProcessorGenerator3D const &

rhs

)

---

Member Function Documentation

BlockDomain::DomainT plb::BoxProcessorGenerator3D::appliesTo

(

)

const [virtual]

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

Reimplemented from plb::DataProcessorGenerator3D.

References plb::BoxProcessingFunctional3D::appliesTo().

BoxProcessorGenerator3D * plb::BoxProcessorGenerator3D::clone

(

)

const [virtual]

Clone DataProcessorGenerator, based on its dynamics type.

Implements plb::DataProcessorGenerator3D.

References BoxProcessorGenerator3D().

DataProcessor3D * plb::BoxProcessorGenerator3D::generate

(

std::vector< AtomicBlock3D * >

atomicBlocks

)

const [virtual]

Generate the data processor.

Implements plb::DataProcessorGenerator3D.

References plb::BoxProcessingFunctional3D::clone(), and plb::BoxedDataProcessorGenerator3D::getDomain().

void plb::BoxProcessorGenerator3D::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::BoxProcessingFunctional3D::getModificationPattern().

int plb::BoxProcessorGenerator3D::getStaticId

(

)

const [virtual]

Unique identifier for a given DataProcessor class. Produces the same ID as the corresponding data processor.

Return -1 as default to help transition period as some data processors have no ID.

Reimplemented from plb::DataProcessorGenerator3D.

References plb::BoxProcessingFunctional3D::getStaticId().

void plb::BoxProcessorGenerator3D::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::BoxProcessingFunctional3D::getTypeOfModification().

BoxProcessorGenerator3D & plb::BoxProcessorGenerator3D::operator=

(

BoxProcessorGenerator3D const &

rhs

)

References plb::BoxProcessingFunctional3D::clone().

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

Obsolete: replaced by setscale.

Reimplemented from plb::DataProcessorGenerator3D.

References plb::BoxProcessingFunctional3D::rescale().

void plb::BoxProcessorGenerator3D::serialize	(	Box3D &	domain,
		std::string &	data
	)			const [virtual]

Serialize content into a string-stream and overwrite data with result.

Default action does nothing to help transition period.

Reimplemented from plb::BoxedDataProcessorGenerator3D.

References plb::BoxProcessingFunctional3D::serialize().

void plb::BoxProcessorGenerator3D::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::BoxProcessingFunctional3D::setscale().

---

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

• dataProcessingFunctional3D.h
• dataProcessingFunctional3D.cpp