MatlabTransportPack
Public Member Functions | Public Attributes

Boundary Class Reference

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

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

List of all members.

Public Member Functions

function Boundary (in input, in mesh, in quadrature)
 Class constructor.
function initialize (in this, in g)
 Initialize for a within-group solve.
function set_group (in this, in g)
function group (in this)
 Get the current group.
function set (in this)
 Set the incident boundary fluxes.
function reset (in this)
 Reset the incident boundary fluxes to zero.

Public Attributes

Constant Property IN = 1
Constant Property OUT
Property d_input
 Input.
Property d_mesh
 Spatial mesh.
Property d_quadrature
 Angular mesh.
Property d_boundary_flux
 Boundary flux cell array.
Property d_bc
 Cell array of BoundaryCondition thisects for each surface.
Property d_g
 Current group.

Detailed Description

Holds the incident and outgoing boundary fluxes.

More here...


Constructor & Destructor Documentation

function Boundary ( in  input,
in  mesh,
in  quadrature 
)

Class constructor.

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

Parameters:
inputUser input.
meshSpatial mesh.
quadratureAngular mesh.
Returns:
Instance of the Boundary class.

Member Function Documentation

function group ( in  this)

Get the current group.

Returns:
Current group.
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 reset ( in  this)

Reset the incident boundary fluxes to zero.

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_group ( in  this,
in  g 
)

Member Data Documentation

Property d_bc

Cell array of BoundaryCondition thisects for each surface.

Property d_boundary_flux

Boundary flux cell array.

Property d_g

Current group.

Property d_input
Property d_mesh

Spatial mesh.

Property d_quadrature

Angular mesh.

Constant Property IN = 1
Constant Property OUT

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