Public Member Functions | List of all members
BCSides Class Reference

Positions of boundaries. More...

#include <BCSides.hpp>

Public Member Functions

 BCSides (double down, double up, double left, double right)
 Class constructor. More...
 
 BCSides (void)
 Default constructor, initlizes to zero.
 
 BCSides (const BCSides &bc)
 Copy constructor. More...
 
BCSidesoperator= (const BCSides &bc)
 Assigment Operator. More...
 
double GetUp (void) const
 y coordinate of the upper boundary More...
 
double GetDown (void) const
 y coordinate of the lower boundary More...
 
double GetLeft (void) const
 Returns the x coordinate of the left boundary. More...
 
double GetRight (void) const
 Returns the x coordinate of the right boundary. More...
 

Detailed Description

Positions of boundaries.

Definition at line 13 of file BCSides.hpp.

Constructor & Destructor Documentation

◆ BCSides() [1/2]

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

Class constructor.

Parameters
downy coordinate of the lower boundary
upy coordinate of the upper boundary
leftx coordinate of the left boundary
rightx coordinate of the right boundary

Definition at line 5 of file BCSides.cpp.

◆ BCSides() [2/2]

BCSides::BCSides ( const BCSides bc)

Copy constructor.

Parameters
bcOther BCSides

Definition at line 22 of file BCSides.cpp.

Member Function Documentation

◆ GetDown()

double BCSides::GetDown ( void  ) const

y coordinate of the lower boundary

Returns
y coordinate of the lower boundary

Definition at line 44 of file BCSides.cpp.

Here is the caller graph for this function:

◆ GetLeft()

double BCSides::GetLeft ( void  ) const

Returns the x coordinate of the left boundary.

Returns
x coordinate of the left boundary

Definition at line 49 of file BCSides.cpp.

Here is the caller graph for this function:

◆ GetRight()

double BCSides::GetRight ( void  ) const

Returns the x coordinate of the right boundary.

Returns
x coordinate of the right boundary

Definition at line 54 of file BCSides.cpp.

Here is the caller graph for this function:

◆ GetUp()

double BCSides::GetUp ( void  ) const

y coordinate of the upper boundary

Returns
y coordinate of the upper boundary

Definition at line 39 of file BCSides.cpp.

Here is the caller graph for this function:

◆ operator=()

BCSides & BCSides::operator= ( const BCSides bc)

Assigment Operator.

Parameters
bcOther BCSides
Returns
Copy of bc

Definition at line 28 of file BCSides.cpp.

Here is the call graph for this function:

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