HalfPeriodicBox Class Reference

Square box outer boundary conditions with two sides reflective and two periodic. The x direction is taken to be periodic. More...

#include <HalfPeriodicBox.hpp>

Inheritance diagram for HalfPeriodicBox:

Collaboration diagram for HalfPeriodicBox:

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...
	HalfPeriodicBox (double left, double right, double up, double down)
	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 with two sides reflective and two periodic. The x direction is taken to be periodic.

Definition at line 12 of file HalfPeriodicBox.hpp.

Constructor & Destructor Documentation

HalfPeriodicBox()

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

Class constructor.

Parameters

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

Definition at line 17 of file HalfPeriodicBox.cpp.

Member Function Documentation

AreWeReflective()

bool HalfPeriodicBox::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 43 of file HalfPeriodicBox.cpp.

Here is the call graph for this function:

getBoundaries()

std::pair< Vector2D, Vector2D > HalfPeriodicBox::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 4 of file HalfPeriodicBox.cpp.

GetBoundaryType()

BoundaryType HalfPeriodicBox::GetBoundaryType ( void  ) const

virtual

Returns the boundary type.

Returns

The boundary type

Implements OuterBoundary.

Definition at line 24 of file HalfPeriodicBox.cpp.

GetGridBoundary()

double HalfPeriodicBox::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 29 of file HalfPeriodicBox.cpp.

PointIsReflective()

bool HalfPeriodicBox::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 10 of file HalfPeriodicBox.cpp.

---

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

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