plb::PeriodicitySwitch3D Class Reference

#include <multiBlock3D.h>

Collaboration diagram for plb::PeriodicitySwitch3D:

[legend]

List of all members.

Public Member Functions
	PeriodicitySwitch3D (MultiBlock3D &block_)
	The constructor defaults all directions to false (i.e., non-periodic).
	PeriodicitySwitch3D (MultiBlock3D &block_, PeriodicitySwitch3D const &rhs)
PeriodicitySwitch3D &	operator= (PeriodicitySwitch3D const &rhs)
void	toggle (plint direction, bool periodic)
	Set periodicity status of a direction (direction=0 means x-direction etc.).
void	toggleAll (bool periodic)
	Set periodicity status of all directions synchronously.
bool	get (plint direction) const
	Get periodicity status of a direction;.
bool	get (plint normalX, plint normalY, plint normalZ) const
	Get periodicity along a general direction;.
Box3D	getPeriodicEnvelope (Box3D const &bulk, plint envelopeWidth) const
	Extend the bulk in each periodic direction, and return the result.

---

Constructor & Destructor Documentation

plb::PeriodicitySwitch3D::PeriodicitySwitch3D

(

MultiBlock3D &

block_

)

The constructor defaults all directions to false (i.e., non-periodic).

plb::PeriodicitySwitch3D::PeriodicitySwitch3D	(	MultiBlock3D &	block_,
		PeriodicitySwitch3D const &	rhs
	)

---

Member Function Documentation

bool plb::PeriodicitySwitch3D::get	(	plint	normalX,
		plint	normalY,
		plint	normalZ
	)			const

Get periodicity along a general direction;.

bool plb::PeriodicitySwitch3D::get

(

plint

direction

)

const

Get periodicity status of a direction;.

References PLB_PRECONDITION.

Referenced by plb::SerialBlockCommunicator3D::duplicateOverlaps(), and plb::MultiProcessing3D< OriginalGenerator, MutableGenerator >::subdivideGenerator().

Box3D plb::PeriodicitySwitch3D::getPeriodicEnvelope	(	Box3D const &	bulk,
		plint	envelopeWidth
	)			const

Extend the bulk in each periodic direction, and return the result.

References plb::BlockDomain::envelope, plb::Box3D::x0, plb::Box3D::x1, plb::Box3D::y0, plb::Box3D::y1, plb::Box3D::z0, and plb::Box3D::z1.

PeriodicitySwitch3D & plb::PeriodicitySwitch3D::operator=

(

PeriodicitySwitch3D const &

rhs

)

void plb::PeriodicitySwitch3D::toggle	(	plint	direction,
		bool	periodic
	)

Set periodicity status of a direction (direction=0 means x-direction etc.).

References plb::modif::dataStructure, plb::MultiBlock3D::duplicateOverlaps(), PLB_PRECONDITION, and plb::MultiBlock3D::signalPeriodicity().

Referenced by plb::MultiGrid3D::signalPeriodicity().

void plb::PeriodicitySwitch3D::toggleAll

(

bool

periodic

)

Set periodicity status of all directions synchronously.

References plb::modif::dataStructure, plb::MultiBlock3D::duplicateOverlaps(), and plb::MultiBlock3D::signalPeriodicity().

Referenced by plb::defaultGenerateMultiNTensorField3D(), and plb::generateMultiNTensorField3D().

---

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

• multiBlock3D.h
• multiBlock3D.cpp