Classes
class	Surface
	Represents a general Surface in 3D. More...

class	Plane
	Represents a Plane perpendicular to the xy-plane. More...

class	XPlane
	Represents a Plane perpendicular to the x-axis. More...

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

class	ZPlane
	Represents a Plane perpendicular to the z-axis. More...

class	ZCylinder
	Represents a Cylinder with axis parallel to the z-axis. More...

Enumerations
enum	surfaceType { PLANE, ZCYLINDER, XPLANE, YPLANE, ZPLANE, QUADRATIC }
	The types of surfaces supported by OpenMOC. More...

Functions
int	surface_id ()
	Returns an auto-generated unique surface ID. More...

void	reset_surface_id ()
	Resets the auto-generated unique Surface ID counter to 1,000,000.

void	maximize_surface_id (int surface_id)
	Maximize the auto-generated unique Surface ID counter. More...

Detailed Description

The Surface class and subclasses.

Date: January 9, 2012

Author: William Boyd, MIT, Course 22 (wboyd.nosp@m.@mit.nosp@m..edu)

Enumeration Type Documentation

◆ surfaceType

enum surfaceType

The types of surfaces supported by OpenMOC.

Enumerator
PLANE	A general plane
ZCYLINDER	A cylinder with axis parallel to the z-axis
XPLANE	A plane perpendicular to the x-axis
YPLANE	A plane perpendicular to the y-axis
ZPLANE	A plane perpendicular to the z-axis
QUADRATIC	A generalized quadratic surface

Function Documentation

◆ maximize_surface_id()

void maximize_surface_id ( int surface_id )

Maximize the auto-generated unique Surface ID counter.

This method updates the auto-generated unique Surface ID counter if the input parameter is greater than the present value. This is useful for the OpenMC compatibility module to ensure that the auto-generated Surface IDs do not collide with those created in OpenMC.

Parameters

surface_id the id assigned to the auto-generated counter

◆ surface_id()

int surface_id ( )

Returns an auto-generated unique surface ID.

This method is intended as a utility mehtod for user's writing OpenMOC input files. The method makes use of a static surface ID which is incremented each time the method is called to enable unique generation of monotonically increasing IDs. The method's first ID begins at 1,000,000. Hence, user-defined surface IDs greater than or equal to 1,000,000 are prohibited.

Classes