Navigation: Scripting Reference Manual > Functions & Subroutines > FiberCoupleGaussian

 

FiberCoupleGaussian

 

Contact Us: fredsupport@photonengr.com

 

Description

Performs the Fiber Coupling calculation at a given surface using an attached Analysis Surface and return the real and imaginary part of the coupling coefficient.  The power efficiency is then calculated as coupleReal*coupleReal + coupleImag*coupleImag.

 

Depending on the number of rays traced, it may be necessary to dimension ray index and ray counter variables as data type Huge_ instead of Long.  Please see Multi-threaded Raytracing for more information.

 

Syntax

count = FiberCoupleGaussian( coupleReal, coupleImag, nEntity, nCoordSys, ana, semiApeGaus )

 

Parameters

count (Long or Huge_)

The number of rays used in the calculation.

 

coupleReal As Double

Return value of the real part of the coupling coefficient.

 

coupleImag As Double

Return value of the imaginary part of the coupling coefficient.

 

nEntity As Long

Include in the calculation only those rays on the entity with the given node number nEntity.

 

nCoordSys As Long

Identifier of the FRED entity whose coordinate system the data in the analysis parameter is expressed.

 

ana As T_ANALYSIS

Data structure defining the Analysis Surface on which the calculation will be performed.

 

semiApeGaus As Double

Semi-width of the Gaussian 1/e amplitude point.

 

See Also

Fiber Coupling Efficiency

FiberCoupleStepIndex

Irradiance

Intensity

 

 

 

 

 

Copyright © Photon Engineering, LLC