Navigation: Scripting Reference Manual > Functions & Subroutines > GetMaterialAbsorb

 

GetMaterialAbsorb

 

Contact Us: fredsupport@photonengr.com

 

Description

Returns the absorption coefficient at a specified wavelength for a particular material in the associated FRED document.

 

Syntax

coef = GetMaterialAbsorb( id, wave )

 

Parameters

coef (Double)

Returns the absorption coefficient in inverse system units. If internal transmittance has been specified, returned value is converted to an absorption coefficient.

 

id As Long

The identifier of the material.

 

wave As Double

Wavelength for which absorption coefficient or internal transmittance value applies.

 

 

Remarks

This function returns the absorption coefficient at the specified wavelength for the given material. Absorption coefficients are expressed in inverse system units. If internal transmittance has been specified, returned value is converted to an absorption coefficient.  If there is a problem the subroutine sets an error and returns without modifying the material.

 

See Also

SetMaterialAbsorb

GetMaterialAbsorbFlag

SetMaterialAbsorbFlag

FindMaterialAbsorbWavel

GetIthMaterialAbsorb

SetIthMaterialAbsorbWavel

SetIthMaterialAbsorbCoeff

SetIthMaterialAbsorb

MaterialAbsorbCount

DeleteIthMaterialAbsorb

Examples

Materials

 

 

 

 

 

Copyright © Photon Engineering, LLC