Parameters that specify the particle aggregate. More...

Public Member Functions
function set	type (in obj, in value)
	Set method for type. More...

function set	disperse (in obj, in value)
	Set method for disperse. More...

function set	positionArray (in obj, in value)
	Set method for positionArray. More...

function set	refractiveIndexArray (in obj, in value)
	Set method for refractive index. More...

function get	uniqueRefractiveIndices (in obj)
	Get method for unique refractive index values, returns ordered. More...

function get	numUniqueRefractiveIndices (in obj)
	Get method for the number of unique refractive indices. More...

function get	refractiveIndexArrayIndex (in obj)
	Get method for refractive index array in terms of indices given by. More...

function set	radiusArray (in obj, in value)
	Set method for radiusArray. More...

function get	uniqueRadii (in obj)
	Get method for unique radii values, returns ordered vector of unique radii. More...

function get	numUniqueRadii (in obj)
	Get method for the number of unique radii. More...

function get	radiusArrayIndex (in obj)
	Get method for radius array in terms of indices given by uniqueRadii, sorted smallest to largest. More...

function get	uniqueRadiusIndexPairs (in obj)
	Get method to get unique pairs of radii and indices for. More...

function get	uniqueSingleRadiusIndexPairs (in obj)
	Get method to get unique pairs of radii and indices for. More...

function get	singleUniqueIndex (in obj)
	Get method for creating a single index encompassing unique pair. More...

function get	singleUniqueArrayIndex (in obj)
	Get method for a map of particles indexed by singleUniqueIndex. More...

function get	numUniquePairs (in obj)
	Get method for the number of unique pairs of indices and. More...

function set	number (in obj, in value)
	Set method for particle number. More...

function get	number (in obj)
	Set method for particle number. More...

function	compute_maximal_particle_distance (in obj)
	Set the maximalParticleDistance attribute to the correct value. More...

Public Attributes
Property	type
	particle type, so far only 'sphere' implemented More...

Property	disperse
	monodisperse or polydisperse? so far only 'mono' implemented. More...

Property	positionArray
	positions of the particles in the format [x(:),y(:),z(:)] More...

Property	refractiveIndexArray
	complex refractive indices of the particles, n+ik More...

Property	radiusArray
	radii of the particles More...

Property	maxParticleDistance
	maximal distance between two particles More...

Property	number
	number of particles More...

Property	uniqueRadii
	unique radii list More...

Property	numUniqueRadii
	number of unique radii More...

Property	radiusArrayIndex
	radiusArray in terms of indices given by uniqueRadii More...

Property	uniqueRefractiveIndices
	unique index list More...

Property	numUniqueRefractiveIndices
	number of unique refractive indices More...

Property	refractiveIndexArrayIndex
	refractiveIndexArray in terms of indices given by More...

Property	uniqueRadiusIndexPairs
	unique pairs of refractive indices and radii More...

Property	uniqueSingleRadiusIndexPairs
	unique pairs of refractive indices and radii More...

Property	numUniquePairs
	number of unique pairs of refractive indices and radii More...

Property	singleUniqueIndex
	single index encompassing radius and refractive index More...

Property	singleUniqueArrayIndex
	singleUniqueIndexMap in terms of indices given by More...

Detailed Description

Parameters that specify the particle aggregate.

Member Function Documentation

◆ compute_maximal_particle_distance()

function compute_maximal_particle_distance ( in obj )

Set the maximalParticleDistance attribute to the correct value.

◆ disperse()

function set disperse	(	in	obj,
		in	value
	)

Set method for disperse.

◆ number() [1/2]

function set number	(	in	obj,
		in	value
	)

Set method for particle number.

◆ number() [2/2]

function get number ( in obj )

Set method for particle number.

◆ numUniquePairs()

function get numUniquePairs ( in obj )

Get method for the number of unique pairs of indices and.

◆ numUniqueRadii()

function get numUniqueRadii ( in obj )

Get method for the number of unique radii.

◆ numUniqueRefractiveIndices()

function get numUniqueRefractiveIndices ( in obj )

Get method for the number of unique refractive indices.

◆ positionArray()

function set positionArray	(	in	obj,
		in	value
	)

Set method for positionArray.

◆ radiusArray()

function set radiusArray	(	in	obj,
		in	value
	)

Set method for radiusArray.

◆ radiusArrayIndex()

function get radiusArrayIndex ( in obj )

Get method for radius array in terms of indices given by uniqueRadii, sorted smallest to largest.

◆ refractiveIndexArray()

function set refractiveIndexArray	(	in	obj,
		in	value
	)

Set method for refractive index.

◆ refractiveIndexArrayIndex()

function get refractiveIndexArrayIndex ( in obj )

Get method for refractive index array in terms of indices given by.

◆ singleUniqueArrayIndex()

function get singleUniqueArrayIndex ( in obj )

Get method for a map of particles indexed by singleUniqueIndex.

◆ singleUniqueIndex()

function get singleUniqueIndex ( in obj )

Get method for creating a single index encompassing unique pair.

◆ type()

function set type	(	in	obj,
		in	value
	)

Set method for type.

◆ uniqueRadii()

function get uniqueRadii ( in obj )

Get method for unique radii values, returns ordered vector of unique radii.

◆ uniqueRadiusIndexPairs()

function get uniqueRadiusIndexPairs ( in obj )

Get method to get unique pairs of radii and indices for.

◆ uniqueRefractiveIndices()

function get uniqueRefractiveIndices ( in obj )

Get method for unique refractive index values, returns ordered.

◆ uniqueSingleRadiusIndexPairs()

function get uniqueSingleRadiusIndexPairs ( in obj )

Get method to get unique pairs of radii and indices for.

Member Data Documentation

◆ disperse

Property disperse

monodisperse or polydisperse? so far only 'mono' implemented.

that means that all particles are the same.

◆ maxParticleDistance

Property maxParticleDistance

maximal distance between two particles

◆ number

Property number

number of particles

◆ numUniquePairs

Property numUniquePairs

number of unique pairs of refractive indices and radii

◆ numUniqueRadii

Property numUniqueRadii

number of unique radii

◆ numUniqueRefractiveIndices

Property numUniqueRefractiveIndices

number of unique refractive indices

◆ positionArray

Property positionArray

positions of the particles in the format [x(:),y(:),z(:)]

◆ radiusArray

Property radiusArray

radii of the particles

◆ radiusArrayIndex

Property radiusArrayIndex

radiusArray in terms of indices given by uniqueRadii

◆ refractiveIndexArray

Property refractiveIndexArray

complex refractive indices of the particles, n+ik

◆ refractiveIndexArrayIndex

Property refractiveIndexArrayIndex

refractiveIndexArray in terms of indices given by

◆ singleUniqueArrayIndex

Property singleUniqueArrayIndex

singleUniqueIndexMap in terms of indices given by

◆ singleUniqueIndex

Property singleUniqueIndex

single index encompassing radius and refractive index

◆ type

Property type

particle type, so far only 'sphere' implemented

◆ uniqueRadii

Property uniqueRadii

unique radii list

◆ uniqueRadiusIndexPairs

Property uniqueRadiusIndexPairs

unique pairs of refractive indices and radii

◆ uniqueRefractiveIndices

Property uniqueRefractiveIndices

unique index list

◆ uniqueSingleRadiusIndexPairs

Property uniqueSingleRadiusIndexPairs