PeriodicBox Class Reference

Square box outer boundary conditions. More...

#include <PeriodicBox.hpp>

Inheritance diagram for PeriodicBox:

Collaboration diagram for PeriodicBox:

Public Member Functions
bool	AreWeReflective (Edge const &edge) const
	Return wheter an edge is reflective or not. More...
BoundaryType	GetBoundaryType (void) const
	Returns the boundary type. More...
bool	PointIsReflective (Vector2D const &point) const
	Checks if the point is a reflected point outside the domain. More...
double	GetGridBoundary (Directions dir) const
	Returns the boundary coordinate. More...
	PeriodicBox (double left, double right, double up, double down)
	Class constructor. More...
	PeriodicBox (const Vector2D &lower_left, const Vector2D &upper_right)
	Class constructor. More...
std::pair< Vector2D, Vector2D >	getBoundaries (void) const
	Returns the lower left and upper right corners. More...
Public Member Functions inherited from OuterBoundary
vector< Edge >	GetBoxEdges (void) const
	Returns the outer box as a set of edges in the order: Right, Up, Left and Down. All neighbors are set to zero. More...

Detailed Description

Square box outer boundary conditions.

Definition at line 12 of file PeriodicBox.hpp.

Constructor & Destructor Documentation

PeriodicBox() [1/2]

PeriodicBox::PeriodicBox	(	double	left,
		double	right,
		double	up,
		double	down
	)

Class constructor.

Parameters

left	The left coordinate
right	The right coordinate
up	The yp coordinate
down	The down coordinate

Definition at line 14 of file PeriodicBox.cpp.

PeriodicBox() [2/2]

PeriodicBox::PeriodicBox	(	const Vector2D &	lower_left,
		const Vector2D &	upper_right
	)

Class constructor.

Parameters

lower_left	Lower left corner
upper_right	Upper right corner

Definition at line 21 of file PeriodicBox.cpp.

Member Function Documentation

AreWeReflective()

bool PeriodicBox::AreWeReflective ( Edge const &  edge ) const

virtual

Return wheter an edge is reflective or not.

Parameters

edge	The edge to check

Returns

Is the edge reflective

Implements OuterBoundary.

Definition at line 9 of file PeriodicBox.cpp.

getBoundaries()

std::pair< Vector2D, Vector2D > PeriodicBox::getBoundaries

(

void

)

const

Returns the lower left and upper right corners.

Returns

std::pair. first is lower left corner and second is upper right corner

Definition at line 31 of file PeriodicBox.cpp.

GetBoundaryType()

BoundaryType PeriodicBox::GetBoundaryType ( void  ) const

virtual

Returns the boundary type.

Returns

The boundary type

Implements OuterBoundary.

Definition at line 37 of file PeriodicBox.cpp.

GetGridBoundary()

double PeriodicBox::GetGridBoundary ( Directions  dir ) const

virtual

Returns the boundary coordinate.

Parameters

dir	The direction of the boundary

Returns

The boundary coordinate

Implements OuterBoundary.

Definition at line 42 of file PeriodicBox.cpp.

PointIsReflective()

bool PeriodicBox::PointIsReflective ( Vector2D const &  point ) const

virtual

Checks if the point is a reflected point outside the domain.

Parameters

point

The point to check

Returns

Whether the point is reflected or not

Implements OuterBoundary.

Definition at line 4 of file PeriodicBox.cpp.

---

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

• source/newtonian/two_dimensional/geometric_outer_boundaries/PeriodicBox.hpp
• source/newtonian/two_dimensional/geometric_outer_boundaries/PeriodicBox.cpp