MatlabTransportPack
Public Member Functions | Public Attributes

BoundaryTrack Class Reference

Holds the incident and outgoing boundary fluxes for tracks. More...

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

List of all members.

Public Member Functions

function BoundaryTrack (in input, in track, in quadrature)
 Class constructor.
function initialize (in this, in g)
 Initialize for a within-group solve.
function set (in this)
 Set the incident boundary fluxes.
function get_psi (in this, in o, in a, in inout)
 Get incident or exiting flux for an angle.
function set_psi (in this, in o, in a, in f, in inout)
 Set incident or exiting flux for an angle.
function get_single_psi (in this, in o, in a, in p, in t, in inout)
 Get incident or exiting flux for an angle and track.
function set_single_psi (in this, in o, in a, in t, in p, in f, in inout)
 Set incident or exiting flux for an angle and track.
function get_boundary_flux (in this, in inout)
 Get incident or exiting flux for all angles.
function get_side_flux (in this, in side, in polar, in inout)
 Get incident or exiting flux for all angles for a side.
function set_side_flux (in this, in side, in f, in inout)
 Set incident or exiting flux for all angles for a side.
function get_bc (in this, in side)
function build_reflect_index (in this)
 Build index of (o, a) -> (o', a') pairs and its inverse.
function build_side_index (in this)
 Build index of (o, a, t) for each side.

Public Attributes

Constant Property INCIDENT = 1
Constant Property EXITING = 2
Property d_track
 Spatial track.
Property d_quadrature
 Angular track.
Property d_boundary_flux
 Boundary flux cell array.
Property d_bc
 Cell array of BoundaryCondition thisects for each surface.
Property d_g
 Current group.
Property d_octants
Property d_index
Property d_bindex
Property d_side_index

Detailed Description

Holds the incident and outgoing boundary fluxes for tracks.

More here...


Constructor & Destructor Documentation

function BoundaryTrack ( in  input,
in  track,
in  quadrature 
)

Class constructor.

All boundary flux arrays are sized, and the boundary conditions are constructed for each surface.

Parameters:
inputUser input.
trackSpatial track.
quadratureAngular track.
Returns:
Instance of the BoundaryTrack class.

Member Function Documentation

function build_reflect_index ( in  this)

Build index of (o, a) -> (o', a') pairs and its inverse.

function build_side_index ( in  this)

Build index of (o, a, t) for each side.

For a given side, have an array of three columns listing o, a, and t that it has as input. Note, for each side, the tracks are listed by angle-space, from (pi, 0) and (i=1, i=# points). This facilitates defining functions on a boundary as a function of angle or space.

function get_bc ( in  this,
in  side 
)
function get_boundary_flux ( in  this,
in  inout 
)

Get incident or exiting flux for all angles.

Parameters:
inoutIncoming/outgoing switch
Returns:
Boundary flux array {azimuth}(polar, track)
function get_psi ( in  this,
in  o,
in  a,
in  inout 
)

Get incident or exiting flux for an angle.

Parameters:
oOctant index.
aAngle index (within an octant).
inoutIncoming/outgoing switch
Returns:
Boundary flux array (polar, track)
function get_side_flux ( in  this,
in  side,
in  polar,
in  inout 
)

Get incident or exiting flux for all angles for a side.

Parameters:
inoutIncoming/outgoing switch
Returns:
Boundary flux array {azimuth}(polar, track)
function get_single_psi ( in  this,
in  o,
in  a,
in  p,
in  t,
in  inout 
)

Get incident or exiting flux for an angle and track.

Parameters:
oOctant index.
aAngle index (within an octant).
inoutIncoming/outgoing switch
Returns:
Boundary flux array (polar, track)
function initialize ( in  this,
in  g 
)

Initialize for a within-group solve.

More detailed description of what the constructor does.

Parameters:
inputUser input.
meshSpatial mesh.
quadratureAngular mesh.
Returns:
Instance of the Boundary class.
function set ( in  this)

Set the incident boundary fluxes.

This is called after every sweep. The sweeper updates all the outgoing angular fluxes. This routine updates the incident fluxes according to the boundary condition.

Parameters:
orderQuadrature order. This differs from quadrature to quadrature, but e.g. for level symmetric, it's the number of unique directional cosines.
Returns:
Instance of the Quadrature class.
function set_psi ( in  this,
in  o,
in  a,
in  f,
in  inout 
)

Set incident or exiting flux for an angle.

Parameters:
oOctant index.
aAngle index (within an octant).
fFlux array (polar, track)
inoutIncoming/outgoing switch
function set_side_flux ( in  this,
in  side,
in  f,
in  inout 
)

Set incident or exiting flux for all angles for a side.

Parameters:
inoutIncoming/outgoing switch
Returns:
Boundary flux array {azimuth}(polar, track)
function set_single_psi ( in  this,
in  o,
in  a,
in  t,
in  p,
in  f,
in  inout 
)

Set incident or exiting flux for an angle and track.

Parameters:
oOctant index.
aAngle index (within an octant).
fFlux array (polar, track)
inoutIncoming/outgoing switch

Member Data Documentation

Property d_bc

Cell array of BoundaryCondition thisects for each surface.

Property d_bindex
Property d_boundary_flux

Boundary flux cell array.

Property d_g

Current group.

Property d_index
Property d_octants
Property d_quadrature

Angular track.

Property d_side_index
Property d_track

Spatial track.

Constant Property EXITING = 2
Constant Property INCIDENT = 1

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