2-D Cartesian mesh. More...

Inheritance diagram for Mesh2D:

Collaboration diagram for Mesh2D:

Public Member Functions
function	Mesh2D (in xfm, in yfm, in xcm, in ycm, in material_map)
	Class constructor.
function	add_mesh_map (in obj, in mesh_map, in map_key)
	Add a map to the mesh.
function	plot_mesh_map (in obj, in mapkey)
	Plot a mesh map on the mesh.
function	plot_flux (in obj, in f)
	Plot a given flux or flux-shaped vector on the mesh.
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	DIM = 2
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.
Private Member Functions
function	mesh_axes (in obj)
	Get the fine mesh edges defining cells.

Detailed Description

2-D Cartesian mesh.

Finish me.

Constructor & Destructor Documentation

function Mesh2D	(	in	xfm,
		in	yfm,
		in	xcm,
		in	ycm,
		in	material_map
	)

Class constructor.

The mesh is defined in terms of .

Parameters:

xfm	Number of fine mesh per x coarse mesh.
yfm	Number of fine mesh per y coarse mesh.
xcm	Coarse mesh edges along x axis.
ycm	Coarse mesh edges along y axis.
material_map	Coarse mesh material map.

Returns:: Instance of the Mesh class.

Member Function Documentation

function add_mesh_map	(	in	obj,
		in	mesh_map,
		in	map_key
	)

Add a map to the mesh.

Parameters:

mesh_map	Map on the coarse mesh.
map_key	Key (descriptor) for this map.

function dim	(	in	obj,
		in	i
	)		`[inherited]`

Get the number of cells along the an axis.

Returns:: Number of cells.

Reimplemented in Mesh1D.

function dx	(	in	obj,
		in	i
	)		`[inherited]`

Width along x-axis for a cell.

Returns:: Width.

Reimplemented in Mesh1D.

function dy	(	in	obj,
		in	i
	)		`[inherited]`

Width along y-axis for a cell.

Returns:: Width.

Reimplemented in Mesh1D.

function dz	(	in	obj,
		in	i
	)		`[inherited]`

Width along z-axis for a cell.

Returns:: Width.

function index	(	in	obj,
		in	i,
		in	j,
		in	k
	)		`[inherited]`

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_axes ( in obj ) [private]

Get the fine mesh edges defining cells.

Returns:: Vectors of x and y fine mesh edges.

function mesh_map	(	in	obj,
		in	map_key
	)		`[inherited]`

Get a mesh map.

Parameters:

mesh_key A mesh map key.

Returns:: The map.

Reimplemented in Mesh1D.

function meshed ( in obj ) [inherited]

function number_cells ( in obj ) [inherited]

Get the total number of cells.

Returns:: Number of cells.

Reimplemented in Mesh1D.

function number_cells_x ( in obj ) [inherited]

Get the number of cells along the x axis.

Returns:: Number of cells.

Reimplemented in Mesh1D.

function number_cells_y ( in obj ) [inherited]

Get the number of cells along the y axis.

Returns:: Number of cells.

Reimplemented in Mesh1D.

function number_cells_z ( in obj ) [inherited]

Get the number of cells along the z axis.

Returns:: Number of cells.

function plot_flux	(	in	obj,
		in	f
	)

Plot a given flux or flux-shaped vector on the mesh.

Parameters:

f	A vector of values that live on the mesh.

function plot_mesh_map	(	in	obj,
		in	mapkey
	)

Plot a mesh map on the mesh.

Parameters:

map_key A mesh map key.

function widths ( in obj ) [inherited]

Get cell array of width vectors.

Returns:: Cell array of width vectors.

Reimplemented in Mesh1D.

Member Data Documentation

Constant Property BOTTOM = 3 [inherited]

Property d_dx [protected, inherited]

x widths

Property d_dy [protected, inherited]

y widths

Property d_dz [protected, inherited]

z widths

Property d_mesh_map [protected, inherited]

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, inherited]

Flag indicating I'm meshed.

Property d_number_cells [protected, inherited]

Total number of cells.

Property d_number_cells_x [protected, inherited]

Number of cells in x direction.

Property d_number_cells_y [protected, inherited]

Number of cells in y direction.

Property d_number_cells_z [protected, inherited]

Number of cells in y direction.

Property d_xcm [protected, inherited]

x coarse mesh boundaries

Property d_xfm [protected, inherited]

x fine meshes in each x coarse mesh

Property d_ycm [protected, inherited]

y coarse mesh boundaries

Property d_yfm [protected, inherited]

y fine meshes in each y coarse mesh

Property d_zcm [protected, inherited]

z coarse mesh boundaries

Property d_zfm [protected, inherited]

z fine meshes in each y coarse mesh

Constant Property DIM = 2

Constant Property LEFT = 1 [inherited]

Constant Property NORTH = 6 [inherited]

Constant Property RIGHT = 2 [inherited]

Constant Property SOUTH = 5 [inherited]

Constant Property TOP = 4 [inherited]

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

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

Mesh2D Class Reference

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation