Mesh Class Reference

Base Cartesian mesh. More...

Inheritance diagram for Mesh:

Collaboration diagram for Mesh:

List of all members.

Public Member Functions
function	Mesh ()
	Class constructor.
function	widths (in obj)
	Get cell array of width vectors.
function	dx (in obj, in i)
	Width along x-axis for a cell.
function	dy (in obj, in i)
	Width along y-axis for a cell.
function	dz (in obj, in i)
	Width along z-axis for a cell.
function	number_cells (in obj)
	Get the total number of cells.
function	number_cells_x (in obj)
	Get the number of cells along the x axis.
function	number_cells_y (in obj)
	Get the number of cells along the y axis.
function	number_cells_z (in obj)
	Get the number of cells along the z axis.
function	dim (in obj, in i)
	Get the number of cells along the an axis.
function	index (in obj, in i, in j, in k)
	Returns the cardinal index for i, j, and k.
function	mesh_map (in obj, in map_key)
	Get a mesh map.
function	meshed (in obj)
Public Attributes
Constant Property	LEFT = 1
Constant Property	RIGHT = 2
Constant Property	BOTTOM = 3
Constant Property	TOP = 4
Constant Property	SOUTH = 5
Constant Property	NORTH = 6
Protected Attributes
Property	d_xcm
	x coarse mesh boundaries
Property	d_ycm
	y coarse mesh boundaries
Property	d_zcm
	z coarse mesh boundaries
Property	d_xfm
	x fine meshes in each x coarse mesh
Property	d_yfm
	y fine meshes in each y coarse mesh
Property	d_zfm
	z fine meshes in each y coarse mesh
Property	d_dx
	x widths
Property	d_dy
	y widths
Property	d_dz
	z widths
Property	d_number_cells
	Total number of cells.
Property	d_number_cells_x
	Number of cells in x direction.
Property	d_number_cells_y
	Number of cells in y direction.
Property	d_number_cells_z
	Number of cells in y direction.
Property	d_mesh_map
	Map container containing a key describing a mesh property and a fine mesh map defining the property in each cell.
Property	d_meshed
	Flag indicating I'm meshed.

---

Detailed Description

Base Cartesian mesh.

Finish me.

---

Constructor & Destructor Documentation

function Mesh

(

)

Class constructor.

Returns:

Instance of the Mesh class.

---

Member Function Documentation

function dim	(	in	obj,
		in	i
	)

Get the number of cells along the an axis.

Returns:

Number of cells.

Reimplemented in Mesh1D.

function dx	(	in	obj,
		in	i
	)

Width along x-axis for a cell.

Returns:

Width.

Reimplemented in Mesh1D.

function dy	(	in	obj,
		in	i
	)

Width along y-axis for a cell.

Returns:

Width.

Reimplemented in Mesh1D.

function dz	(	in	obj,
		in	i
	)

Width along z-axis for a cell.

Returns:

Width.

function index	(	in	obj,
		in	i,
		in	j,
		in	k
	)

Returns the cardinal index for i, j, and k.

For efficiency, the client may want to hardcode the indexing into their routine, as this is suboptimal within a loop.

Returns:

Index.

function mesh_map	(	in	obj,
		in	map_key
	)

Get a mesh map.

Parameters:

mesh_key

A mesh map key.

Returns:

The map.

Reimplemented in Mesh1D.

function meshed

(

in

obj

)

function number_cells

(

in

obj

)

Get the total number of cells.

Returns:

Number of cells.

Reimplemented in Mesh1D.

function number_cells_x

(

in

obj

)

Get the number of cells along the x axis.

Returns:

Number of cells.

Reimplemented in Mesh1D.

function number_cells_y

(

in

obj

)

Get the number of cells along the y axis.

Returns:

Number of cells.

Reimplemented in Mesh1D.

function number_cells_z

(

in

obj

)

Get the number of cells along the z axis.

Returns:

Number of cells.

function widths

(

in

obj

)

Get cell array of width vectors.

Returns:

Cell array of width vectors.

Reimplemented in Mesh1D.

---

Member Data Documentation

Constant Property BOTTOM = 3

Property d_dx [protected]

x widths

Property d_dy [protected]

y widths

Property d_dz [protected]

z widths

Property d_mesh_map [protected]

Map container containing a key describing a mesh property and a fine mesh map defining the property in each cell.

These properties include materials, coarse mesh regions (pins, assembly, fuel, moderator, etc.), and anything else the user wants to edit.

Property d_meshed [protected]

Flag indicating I'm meshed.

Property d_number_cells [protected]

Total number of cells.

Property d_number_cells_x [protected]

Number of cells in x direction.

Property d_number_cells_y [protected]

Number of cells in y direction.

Property d_number_cells_z [protected]

Number of cells in y direction.

Property d_xcm [protected]

x coarse mesh boundaries

Property d_xfm [protected]

x fine meshes in each x coarse mesh

Property d_ycm [protected]

y coarse mesh boundaries

Property d_yfm [protected]

y fine meshes in each y coarse mesh

Property d_zcm [protected]

z coarse mesh boundaries

Property d_zfm [protected]

z fine meshes in each y coarse mesh

Constant Property LEFT = 1

Constant Property NORTH = 6

Constant Property RIGHT = 2

Constant Property SOUTH = 5

Constant Property TOP = 4

---

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

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