Represents reactor assembly pin in two dimensions. More...

Inheritance diagram for PinCell:

Collaboration diagram for PinCell:

Public Member Functions
function	PinCell (in pitch, in radii, in mat_map, in subdiv)
	Class constructor.
function	meshify (in obj, in number_meshes)
	Construct a mesh in the pin cell.
function	track (in obj, in q, in mat)
	Perform tracking over the pin cell.
function	plot_pin (in obj)
	Plot true geometry outline.
function	plot_mesh (in obj)
	Plot the mesh.
function	plot_tracks (in obj, in full)
	Plot the tracks (180 degrees).
function	verify_tracks (in obj)
	Verify the tracks.
function	pitch (in obj)
function	radii (in obj)
function	tracked (in obj)
function	region_mat_map (in obj)
function	region_volume (in obj)
function	number_regions (in obj)
function	number_segments (in obj, in m, in t)
function	segment_length (in obj, in m, in t, in i)
function	segment_region (in obj, in m, in t, in i)
function	space (in obj, in m)
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
Basic Data
Property	d_pitch
	Pin cell pitch (i.e. width)
Property	d_center
	Center (local)
Property	d_radii
	Pin radii.
Property	d_number_radii
	Number of radii.
Property	d_number_regions
	Number of regions.
Property	d_region_mat_map
	Region material map.
Property	d_region_volume
	Region volumes.
Track Data
Am I meshed?
Property	d_tracked
	Am I tracked>
Property	d_quadrature
	Quadrature.
Property	d_enter
	Entrance points for each angle.
Property	d_exit
	Exit points for each angle.
Property	d_space
Property	d_track_width
	Track widths.
Property	d_segment_length
	Segment lengths, in order of tracking (and sweep)
Property	d_segment_region
	Segment region index.
Property	d_segment_coef
	Segment exponential coefficients. (Not used yet).
Property	d_number_segments
	Number of segments by (angle, track). For debugging.
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	find_region (in obj, in i, in j)
	Determine in what region a mesh center resides.
function	col (in obj, in g)

Detailed Description

Represents reactor assembly pin in two dimensions.

This class represents a pin cell, including its geometry and associated materials definition. Currently, only a single square coolant region is allowed with a possible central pin with one or more concentric regions.

The PinCell class can be used as a mesh for discrete ordinates calculations via the meshify routine, as PinCell inherits from Mesh2D. Additionally, PinCell has a built in tracking routine for solution by the method of characteristics. The tracking is limited to four way rotation symmetry.

Constructor & Destructor Documentation

function PinCell	(	in	pitch,
		in	radii,
		in	mat_map,
		in	subdiv
	)

Class constructor.

The user specifies the box size and the radii of pins. An empty radius vector ("[]") indicates a homogeneous cell. The radii must be given from smallest to largest. A vector of material identifiers must also be given. The size of this must be equal to the number of regions defined by the box and radii. The are arranged in-to-out.

Finally, the user can subdivide the domain. This a level of 0 does nothing. A level of 1 divides the domain along the the x and y axes (though the origin. A level of 2 adds dividing planes at +/- 45 degrees through the origin.

Parameters:

pitch	Pin cell width
radii	Fuel pin radii, if any.
mat_map	Material identifiers for each region.
subdiv	Level of subcell division.

Returns:: Instance of the PinCell class.

Member Function Documentation

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

Add a map to the mesh.

Parameters:

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

function col	(	in	obj,
		in	g
	)		`[private]`

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 find_region	(	in	obj,
		in	i,
		in	j
	)		`[private]`

Determine in what region a mesh center resides.

Parameters:

i	Horizontal index.
j	Vertical index.

Returns:: Region index.

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_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 meshify	(	in	obj,
		in	number_meshes
	)

Construct a mesh in the pin cell.

This is a crude approach that given a number of meshes, a regular grid is defined. Mesh materials are defined as the material in the mid point of a fine mesh. An alternative would be to define new materials via volume homogenization.

Parameters:

number_mesh Number of uniformly spaces meshes per axis.

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 number_regions ( in obj )

function number_segments	(	in	obj,
		in	m,
		in	t
	)

function pitch ( in obj )

function plot_flux	(	in	obj,
		in	f
	)		`[inherited]`

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 ( in obj )

Plot the mesh.

function plot_mesh_map	(	in	obj,
		in	mapkey
	)		`[inherited]`

Plot a mesh map on the mesh.

Parameters:

map_key A mesh map key.

function plot_pin ( in obj )

Plot true geometry outline.

function plot_tracks	(	in	obj,
		in	full
	)

Plot the tracks (180 degrees).

function radii ( in obj )

function region_mat_map ( in obj )

function region_volume ( in obj )

function segment_length	(	in	obj,
		in	m,
		in	t,
		in	i
	)

function segment_region	(	in	obj,
		in	m,
		in	t,
		in	i
	)

function space	(	in	obj,
		in	m
	)

function track	(	in	obj,
		in	q,
		in	mat
	)

Perform tracking over the pin cell.

This is a crude approach that given a number of meshes, a regular grid is defined. Mesh materials are defined as the material in the mid point of a fine mesh. An alternative would be to define new materials via volume homogenization.

Parameters:

q	MOC quadrature

function tracked ( in obj )

function verify_tracks ( in obj )

Verify the tracks.

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_center

Center (local)

Property d_dx [protected, inherited]

x widths

Property d_dy [protected, inherited]

y widths

Property d_dz [protected, inherited]

z widths

Property d_enter

Entrance points for each angle.

Property d_exit

Exit points for each angle.

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_number_radii

Number of radii.

Property d_number_regions

Number of regions.

Property d_number_segments

Number of segments by (angle, track). For debugging.

Property d_pitch

Pin cell pitch (i.e. width)

Property d_quadrature

Quadrature.

Property d_radii

Pin radii.

Property d_region_mat_map

Region material map.

Property d_region_volume

Region volumes.

Property d_segment_coef

Segment exponential coefficients. (Not used yet).

Property d_segment_length

Segment lengths, in order of tracking (and sweep)

Property d_segment_region

Segment region index.

Property d_space

Property d_track_width

Track widths.

Property d_tracked

Am I tracked>

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

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/PinCell.m

PinCell Class Reference

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation