MatlabTransportPack
Public Member Functions | Protected Member Functions | Protected Attributes

SourceIteration Class Reference

Source iteration for inner iterations. More...

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

List of all members.

Public Member Functions

function SourceIteration ()
 Class constructor.
function setup (in obj, in)
 Setup the solver.
function solve (in obj, in g)
 Solve the within-group problem.
function reset_convergence (in this, in max_iters, in tolerance)
 Solve the within-group problem.
function display_me (in this)

Protected Member Functions

function setup_base (in this, in)
 Setup the base solver.
function initialize_scatter (in this)
 Prebuild scattering matrix for each cell.
function build_scatter_source (in this, in g, in phi)
 Build the within-group scattering source.
function build_all_scatter_source (in this, in g, in phi)
 Build all the scattering sources.
function build_fixed_source (in this, in g)
 Build source for this group excluding within-group scatter.
function build_external_source (in this, in g)
function check_convergence (in this, in iteration, in flux_error)
function print_iteration (in this, in it, in e0, in e1, in e2)

Protected Attributes

Property d_input
 User input.
Property d_state
 State vectors.
Property d_boundary
 Boundary fluxes.
Property d_mesh
 Problem mesh (either Cartesian mesh or MOC tracking)
Property d_mat
 Materials definitions.
Property d_quadrature
 Angular mesh.
Property d_equation
 Spatial discretization.
Property d_sweeper
 Sweeper over the space-angle domain.
Property d_external_source
 User-defined external source.
Property d_fission_source
 Fission source, if used.
Property d_fixed_source
 Any source that remains "fixed" within the group solve.
Property d_scatter_source
 The within group scattering source.
Property d_sigma_s
 Scattering cross-section vector for faster source computation.
Property d_max_iters
Property d_tolerance
Property d_g
Property d_M
 Moments to discrete operator.

Detailed Description

Source iteration for inner iterations.

Source iteration for a one-group transport equation is defined by the sequence

\[ \phi^{(l+1)} = \frac{1}{4\pi}\mathbf{D}\mathbf{T}^{-1}\mathbf{S} \phi^{(l)} + \mathbf{D} \mathbf{T}^{-1} Q \, . \]

In many cases this algorithm is too slow, particularly for high scattering, highly diffusive problems. In these cases, an acceleration scheme is required; these schemes include the simple Livolant and GMRES methods that work directly with the system above. Ultimately, these are not "acceleration" schemes in the standard sense of the word but rather are different (and more efficient) approaches to solving the linear system defined by the one group transport equation.

Other acceleration schemes that work within the source iteration include diffusion synthetic acceleration (DSA), coarse mesh finite difference (CMFD) acceleration, and coarse mesh rebalance (CMR). Each of these will be implemented in time.


Constructor & Destructor Documentation

function SourceIteration ( )

Class constructor.

Returns:
Instance of the SourceIteration class.

Member Function Documentation

function build_all_scatter_source ( in  this,
in  g,
in  phi 
) [protected, inherited]

Build all the scattering sources.

Parameters:
gGroup for this problem. (I.e. row in MG).
phiCurrent MG flux.
function build_external_source ( in  this,
in  g 
) [protected, inherited]
function build_fixed_source ( in  this,
in  g 
) [protected, inherited]

Build source for this group excluding within-group scatter.

Parameters:
gGroup for this problem.
function build_scatter_source ( in  this,
in  g,
in  phi 
) [protected, inherited]

Build the within-group scattering source.

Parameters:
gGroup for this problem.
phiCurrent group flux.
function check_convergence ( in  this,
in  iteration,
in  flux_error 
) [protected, inherited]
function display_me ( in  this) [inherited]
function initialize_scatter ( in  this) [protected, inherited]

Prebuild scattering matrix for each cell.

While not the most *memory* efficient, this saves *time* by eliminate lots of loops.

function print_iteration ( in  this,
in  it,
in  e0,
in  e1,
in  e2 
) [protected, inherited]
function reset_convergence ( in  this,
in  max_iters,
in  tolerance 
) [inherited]

Solve the within-group problem.

Parameters:
gGroup of the problem to be solved.
Returns:
Flux residual (L-inf norm) and iteration count. Reset convergence criteria. It can be useful to use a dynamically changing convergence criteria, especially for eigenproblems. For regular power iteration, it is wasteful to use tight tolerances on the inners when the source is not as tightly known.
Parameters:
max_itersMaximum number of iterations.
toleranceMaximum point-wise error in flux
function setup ( in  obj,
in   
)

Setup the solver.

Parameters:
inputInput database.
stateState vectors, etc.
boundaryBoundary fluxes.
meshProblem mesh.
matMaterial definitions.
quadratureAngular mesh..
external_sourceUser-defined external source.
fission_sourceFission source.
function setup_base ( in  this,
in   
) [protected, inherited]

Setup the base solver.

By keeping everything out of the constructor, we can avoid having to copy the signature for all derived classes, both in their definitions and whereever thisects are instantiated. However, derived classes have other setup issues that need to be done, and so this serves as a general setup function that must be called before other setup stuff.

Parameters:
inputInput database.
stateState vectors, etc.
boundaryBoundary fluxes.
meshProblem mesh.
matMaterial definitions.
quadratureAngular mesh..
external_sourceUser-defined external source.
fission_sourceFission source.
function solve ( in  obj,
in  g 
)

Solve the within-group problem.

Parameters:
gGroup of the problem to be solved.
Returns:
Flux residual (L-inf norm) and iteration count.

Member Data Documentation

Property d_boundary [protected, inherited]

Boundary fluxes.

Property d_equation [protected, inherited]

Spatial discretization.

Property d_external_source [protected, inherited]

User-defined external source.

Property d_fission_source [protected, inherited]

Fission source, if used.

Property d_fixed_source [protected, inherited]

Any source that remains "fixed" within the group solve.

Property d_g [protected, inherited]
Property d_input [protected, inherited]

User input.

Property d_M [protected, inherited]

Moments to discrete operator.

Property d_mat [protected, inherited]

Materials definitions.

Property d_max_iters [protected, inherited]
Property d_mesh [protected, inherited]

Problem mesh (either Cartesian mesh or MOC tracking)

Property d_quadrature [protected, inherited]

Angular mesh.

Property d_scatter_source [protected, inherited]

The within group scattering source.

Property d_sigma_s [protected, inherited]

Scattering cross-section vector for faster source computation.

Property d_state [protected, inherited]

State vectors.

Property d_sweeper [protected, inherited]

Sweeper over the space-angle domain.

Property d_tolerance [protected, inherited]

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