MatlabTransportPack
Public Member Functions | Private Attributes

FissionSource Class Reference

Defines the isotropic source from fission reactions. More...

Inheritance diagram for FissionSource:
Inheritance graph
[legend]
Collaboration diagram for FissionSource:
Collaboration graph
[legend]

List of all members.

Public Member Functions

function FissionSource (in state, in mesh, in mat)
 Class constructor.
function initialize (in obj)
 Initialize the fission source.
function reset (in obj)
function initialized (in obj)
function update (in obj)
 Update the fission density.
function normalize (in obj)
 Normalize the fission density.
function setup_outer (in obj, in scale)
 Setup the fission source for an outer iteration.
function source (in obj, in g)
 Return the fission source in a group.
function density (in obj)

Private Attributes

Property d_state
 State vectors.
Property d_mesh
 Problem mesh.
Property d_mat
 Material definitions.
Property d_nu_sigma_f
 Vector of $ \nu \Sigma_f $ values for dot product.
Property d_chi
 Vector $ \chi $ values for dot product.
Property d_fission_density
 Fission density, $ f = \sum_g \nu\Sigma_{f,g} \phi_g $.
Property d_fission_source
 Fission source, $ \textrm{scale} \times f $.
Property d_scale
 Fission source scaling term.
Property d_angular_norm
Property d_initialized
 Are we initialized?

Detailed Description

Defines the isotropic source from fission reactions.


Constructor & Destructor Documentation

function FissionSource ( in  state,
in  mesh,
in  mat 
)

Class constructor.

Parameters:
meshProblem mesh.
matMaterial definitions.
Returns:
Instance of the FissionSource class.

Member Function Documentation

function density ( in  obj)
function initialize ( in  obj)

Initialize the fission source.

Having a separate initialization routine lets us pass around an empty fission source object, yielding more generic programming.

function initialized ( in  obj)
function normalize ( in  obj)

Normalize the fission density.

This can be useful if one wants the initial guess to be normalized.

function reset ( in  obj)
function setup_outer ( in  obj,
in  scale 
)

Setup the fission source for an outer iteration.

This sets a new scaling factor $ k $ and precomputes the quantity $ v = (4\pi k)^{-1} $.

Parameters:
scaleScaling factor (typically 1/keff)
function source ( in  obj,
in  g 
)

Return the fission source in a group.

The group fission source is just that component of the density released in a particular group. Mathematically, this is just

\[ q_{f,g} = \frac{\chi_g}{4\pi k} \sum_g \nu\Sigma_{f,g} \phi_g \, . \]

Note, the scaling factor is actually arbitrary. For 2-D and 3-D, it is $ 4\pi $, possibly with the eigenvalue $ k $. The client sets this in update.

Note also that this returns a discrete source, ready for use in sweeping.

Parameters:
gGroup of the source
Returns:
Source vector
function update ( in  obj)

Update the fission density.

The fission source density is defined

\[ f = \sum_g \nu\Sigma_{f,g} \phi_g \, . \]

This density is updated at the beginning of an outer iteration when a new (or initial) scalar flux is known. At this time, a scaling factor can be set. Most often, this is based on an updated eigenvalue estimate (for reactor problems), or may be any other arbitrary value as needed for a variety of problems.

Parameters:
scaleScaling factor (typically 1/keff)

Member Data Documentation

Property d_angular_norm [private]
Property d_chi [private]

Vector $ \chi $ values for dot product.

Property d_fission_density [private]

Fission density, $ f = \sum_g \nu\Sigma_{f,g} \phi_g $.

Property d_fission_source [private]

Fission source, $ \textrm{scale} \times f $.

Property d_initialized [private]

Are we initialized?

Property d_mat [private]

Material definitions.

Property d_mesh [private]

Problem mesh.

Property d_nu_sigma_f [private]

Vector of $ \nu \Sigma_f $ values for dot product.

Property d_scale [private]

Fission source scaling term.

Property d_state [private]

State vectors.


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