plb::MultiGridPeriodicitySwitch3D Class Reference

Class that allows periodicity to be toggled on/off in the multigrid. More...

#include <multiGrid3D.h>

Collaboration diagram for plb::MultiGridPeriodicitySwitch3D:

[legend]

List of all members.

Public Member Functions
	MultiGridPeriodicitySwitch3D (MultiGrid3D *block_)
	Constructors.
	MultiGridPeriodicitySwitch3D (MultiGridPeriodicitySwitch3D const &rhs)
MultiGridPeriodicitySwitch3D &	operator= (MultiGridPeriodicitySwitch3D const &rhs)
void	swap (MultiGridPeriodicitySwitch3D &rhs)
void	toggle (int direction, bool periodicity)
	toggle on/off the periodicity in one direction
void	toggleAll (bool periodicity)
	toggle on/off the periodicity in all directions
Array< bool, 3 > const &	getPeriodicityArray () const

---

Detailed Description

Class that allows periodicity to be toggled on/off in the multigrid.

---

Constructor & Destructor Documentation

plb::MultiGridPeriodicitySwitch3D::MultiGridPeriodicitySwitch3D

(

MultiGrid3D *

block_

)

Constructors.

plb::MultiGridPeriodicitySwitch3D::MultiGridPeriodicitySwitch3D

(

MultiGridPeriodicitySwitch3D const &

rhs

)

---

Member Function Documentation

Array< bool, 3 > const & plb::MultiGridPeriodicitySwitch3D::getPeriodicityArray

(

)

const

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

MultiGridPeriodicitySwitch3D & plb::MultiGridPeriodicitySwitch3D::operator=

(

MultiGridPeriodicitySwitch3D const &

rhs

)

void plb::MultiGridPeriodicitySwitch3D::swap

(

MultiGridPeriodicitySwitch3D &

rhs

)

void plb::MultiGridPeriodicitySwitch3D::toggle	(	int	direction,
		bool	periodicity
	)

toggle on/off the periodicity in one direction

References PLB_PRECONDITION, and plb::MultiGrid3D::signalPeriodicity().

void plb::MultiGridPeriodicitySwitch3D::toggleAll

(

bool

periodicity

)

toggle on/off the periodicity in all directions

References plb::MultiGrid3D::signalPeriodicity().

---

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

• multiGrid3D.h
• multiGrid3D.cpp