SurfaceQuantityContainer Class Reference

Class which represents a container for surface quantities. More...

#include <surface_quantity_container.h>

Collaboration diagram for SurfaceQuantityContainer:

Public Member Functions
void	addVectorQuantity (const VectorSurfaceQuantity &quantity)
	Adds a vector quantity to the container.
void	addCountQuantity (const CountSurfaceQuantity &quantity)
	Adds a count quantity to the container.
void	measureAll (TempSurfaceTallyData &temp_tally_data)
	Measures all quantities in the container for a TempSurfaceTallyData object.
SurfaceQuantityContainer	operator+ (SurfaceQuantityContainer &other) const
	Overloads the + operator for SurfaceQuantityContainer.
void	clear ()
	Clears the container of all quantities.
std::unordered_map< VectorSurfaceQuantityType, VectorSurfaceQuantity > &	getVectorQuantities ()
	Gets the map of vector quantities in the container.
std::unordered_map< CountSurfaceQuantityType, CountSurfaceQuantity > &	getCountQuantities ()
	Gets the map of count quantities in the container.
void	setArea (double area)
	Sets the area of the surface tally.
double	getArea () const
	Gets the area of the surface tally.

Private Attributes
std::unordered_map< VectorSurfaceQuantityType, VectorSurfaceQuantity >	vector_quantities_
std::unordered_map< CountSurfaceQuantityType, CountSurfaceQuantity >	count_quantities_
double	area_

Detailed Description

Class which represents a container for surface quantities.

Essentially a wrapper around a map of SurfaceQuantityType to their respective SurfaceQuantity objects. Allows users to specify which quantities they want to measure for a surface tally.

Definition at line 14 of file surface_quantity_container.h.

Member Function Documentation

addCountQuantity()

void SurfaceQuantityContainer::addCountQuantity

(

const CountSurfaceQuantity &

quantity

)

Adds a count quantity to the container.

Parameters

quantity

The count quantity to add to the container.

addVectorQuantity()

void SurfaceQuantityContainer::addVectorQuantity

(

const VectorSurfaceQuantity &

quantity

)

Adds a vector quantity to the container.

Parameters

quantity

The vector quantity to add to the container.

getArea()

double SurfaceQuantityContainer::getArea

(

)

const

Gets the area of the surface tally.

Returns

The area of the surface tally.

getCountQuantities()

std::unordered_map< CountSurfaceQuantityType, CountSurfaceQuantity > & SurfaceQuantityContainer::getCountQuantities

(

)

Gets the map of count quantities in the container.

Returns

The map of count quantities in the container.

getVectorQuantities()

std::unordered_map< VectorSurfaceQuantityType, VectorSurfaceQuantity > & SurfaceQuantityContainer::getVectorQuantities

(

)

Gets the map of vector quantities in the container.

Returns

The map of vector quantities in the container.

measureAll()

void SurfaceQuantityContainer::measureAll

(

TempSurfaceTallyData &

temp_tally_data

)

Measures all quantities in the container for a TempSurfaceTallyData object.

Parameters

temp_tally_data

The TempSurfaceTallyData object to measure the quantities for.

operator+()

SurfaceQuantityContainer SurfaceQuantityContainer::operator+

(

SurfaceQuantityContainer &

other

)

const

Overloads the + operator for SurfaceQuantityContainer.

Parameters

other

The SurfaceQuantityContainer to add to this SurfaceQuantityContainer.

Returns

The sum of the two SurfaceQuantityContainer objects.

setArea()

void SurfaceQuantityContainer::setArea

(

double

area

)

Sets the area of the surface tally.

Parameters

area	The area of the surface tally.

Member Data Documentation

area_

double SurfaceQuantityContainer::area_

private

Definition at line 81 of file surface_quantity_container.h.

count_quantities_

std::unordered_map<CountSurfaceQuantityType, CountSurfaceQuantity> SurfaceQuantityContainer::count_quantities_

private

Definition at line 80 of file surface_quantity_container.h.

vector_quantities_

std::unordered_map<VectorSurfaceQuantityType, VectorSurfaceQuantity> SurfaceQuantityContainer::vector_quantities_

private

Definition at line 79 of file surface_quantity_container.h.

---

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

• include/MIDSX/Core/surface_quantity_container.h