Represents a Plane perpendicular to the y-axis. More...

#include "src/Surface.h"

Public Member Functions
	YPlane (const double y, const int id=0, const char *name="")
	Constructor for a Plane perpendicular to the y-axis. More...

void	setY (const double y)
	Set the location of this YPlane on the y-axis. More...

double	getY ()
	Returns the location of the YPlane on the y-axis. More...

double	getMinY (int halfspace)
	Returns the minimum y value for one of this YPlane's halfspaces. More...

double	getMaxY (int halfspace)
	Returns the maximum y value for one of this YPlane's halfspaces. More...

std::string	toString ()
	Converts this YPlane's attributes to a character array. More...

Public Member Functions inherited from Plane
	Plane (const double A, const double B, const double C, const double D, const int id=0, const char *name="")
	Constructor. More...

double	getMinX (int halfspace)
	Returns the minimum x value of -INFINITY. More...

double	getMaxX (int halfspace)
	Returns the maximum x value of INFINITY. More...

double	getMinZ (int halfspace)
	Returns the minimum z value of -INFINITY. More...

double	getMaxZ (int halfspace)
	Returns the maximum z value of INFINITY. More...

double	getA ()
	Returns the A coefficient multiplying x in the surface equation. More...

double	getB ()
	Returns the B coefficient multiplying y in the surface equation. More...

double	getC ()
	Returns the C coefficient multiplying z in the surface equation. More...

double	getD ()
	Returns the D constant coefficient. More...

double	evaluate (const Point *point) const
	Evaluate a Point using the Plane's quadratic Surface equation. More...

int	intersection (Point point, double azim, double polar, Point points)
	Finds the intersection Point with this Plane from a given Point and trajectory defined by an azim/polar. More...

Public Member Functions inherited from Surface
	Surface (const int id=0, const char *name="")
	Constructor assigns unique ID and user-defined ID for a Surface. More...

virtual	~Surface ()
	Destructor.

int	getUid () const
	Return the Surface's unique ID. More...

int	getId () const
	Return the Surface's user-defined ID. More...

char *	getName () const
	Return the user-defined name of the Surface. More...

surfaceType	getSurfaceType ()
	Return the type of Surface (ie, XPLANE, ZYCLINDER, etc). More...

boundaryType	getBoundaryType ()
	Returns the type of boundary conditions for this Surface (REFLECTIVE, VACUUM or BOUNDARY_NONE). More...

double	getMin (int axis, int halfspace)
	Returns the minimum coordinate in the axis direction of the space defined by halfspace and this surface. More...

double	getMax (int axis, int halfspace)
	Returns the maximum coordinate in the axis direction of the space defined by halfspace and this surface. More...

void	setName (const char *name)
	Sets the name of the Surface. More...

void	setBoundaryType (const boundaryType boundary_type)
	Sets the boundary condition type (ie, VACUUM or REFLECTIVE) for this Surface. More...

void	addNeighborCell (int halfspace, Cell *cell)
	Adds a neighbor Cell to this Surface's collection of neighbors. More...

bool	isPointOnSurface (Point *point)
	Return true or false if a Point is on or off of a Surface. More...

bool	isCoordOnSurface (LocalCoords *coord)
	Return true or false if a LocalCoord is on or off of a Surface. More...

double	getMinDistance (Point *point, double azim, double polar)
	Finds the minimum distance to a Surface. More...

double	getMinDistance (LocalCoords *coord)
	Finds the minimum distance to a Surface. More...

void	printString ()
	Prints a string representation of all of the Surface's objects to the console.

Additional Inherited Members
Protected Attributes inherited from Plane
double	_A

double	_B

double	_C

double	_D

Protected Attributes inherited from Surface
int	_uid

int	_id

char *	_name

surfaceType	_surface_type

boundaryType	_boundary_type

std::map< int, std::vector< Cell * > *>	_neighbors

Static Protected Attributes inherited from Surface
static int	_n = 0

Detailed Description

Represents a Plane perpendicular to the y-axis.

Constructor & Destructor Documentation

◆ YPlane()

YPlane::YPlane	(	const double	y,
		const int	id = `0`,
		const char *	name = `""`
	)

Constructor for a Plane perpendicular to the y-axis.

Parameters

y	the location of the Plane along the y-axis
id	the optional Surface id
name	the optional Surface name

Member Function Documentation

◆ getMaxY()

double YPlane::getMaxY ( int halfspace )

virtual

Returns the maximum y value for one of this YPlane's halfspaces.

Parameters

halfspace the halfspace of the YPlane to consider

Returns: the maximum y value

Reimplemented from Plane.

◆ getMinY()

double YPlane::getMinY ( int halfspace )

virtual

Returns the minimum y value for one of this YPlane's halfspaces.

Parameters

halfspace the halfspace of the YPlane to consider

Returns: the minimum y value

Reimplemented from Plane.

◆ getY()

double YPlane::getY ( )

Returns the location of the YPlane on the y-axis.

Returns: the location of the YPlane on the y-axis

◆ setY()

void YPlane::setY ( const double y )

Set the location of this YPlane on the y-axis.

Parameters

y	the location of the YPlane on the y-axis

◆ toString()

std::string YPlane::toString ( )

virtual

Converts this YPlane's attributes to a character array.

The character array returned conatins the type of Plane (ie, YPLANE) and the A, B, and C coefficients in the quadratic Surface equation and the location of the Plane on the y-axis.

Returns: a character array of this YPlane's attributes

Reimplemented from Plane.

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

/home/guillaume/Research/OpenMOC/src/Surface.h
/home/guillaume/Research/OpenMOC/src/Surface.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ YPlane()

Member Function Documentation

◆ getMaxY()

◆ getMinY()

◆ getY()

◆ setY()

◆ toString()