OuterBoundary Class Reference

Abstract class for geometric boundary conditions for the tessellation. More...

#include <OuterBoundary.hpp>

Inheritance diagram for OuterBoundary:

Inheritance graph

[legend]

Public Member Functions
virtual BoundaryType	GetBoundaryType (void) const =0
	Returns the boundary type. More...

virtual double	GetGridBoundary (Directions dir) const =0
	Returns the boundary coordinate. More...

virtual bool	AreWeReflective (Edge const &edge) const =0
	Return wheter an edge is reflective or not. More...

virtual bool	PointIsReflective (Vector2D const &point) const =0
	Checks if the point is a reflected point outside the domain. More...

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

Abstract class for geometric boundary conditions for the tessellation.

Definition at line 19 of file OuterBoundary.hpp.

Member Function Documentation

◆ AreWeReflective()

virtual bool OuterBoundary::AreWeReflective ( Edge const & edge ) const

pure virtual

Return wheter an edge is reflective or not.

Parameters

edge	The edge to check

Returns: Is the edge reflective

Implemented in SquareBox, HalfPeriodicBox, and PeriodicBox.

◆ GetBoundaryType()

virtual BoundaryType OuterBoundary::GetBoundaryType ( void ) const

pure virtual

Returns the boundary type.

Returns: The boundary type

Implemented in SquareBox, HalfPeriodicBox, and PeriodicBox.

Here is the caller graph for this function:

◆ GetBoxEdges()

vector< Edge > OuterBoundary::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.

Returns: The edges of the boundary box.

Definition at line 5 of file OuterBoundary.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetGridBoundary()

virtual double OuterBoundary::GetGridBoundary ( Directions dir ) const

pure virtual

Returns the boundary coordinate.

Parameters

dir	The direction of the boundary

Returns: The boundary coordinate

Implemented in SquareBox, HalfPeriodicBox, and PeriodicBox.

Here is the caller graph for this function:

◆ PointIsReflective()

virtual bool OuterBoundary::PointIsReflective ( Vector2D const & point ) const

pure 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

Implemented in SquareBox, HalfPeriodicBox, and PeriodicBox.

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

source/newtonian/two_dimensional/OuterBoundary.hpp
source/newtonian/two_dimensional/OuterBoundary.cpp