Holds the incident and outgoing boundary fluxes for a mesh. More...

Inheritance diagram for BoundaryMesh:

Collaboration diagram for BoundaryMesh:

Public Member Functions
function	BoundaryMesh (in input, in mesh, in quadrature)
	Class constructor.
function	get_psi_v (in this, in o, in a, in inout)
	Get a vertical face incident/exiting boundary flux.
function	get_psi_h (in this, in o, in a, in inout)
	Get a horizontal face incident/exiting boundary flux.
function	get_psi_v_octant (in this, in o, in inout)
	Get a vertical face incident/exiting boundary flux.
function	get_psi_h_octant (in this, in o, in inout)
	Get a horizontal face incident/exiting boundary flux.
function	set_psi_v (in this, in o, in a, in f, in inout)
	Set a vertical face incident boundary flux.
function	set_psi_h (in this, in o, in a, in f, in inout)
	Set a horizontal face incident boundary flux.
function	set_psi_v_octant (in this, in o, in f, in inout)
	Set a vertical face incident boundary flux for all angles.
function	set_psi_h_octant (in this, in o, in f, in inout)
	Set a horizontal face incident boundary flux for all angles.
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
Property	d_octant_indices
	Octant indices.
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 for a mesh.

For now, this class is largely limited to 1-d and 2-d problems. Access is with respect to "vertical" (1-d/2-d) and "horizontal (2-d only) edges, specified as a function of octant and whether the incident or outgoing flux is desired.

Constructor & Destructor Documentation

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

Class constructor.

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

Parameters:

input	User input.
mesh	Spatial mesh.
quadrature	Angular mesh.

Returns:: Instance of the BoundaryMesh class.

Member Function Documentation

function get_psi_h	(	in	this,
		in	o,
		in	a,
		in	inout
	)

Get a horizontal face incident/exiting boundary flux.

Parameters:

o	Octant index.
a	Angle index (within an octant).
inout	Incoming/outgoing switch

Returns:: Boundary flux array.

function get_psi_h_octant	(	in	this,
		in	o,
		in	inout
	)

Get a horizontal face incident/exiting boundary flux.

Parameters:

o	Octant index.
a	Angle index (within an octant).
inout	Incoming/outgoing switch

Returns:: Boundary flux array.

function get_psi_v	(	in	this,
		in	o,
		in	a,
		in	inout
	)

Get a vertical face incident/exiting boundary flux.

Parameters:

o	Octant index.
a	Angle index (within an octant).
inout	Incoming/outgoing switch

Returns:: Boundary flux array.

function get_psi_v_octant	(	in	this,
		in	o,
		in	inout
	)

Get a vertical face incident/exiting boundary flux.

Parameters:

o	Octant index.
a	Angle index (within an octant).
inout	Incoming/outgoing switch

Returns:: Boundary flux array.

function group ( in this ) [inherited]

Get the current group.

Returns:: Current group.

function initialize	(	in	this,
		in	g
	)		`[inherited]`

Initialize for a within-group solve.

More detailed description of what the constructor does.

Parameters:

input	User input.
mesh	Spatial mesh.
quadrature	Angular mesh.

Returns:: Instance of the Boundary class.

function reset ( in this ) [inherited]

Reset the incident boundary fluxes to zero.

function set ( in this ) [inherited]

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:

order Quadrature 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
	)		`[inherited]`

function set_psi_h	(	in	this,
		in	o,
		in	a,
		in	f,
		in	inout
	)

Set a horizontal face incident boundary flux.

Parameters:

o	Octant index.
a	Angle index (within an octant).
f	Flux array.
inout	Incoming/outgoing switch

function set_psi_h_octant	(	in	this,
		in	o,
		in	f,
		in	inout
	)

Set a horizontal face incident boundary flux for all angles.

Parameters:

o	Octant index.
f	Flux array.
inout	Incoming/outgoing switch

function set_psi_v	(	in	this,
		in	o,
		in	a,
		in	f,
		in	inout
	)

Set a vertical face incident boundary flux.

Parameters:

o	Octant index.
a	Angle index (within an octant).
f	Flux array.
inout	Incoming/outgoing switch

function set_psi_v_octant	(	in	this,
		in	o,
		in	f,
		in	inout
	)

Set a vertical face incident boundary flux for all angles.

Parameters:

o	Octant index.
f	Flux array.
inout	Incoming/outgoing switch

Member Data Documentation

Property d_bc [inherited]

Cell array of BoundaryCondition thisects for each surface.

Property d_boundary_flux [inherited]

Boundary flux cell array.

Property d_g [inherited]

Current group.

Property d_input [inherited]

Input.

Property d_mesh [inherited]

Spatial mesh.

Property d_octant_indices

Octant indices.

Property d_quadrature [inherited]

Angular mesh.

Constant Property IN = 1 [inherited]

Constant Property OUT [inherited]

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

/home/robertsj/Research/matlab_transport_pack/source/BoundaryMesh.m

BoundaryMesh Class Reference

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation