SquareBox Class Reference

Square frame for the tessellation. More...

#include <SquareBox.hpp>

Inheritance diagram for SquareBox:

Collaboration diagram for SquareBox:

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...
	SquareBox (double left, double right, double up, double down)
	Class constructor. More...
	SquareBox (Vector2D const &bottom_left, Vector2D const &top_right)
	Class constructor. More...
pair< Vector2D, Vector2D >	getBoundary (void) const
	Returns the coordinates of the lower left and top right of the square frame. More...
void	SetBoundary (Vector2D const &ll, Vector2D const &ur)
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 frame for the tessellation.

Definition at line 15 of file SquareBox.hpp.

Constructor & Destructor Documentation

SquareBox() [1/2]

SquareBox::SquareBox	(	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 27 of file SquareBox.cpp.

SquareBox() [2/2]

SquareBox::SquareBox	(	Vector2D const &	bottom_left,
		Vector2D const &	top_right
	)

Class constructor.

Parameters

bottom_left	Coordinates of the bottom left corner
top_right	Coordinates of the top right corner

Definition at line 33 of file SquareBox.cpp.

Member Function Documentation

AreWeReflective()

bool SquareBox::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 13 of file SquareBox.cpp.

getBoundary()

pair< Vector2D, Vector2D > SquareBox::getBoundary

(

void

)

const

Returns the coordinates of the lower left and top right of the square frame.

Returns

pair of vectors: first is lower left and second is top right

Definition at line 62 of file SquareBox.cpp.

GetBoundaryType()

BoundaryType SquareBox::GetBoundaryType ( void  ) const

virtual

Returns the boundary type.

Returns

The boundary type

Implements OuterBoundary.

Definition at line 43 of file SquareBox.cpp.

GetGridBoundary()

double SquareBox::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 48 of file SquareBox.cpp.

PointIsReflective()

bool SquareBox::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 SquareBox.cpp.

---

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

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