openPSTD  2.0
Open source simulation for sound propagation in urban environments
Public Member Functions | Public Attributes | List of all members
OpenPSTD::Kernel::Boundary Class Reference

Models a boundary between two domains. More...

#include <Boundary.h>

Collaboration diagram for OpenPSTD::Kernel::Boundary:
Collaboration graph

Public Member Functions

 Boundary (std::shared_ptr< Domain > domain1, std::shared_ptr< Domain > domain2, CalcDirection type)
 Creates a boundary of given type between the given domains, together with its orientation. More...
 

Public Attributes

std::shared_ptr< Domaindomain1
 First of the domains separated by the boundary.
 
std::shared_ptr< Domaindomain2
 Second of the domains separated by the boundary.
 
CalcDirection type
 Whether the boundary is used for horizontal or vertical computations.
 

Detailed Description

Models a boundary between two domains.

Boundaries are represented as line segments parallel to one of the two (three) axes in the coordinate system. Each boundary is adjacent to at most two domains.

Constructor & Destructor Documentation

OpenPSTD::Kernel::Boundary::Boundary ( std::shared_ptr< Domain domain1,
std::shared_ptr< Domain domain2,
CalcDirection  type 
)

Creates a boundary of given type between the given domains, together with its orientation.

For boundaries between an upper and a lower domain, the calculation direction is vertical. For boundaries between a left and a right domain, the calculation direction is horizontal.

Parameters
domain1Pointer to first domain
domain2Pointer to second domain
Enumcontaining the direction of calculation (horizontal or vertical)
Returns
: new Boundary object

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