MIDSX 0.1
A x-ray transport code system for dosimetry
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
SurfaceTally Class Referenceabstract

Virtual class which represents a surface tally. More...

#include <surface_tally.h>

Collaboration diagram for SurfaceTally:

Public Member Functions

void processMeasurements (TempSurfaceTallyData &temp_surface_tally_data)
 Processes the measurements for a TempSurfaceTallyData object.
 
SurfaceQuantityContainergetSurfaceQuantityContainer ()
 Gets the SurfaceQuantityContainer object for the surface tally.
 

Protected Member Functions

bool willPassThrough ()
 
double calculateEntranceCosine ()
 
virtual double calculateIntersectionParameter (double entrance_cosine)=0
 
Eigen::Vector3d calculateIntersectionPoint (double t)
 
bool isOutOfRange (double t)
 
virtual bool isOutsideOfSurface (const Eigen::Vector3d &intersection_point)=0
 

Static Protected Member Functions

static bool isPhotonParallelToPlane (double entrance_cosine)
 

Protected Attributes

Eigen::Vector3d norm_
 
TempSurfaceTallyData temp_surface_tally_data_
 
SurfaceQuantityContainer surface_quantities_
 

Detailed Description

Virtual class which represents a surface tally.

A geometrical surface which is used to measure quantities of interest upon a trigger (e.g. photon passing through).

Definition at line 13 of file surface_tally.h.

Member Function Documentation

◆ getSurfaceQuantityContainer()

SurfaceQuantityContainer & SurfaceTally::getSurfaceQuantityContainer ( )

Gets the SurfaceQuantityContainer object for the surface tally.

Returns
The SurfaceQuantityContainer object for the surface tally.

◆ processMeasurements()

void SurfaceTally::processMeasurements ( TempSurfaceTallyData & temp_surface_tally_data)

Processes the measurements for a TempSurfaceTallyData object.

Parameters
temp_surface_tally_dataThe TempSurfaceTallyData object to process the measurements for.

Member Data Documentation

◆ norm_

Eigen::Vector3d SurfaceTally::norm_
protected

Definition at line 30 of file surface_tally.h.

◆ surface_quantities_

SurfaceQuantityContainer SurfaceTally::surface_quantities_
protected

Definition at line 33 of file surface_tally.h.

◆ temp_surface_tally_data_

TempSurfaceTallyData SurfaceTally::temp_surface_tally_data_
protected

Definition at line 32 of file surface_tally.h.


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