Central data structure of the celes software. More...

Public Member Functions
function get	lookupParticleDistances (in obj)
	get method for dependent property lookupParticleDistances More...

function	computeMieCoefficients (in obj)
	Evaluate the Mie coefficients. More...

function	computeTranslationTable (in obj)
	Prepare a lookup for the a and b coefficients for particle coupling. More...

function	computeInitialFieldCoefficients (in obj)
	Evaluate the initial field coefficients $a^S_{0,n}$ of the initial field expansion around each particle: $\mathbf{E}_0=\sum_n a^S_{0,n}\mathbf{\Psi}^{(1)}_n$ . More...

function	computeInitialFieldPower (in obj)
	Evaluate the power flux of the initial field. More...

function	computeScatteredFieldCoefficients (in obj, in varargin)
	Compute the scattered field coefficients b by iteratively solving the linear system Mb=TaI. More...

function	computeScatteredFieldPWP (in obj)
	Compute the plane wave pattern of the scattered field (i.e., the expansion coefficients of the scattered field in plane vector wave functions) More...

function	computeTotalFieldPWP (in obj)
	Compute the plane wave pattern of the total field (i.e., the expansion coefficients of the scattered field in plane vector wave functions) More...

function	computeTotalFieldPower (in obj)
	Evaluate the power flux of the total field, both in forward and in backward direction. More...

function	evaluatePower (in obj)
	First prepare the scattered and total field's plane wave pattern, then evaluate the power flux. More...

function	evaluateInitialField (in obj)
	Evaluate the initial (near)field at the positions specified in the input. More...

function	evaluateScatteredField (in obj)
	Evaluate the scattered (near)field at the positions specified in the input. More...

function	evaluateInternalField (in obj)
	Evaluate the internal (near)field at the positions specified in the input. More...

function	evaluateFields (in obj)
	Evaluate both the initial and the scattered (near)field at the positions specified in the input. More...

function	masterMatrixMultiply (in obj, in value, in varargin)
	Multiply the master matrix M=1-T*W to some vector x. More...

function	run (in obj, in varargin)
	Run the simulation. More...

Public Attributes
Property	input
	celes_input object which contains the parameters that specify the simulation geometry and initial field More...

Property	numerics
	celes_numerics object which contains the numerical settings More...

Property	tables
	celes_tables object which contains lookup tables and other intermediate results More...

Property	output
	celes_output object which contains the results of the simulation More...

Property	lookupParticleDistances
	single array which contains a grid of distances used for the lookup of the spherical hankel function in the particle coupling More...

Detailed Description

Central data structure of the celes software.

The simulation class contains all input, intermediate results and output for one calculation.

Member Function Documentation

◆ computeInitialFieldCoefficients()

function computeInitialFieldCoefficients ( in obj )

Evaluate the initial field coefficients $a^S_{0,n}$ of the initial field expansion around each particle: $\mathbf{E}_0=\sum_n a^S_{0,n}\mathbf{\Psi}^{(1)}_n$ .

Returns: celes_simulation object with updated initialFieldCoefficients

◆ computeInitialFieldPower()

function computeInitialFieldPower ( in obj )

Evaluate the power flux of the initial field.

Returns: celes_simulation object with updated initialFieldPower

◆ computeMieCoefficients()

function computeMieCoefficients ( in obj )

Evaluate the Mie coefficients.

Returns: celes_simulation object with updated mieCoefficients

◆ computeScatteredFieldCoefficients()

function computeScatteredFieldCoefficients	(	in	obj,
		in	varargin
	)

Compute the scattered field coefficients b by iteratively solving the linear system M*b=T*aI.

Parameters

Optional b0, initial guess for scattered field coefficients

Returns: celes_simulation object with updated initialFieldPower

◆ computeScatteredFieldPWP()

function computeScatteredFieldPWP ( in obj )

Compute the plane wave pattern of the scattered field (i.e., the expansion coefficients of the scattered field in plane vector wave functions)

Returns: celes_simulation object with updated output.scatteredFieldPlaneWavePattern

◆ computeTotalFieldPower()

function computeTotalFieldPower ( in obj )

Evaluate the power flux of the total field, both in forward and in backward direction.

Returns: celes_simulation object with updated output.totalFieldForwardPower and output.totalFieldBackwardPower

◆ computeTotalFieldPWP()

function computeTotalFieldPWP ( in obj )

Compute the plane wave pattern of the total field (i.e., the expansion coefficients of the scattered field in plane vector wave functions)

Returns: celes_simulation object with updated output.totalFieldPlaneWavePattern

◆ computeTranslationTable()

function computeTranslationTable ( in obj )

Prepare a lookup for the a and b coefficients for particle coupling.

Returns: celes_simulation object with updated translationTable

◆ evaluateFields()

function evaluateFields ( in obj )

Evaluate both the initial and the scattered (near)field at the positions specified in the input.

The field can then be plotted.

Returns: celes_simulation object with updated output.initialField and output.scatteredField

◆ evaluateInitialField()

function evaluateInitialField ( in obj )

Evaluate the initial (near)field at the positions specified in the input.

The field can then be plotted.

Returns: celes_simulation object with updated output.InitialField

◆ evaluateInternalField()

function evaluateInternalField ( in obj )

Evaluate the internal (near)field at the positions specified in the input.

The field can then be plotted.

Returns: celes_simulation object with updated output.internalField

◆ evaluatePower()

function evaluatePower ( in obj )

First prepare the scattered and total field's plane wave pattern, then evaluate the power flux.

Returns: celes_simulation object with updated scatteredFieldPlaneWavePattern, totalFieldPlaneWavePattern, output.totalFieldForwardPower and output.totalFieldBackwardPower

◆ evaluateScatteredField()

function evaluateScatteredField ( in obj )

Evaluate the scattered (near)field at the positions specified in the input.

The field can then be plotted.

Returns: celes_simulation object with updated output.scatteredField

◆ lookupParticleDistances()

function get lookupParticleDistances ( in obj )

get method for dependent property lookupParticleDistances

◆ masterMatrixMultiply()

function masterMatrixMultiply	(	in	obj,
		in	value,
		in	varargin
	)

Multiply the master matrix M=1-T*W to some vector x.

Parameters

Vector	x of incoming field SVWF coefficients
verbose	(logical, optional): If true (default), display detailed timing information

Returns: Vector M*x

◆ run()

function run	(	in	obj,
		in	varargin
	)

Run the simulation.

A simulation run includes:

computation of initial field power
computation of Mie coefficients
computation of the translation table
computation of the maximal distance between pairs of particles
preparation of the particle partitioning (if blockdiagonal preconditioner is active)
preparation of the blockdiagonal preconditioner (if active)
computation of initial field coefficients
solution of linear system

Parameters

Optional Initial guess b0 for the scattered field coefficients vector b

Returns: celes_simulation object with various fields updated

Member Data Documentation

◆ input

Property input

celes_input object which contains the parameters that specify the simulation geometry and initial field

◆ lookupParticleDistances

Property lookupParticleDistances

single array which contains a grid of distances used for the lookup of the spherical hankel function in the particle coupling

◆ numerics

Property numerics

celes_numerics object which contains the numerical settings

◆ output

Property output

celes_output object which contains the results of the simulation

◆ tables

Property tables

celes_tables object which contains lookup tables and other intermediate results

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

src/classes/celes_simulation.m

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ computeInitialFieldCoefficients()

◆ computeInitialFieldPower()

◆ computeMieCoefficients()

◆ computeScatteredFieldCoefficients()

◆ computeScatteredFieldPWP()

◆ computeTotalFieldPower()

◆ computeTotalFieldPWP()

◆ computeTranslationTable()

◆ evaluateFields()

◆ evaluateInitialField()

◆ evaluateInternalField()

◆ evaluatePower()

◆ evaluateScatteredField()

◆ lookupParticleDistances()

◆ masterMatrixMultiply()

◆ run()

Member Data Documentation

◆ input

◆ lookupParticleDistances

◆ numerics

◆ output

◆ tables