Expansion of a field in plane vector wave functions. More...

Public Member Functions
function	celes_planeWavePattern (in varargin)
	Constructor method. More...

function get	polarAnglesGrid (in obj)
	Get method for polarAnglesGrid. More...

function get	azimuthalAnglesGrid (in obj)
	Get method for azimuthalAnglesGrid. More...

function get	kparArray (in obj)
	Get method for kparArray. More...

function get	kzArray (in obj)
	Get method for kzArray. More...

function get	kxGrid (in obj)
	Get method for kxGrid. More...

function get	kyGrid (in obj)
	Get method for kyGrid. More...

function get	kparGrid (in obj)
	Get method for kparGrid. More...

function get	kzGrid (in obj)
	Get method for kzGrid. More...

function	addTo (in obj, in obj2)
	Add this plane wave pttern to another one. More...

Public Attributes
Property	polarAngles
	array of polar angle values (in rad) More...

Property	azimuthalAngles
	array of azimuthal angle values (in rad) More...

Property	k
	wavenumber More...

Property	expansionCoefficients
	coefficients of the PVWF expansion More...

Property	polarAnglesGrid
	meshigrid of polar angles More...

Property	azimuthalAnglesGrid
	meshigrid of azimuthal angles More...

Property	kparArray
	array of cylindrical radial components of wave vector More...

Property	kzArray
	array of cylindrical z-components of wave vector More...

Property	kparGrid
	meshgrid of cylindrical radial components of wave vector More...

Property	kzGrid
	meshgrid of z-components of wave vector More...

Property	kxGrid
	meshgrid of x-components of wave vector More...

Property	kyGrid
	meshgrid of y-components of wave vector More...

Detailed Description

Expansion of a field in plane vector wave functions.

Constructor & Destructor Documentation

◆ celes_planeWavePattern()

function celes_planeWavePattern ( in varargin )

Constructor method.

Member Function Documentation

◆ addTo()

function addTo	(	in	obj,
		in	obj2
	)

Add this plane wave pttern to another one.

Parameters

celes_planeWavePattern pwp2

Returns: celes_planeWavePattern as the sum of this one with pwp2

◆ azimuthalAnglesGrid()

function get azimuthalAnglesGrid ( in obj )

Get method for azimuthalAnglesGrid.

◆ kparArray()

function get kparArray ( in obj )

Get method for kparArray.

◆ kparGrid()

function get kparGrid ( in obj )

Get method for kparGrid.

◆ kxGrid()

function get kxGrid ( in obj )

Get method for kxGrid.

◆ kyGrid()

function get kyGrid ( in obj )

Get method for kyGrid.

◆ kzArray()

function get kzArray ( in obj )

Get method for kzArray.

◆ kzGrid()

function get kzGrid ( in obj )

Get method for kzGrid.

◆ polarAnglesGrid()

function get polarAnglesGrid ( in obj )

Get method for polarAnglesGrid.

Member Data Documentation

◆ azimuthalAngles

Property azimuthalAngles

array of azimuthal angle values (in rad)

◆ azimuthalAnglesGrid

Property azimuthalAnglesGrid

meshigrid of azimuthal angles

◆ expansionCoefficients

Property expansionCoefficients

coefficients of the PVWF expansion

◆ k

Property k

wavenumber

◆ kparArray

Property kparArray

array of cylindrical radial components of wave vector

◆ kparGrid

Property kparGrid

meshgrid of cylindrical radial components of wave vector

◆ kxGrid

Property kxGrid

meshgrid of x-components of wave vector

◆ kyGrid

Property kyGrid

meshgrid of y-components of wave vector

◆ kzArray

Property kzArray

array of cylindrical z-components of wave vector

◆ kzGrid

Property kzGrid

meshgrid of z-components of wave vector

◆ polarAngles

Property polarAngles

array of polar angle values (in rad)

◆ polarAnglesGrid

Property polarAnglesGrid

meshigrid of polar angles

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

src/classes/celes_planeWavePattern.m

Public Member Functions

Public Attributes