Quadrature Class Reference

Base quadrature class. More...

Inheritance diagram for Quadrature:

Collaboration diagram for Quadrature:

List of all members.

Public Member Functions
function	Quadrature (in order, in dim)
	Class constructor.
function	weights (in obj)
	Return weights for all angles.
function	weight (in obj, in a)
	Return weight for an angle (indexed by cardinal index)
function	weight_octant (in obj)
	Return weight for first octant.
function	angles (in obj)
	Return all angles.
function	angle_octant (in obj, in dim)
	Return first octant angles.
function	angle (in obj, in o, in a)
	Return angles for a given cardinal index.
function	number_angles (in obj)
	Total number of angles.
function	number_angles_octant (in obj)
	Total number of angles in an octant.
function	number_octants (in obj)
	Total number of octants.
function	bounds (in obj, in o)
	Angle bounds within an octant.
function	index (in obj, in o, in a)
	Computes cardinal angle index.
Static Public Member Functions
static function	angular_norm (in dim)
Public Attributes
Property	d_order
Constant Property	octant = [ 1 1 1
	Octant cosign signs.
Constant	Property
Protected Member Functions
function	check_index (in obj, in a)
Protected Attributes
Property	d_weights
	Quadrature weights.
Property	d_mu
	x-axis cosines
Property	d_eta
	y-axis cosines
Property	d_xi
	z-axis cosines
Property	d_name
	type of quadrature being used
Property	d_number_angles
	number of angles
Property	d_number_octants
	number of octants
Property	d_dim
	problem dimension

---

Detailed Description

Base quadrature class.

And here we can put some more detailed informations about the class. All quadratures must be ordered so that the signs of the cosines are arranged in the following manner:

indices | mu | eta | xi ---------------------------------- 1: N | + | + | + (first octant) N+1:2N | - | + | + (second octant) 2N+1:3N | - | - | + (third octant) 3N+1:4N | + | - | + (fourth octant) 4N+1:5N | + | + | - ... 5N+1:6N | - | + | - 6N+1:7N | - | - | - 7N+1:8N | + | - | -

Note that N is the number of angles per quadrant. Outside of the given pattern, the angles need only be consistently ordered, i.e.

abs(mu(i*N+1)) = abs(mu(j*N+1)) for i,j = 0, 1, 2, 3

though decreasing absolute value is suggested.

---

Constructor & Destructor Documentation

function Quadrature	(	in	order,
		in	dim
	)

Class constructor.

More detailed description of what the constructor does.

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.

---

Member Function Documentation

function angle	(	in	obj,
		in	o,
		in	a
	)

Return angles for a given cardinal index.

Returns:

Set of angles.

function angle_octant	(	in	obj,
		in	dim
	)

Return first octant angles.

Returns:

Vector of weights.

function angles

(

in

obj

)

Return all angles.

Returns:

Vector of weights.

static function angular_norm

(

in

dim

)

[static]

function bounds	(	in	obj,
		in	o
	)

Angle bounds within an octant.

Returns:

Bounds.

function check_index	(	in	obj,
		in	a
	)		[protected]

function index	(	in	obj,
		in	o,
		in	a
	)

Computes cardinal angle index.

Returns:

Index.

function number_angles

(

in

obj

)

Total number of angles.

Returns:

Number of angles.

function number_angles_octant

(

in

obj

)

Total number of angles in an octant.

Returns:

Number of angles.

function number_octants

(

in

obj

)

Total number of octants.

Returns:

Number of octants.

function weight	(	in	obj,
		in	a
	)

Return weight for an angle (indexed by cardinal index)

Returns:

Vector of weights.

function weight_octant

(

in

obj

)

Return weight for first octant.

Returns:

Vector of weights.

function weights

(

in

obj

)

Return weights for all angles.

Returns:

Vector of weights.

---

Member Data Documentation

Property d_dim [protected]

problem dimension

Property d_eta [protected]

y-axis cosines

Property d_mu [protected]

x-axis cosines

Property d_name [protected]

type of quadrature being used

Property d_number_angles [protected]

number of angles

Property d_number_octants [protected]

number of octants

Property d_order

Property d_weights [protected]

Quadrature weights.

Property d_xi [protected]

z-axis cosines

Constant Property octant = [ 1 1 1

Octant cosign signs.

Constant Property

---

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

• /home/robertsj/Research/matlab_transport_pack/source/Quadrature.m