VectorSurfaceQuantity Class Reference

Class which represents a vector quantity for a surface tally. More...

#include <surface_quantity.h>

Collaboration diagram for VectorSurfaceQuantity:

Public Types
using	ValueExtractor = std::function<double(const TempSurfaceTallyData&)>
	ValueExtractor is a function that extracts necessary values from a TempSurfaceTallyData object for a VectorSurfaceQuantity.

Public Member Functions
	VectorSurfaceQuantity (VectorSurfaceQuantityType type)
	Constructor for the VectorSurfaceQuantity class.
VectorSurfaceQuantity	operator+ (VectorSurfaceQuantity &other) const
	Overloads the + operator for VectorSurfaceQuantity.
void	measure (TempSurfaceTallyData &temp_surface_tally_data)
	Measures the VectorSurfaceQuantity for a TempSurfaceTallyData object.
VectorSurfaceQuantityType	getType () const
	Returns the type of the VectorSurfaceQuantity.
VectorValue &	getTotalValues ()
VectorValue &	getPrimaryValues ()
VectorValue &	getSingleIncoherentScatterValues ()
VectorValue &	getSingleCoherentScatterValues ()
VectorValue &	getMultipleScatterValues ()

Private Attributes
VectorSurfaceQuantityType	type_
bool	totaled_ = false
VectorValue	total_values_
VectorValue	primary_values_
VectorValue	single_incoherent_scatter_values_
VectorValue	single_coherent_scatter_values_
VectorValue	multiple_scatter_values_
ValueExtractor	valueExtractor_

Detailed Description

Class which represents a vector quantity for a surface tally.

Essentially a wrapper around the VectorValue class but is specific to a measurement type

Definition at line 39 of file surface_quantity.h.

Member Typedef Documentation

ValueExtractor

using VectorSurfaceQuantity::ValueExtractor = std::function<double(const TempSurfaceTallyData&)>

ValueExtractor is a function that extracts necessary values from a TempSurfaceTallyData object for a VectorSurfaceQuantity.

Parameters

temp_surface_tally_data

The TempSurfaceTallyData object to extract the value from.

Returns

The value extracted from the TempSurfaceTallyData object.

Definition at line 48 of file surface_quantity.h.

Constructor & Destructor Documentation

VectorSurfaceQuantity()

VectorSurfaceQuantity::VectorSurfaceQuantity ( VectorSurfaceQuantityType type )

explicit

Constructor for the VectorSurfaceQuantity class.

Parameters

type	The type of the VectorSurfaceQuantity to be measured.

Member Function Documentation

getType()

VectorSurfaceQuantityType VectorSurfaceQuantity::getType

(

)

const

Returns the type of the VectorSurfaceQuantity.

Returns

The type of the VectorSurfaceQuantity.

measure()

void VectorSurfaceQuantity::measure

(

TempSurfaceTallyData &

temp_surface_tally_data

)

Measures the VectorSurfaceQuantity for a TempSurfaceTallyData object.

Parameters

temp_surface_tally_data

The TempSurfaceTallyData object to measure the VectorSurfaceQuantity for.

operator+()

VectorSurfaceQuantity VectorSurfaceQuantity::operator+

(

VectorSurfaceQuantity &

other

)

const

Overloads the + operator for VectorSurfaceQuantity.

Parameters

other

The VectorSurfaceQuantity to add to this VectorSurfaceQuantity.

Returns

The sum of the two VectorSurfaceQuantity objects.

Member Data Documentation

multiple_scatter_values_

VectorValue VectorSurfaceQuantity::multiple_scatter_values_

private

Definition at line 93 of file surface_quantity.h.

primary_values_

VectorValue VectorSurfaceQuantity::primary_values_

private

Definition at line 90 of file surface_quantity.h.

single_coherent_scatter_values_

VectorValue VectorSurfaceQuantity::single_coherent_scatter_values_

private

Definition at line 92 of file surface_quantity.h.

single_incoherent_scatter_values_

VectorValue VectorSurfaceQuantity::single_incoherent_scatter_values_

private

Definition at line 91 of file surface_quantity.h.

total_values_

VectorValue VectorSurfaceQuantity::total_values_

private

Definition at line 89 of file surface_quantity.h.

totaled_

bool VectorSurfaceQuantity::totaled_ = false

private

Definition at line 88 of file surface_quantity.h.

type_

VectorSurfaceQuantityType VectorSurfaceQuantity::type_

private

Definition at line 87 of file surface_quantity.h.

valueExtractor_

ValueExtractor VectorSurfaceQuantity::valueExtractor_

private

Definition at line 94 of file surface_quantity.h.

---

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

• include/MIDSX/Core/surface_quantity.h