src/obase/Scatterer.c File Reference

Functions
bool	setScatterer (int whichScatterer)
Float *	getScatterer ()
char	translateScatterer (int scattererNum)
int	getScatIndex ()
bool	solvingVZ ()
Variables
static Float	Scatterer [MAX_ALPHA] = {1.0, 0.0, 0.0}
static char	ScattererName [MAX_ALPHA] = {'x', 'y', 'z'}
static int	ScattererNum = 0

---

Function Documentation

int getScatIndex

(

)

Get the numeric index of the scatterer of interest

Returns:

integer representing 0 for x, 1 for y, and 2 for z

Float* getScatterer

(

)

Get the list of scatterers.

Returns:

Scatterer list.

bool setScatterer

(

int

whichScatterer

)

Construct scatterer list that is zero except for scatterer of interest which is one.

Parameters:

[in]

whichScatterer

The scatterer of interest, can be 0, 1 or 2.

Returns:

True if valid scatterer; False otherwise.

bool solvingVZ

(

)

char translateScatterer

(

int

scattererNum

)

---

Variable Documentation

Float Scatterer[MAX_ALPHA] = {1.0, 0.0, 0.0} [static]

Single instance of scatter list. There are at most three scatterers. The inversion is solved for one scatterer at a time. The scatterer is the index into the list and if the value is one, then this is the scatterer of interest. If the value is zero, then the inversion is not solving for the scatterer.

Use get and set operations to access the list.

Note: if dim == 2 or 3, then set Scatterer[0] = 1 because when constructing tm matrix, Scatterer[0] is inserted into tm, and it must be one.

char ScattererName[MAX_ALPHA] = {'x', 'y', 'z'} [static]

int ScattererNum = 0 [static]