This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
There are different material classes possible that can contain material properties with different definition. All material classes have to have this interface to access the material properties. More...

Inheritance diagram for Material:

Public Member Functions
override object	Clone ()
	Create deep copy of object More...

abstract bool	Edit ()
	Calls the edit dialog of the catalog entry. More...

override bool	Equals (object obj, EqualityIntent equalityIntent)
	Determines whether two materials are equal, i.e. whether all properties have the same value. More...

abstract double	GetAbsorptionCoeff (double wavelength)
	Returns the absorption for the specified Wavelength. Is no absorption for this Wavelength defined an ArgumentException is thrown. More...

abstract void	GetAbsorptionMinMaxWavelength (out double minWavelength, out double maxWavelength)
	Returns minimum and maximum Wavelength for that a absorption is available. More...

Complex	GetComplexRefractiveIndex (double vacuumWavelength, double temperatureInDegrees, double pressureInPascal)
	Returns the absolutely defined complex refractive index for the given wavelength More...

void	GetMinMaxWavelength (out double minWavelength, out double maxWavelength)
	Returns the valid min/max wavelength of the medium. More...

double	GetRealRefractiveIndex (double vacuumWavelength, bool checkForValidWavelengthRange, double temperatureInDegrees, double pressureInPascal)
	Returns the absolutely defined (!) refractive index for the specified Wavelength. If there is no refractive index for this Wavelength given, an ArgumentException is thrown. More...

double	GetRealRefractiveIndex (double vacuumWavelength, double temperatureInDegrees, double pressureInPascal)
	Returns the absolutely defined refractive index for the specified Wavelength. Is no refractive index for this Wavelength given, an ArgumentException is thrown. More...

abstract double	GetRealRefractiveIndexAsDefined (double wavelength, bool checkForValidWavelengthRange=true, double vacuumWavelengthIfKnown=0, double temperatureInDegrees=20, double pressureInPascal=Globals.PascalsPerAtm)
	Returns the refractive index relative to air for the specified Wavelength. Is no refractive index for this Wavelength defined an ArgumentException is thrown. More...

abstract void	GetRealRefractiveIndexMinMaxWavelength (out double minWavelength, out double maxWavelength, bool giveVacuumWavelengths)
	Returns wavelength range for that a refractive index is available. If `giveVacuumWavelengths` is `true`, the values are vacuum wavelengths, otherwise they refer to the reference material. More...

PhysicalValueRange	GetRealRefractiveIndexWavelengthRange (bool giveVacuumWavelengths=true)
	Gets the valid wavelength range for calculating real refractive indices. More...

double	GetTemperatureInducedRefractiveIndexChange (double temperatureInDegrees, double refractiveIndexAtStandardConditions, double vacuumWavelength)
	Method which calculates the change in the real refractive index which is caused by a temperature difference (between the application temperature and the measurement temperature). More...

PhysicalValueRange	GetWavelengthRange ()
	Gets the allowed wavelength range which is the intersection of the allowed wavelength range for the real part of the refractive index and for the absorption index. More...

virtual bool	IsConsistent (out ArrayList messageList)
	Virtual method to check the consistency of the material More...

	Material ()
	Standard constructor

void	Reload ()
	Reload method for this document

Static Public Member Functions
static Material	FromResource (byte[] resource)
	Loads a material from the Resources included in the VirtualAPI.dll. More...

static double	GetAbsorptionCoefficient (Complex complRefractiveIndex, double wavelength)
	Calculates the absorption coefficient from given complex refractive index. More...

static Material	Load (string fileName)
	Load constructor More...

Public Attributes
bool	RefractiveIndexDefinedAsAbsolute
	Is the given refractive index defined as absolute or as relative to the reference material?

Properties
Type	CatalogClass `[get]`
	The catalogs are of type MaterialsCatalog

string	CatalogName `[get, set]`
	Name of the catalog the material belongs to

CatalogDefinitionType	CatalogType `[get, set]`
	Type of the catalog

List< string >	Categories `[get, set]`
	Each string in the list represents one category the catalog belongs to. The format is "subcatalog\|subsubcatalog...".

EditedInType	EditedWithin `[get, set]`
	Gets and sets how to show the edit dialog of the interface. Must be set prior to calling the edit dialog. More...

string	HelpChapterPreview `[get]`
	The help chapter for the preview of the ICatalogEntry

bool	IsEditable `[get]`
	Flag which defines whether the catalog entry is editable

string	Name `[get, set]`
	Name of the material. Has to be unique if material shall be stored into a catalog.

abstract List< Parameter >	ParameterRunParameters `[get]`
	public property to get the parameters used for parameter run

Material	ReferenceMaterial `[get, set]`
	Get and set the reference material the relative refractive indices are related to (usually air). If a new reference material is set, this material is set to relatively defined refractive indices.

StateOfMatter	StateOfMatter `[get, set]`
	State of matter of this material

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
There are different material classes possible that can contain material properties with different definition. All material classes have to have this interface to access the material properties.

Member Function Documentation

◆ Clone()

override object Clone ( )

Create deep copy of object

Returns: the cloned object

◆ Edit()

abstract bool Edit ( )

pure virtual

Calls the edit dialog of the catalog entry.

Returns: TRUE: Editing was successful.

◆ Equals()

override bool Equals	(	object	obj,
		EqualityIntent	equalityIntent
	)

Determines whether two materials are equal, i.e. whether all properties have the same value.

Parameters

obj	The material to compare with this material.
equalityIntent	Defines what kind of equality you want to check when comparing two objects, for example all values or physical equality.

Returns: True if the properties and variables of both materials are equal.

◆ FromResource()

static Material FromResource ( byte[] resource )

static

Loads a material from the Resources included in the VirtualAPI.dll.

Parameters

resource The resource (= material) to load

Returns: The loaded material.

◆ GetAbsorptionCoeff()

abstract double GetAbsorptionCoeff ( double wavelength )

pure virtual

Returns the absorption for the specified Wavelength. Is no absorption for this Wavelength defined an ArgumentException is thrown.

Parameters

wavelength Wavelength for that the absorption should be returned.

Returns: Absorption for this wavelength.

◆ GetAbsorptionCoefficient()

static double GetAbsorptionCoefficient	(	Complex	complRefractiveIndex,
		double	wavelength
	)

static

Calculates the absorption coefficient from given complex refractive index.

Parameters

complRefractiveIndex	Complex refractive index
wavelength	The vacuum wavelength needed for the conversion from the imaginary part of the refractive index to the absorption coefficient.

Returns: The absorption coefficient.

◆ GetAbsorptionMinMaxWavelength()

abstract void GetAbsorptionMinMaxWavelength	(	out double	minWavelength,
		out double	maxWavelength
	)

pure virtual

Returns minimum and maximum Wavelength for that a absorption is available.

Parameters

minWavelength	Minimum Wavelength.
maxWavelength	Maximum Wavelength.

◆ GetComplexRefractiveIndex()

Complex GetComplexRefractiveIndex	(	double	vacuumWavelength,
		double	temperatureInDegrees,
		double	pressureInPascal
	)

Returns the absolutely defined complex refractive index for the given wavelength

Parameters

vacuumWavelength	The vacuum wavelength needed for the calculation of the refractive index.
temperatureInDegrees	Temperature to get the index for.
pressureInPascal	Pressure to get the index for.

Returns: The complex refractive index

◆ GetMinMaxWavelength()

void GetMinMaxWavelength	(	out double	minWavelength,
		out double	maxWavelength
	)

Returns the valid min/max wavelength of the medium.

Parameters

minWavelength	Returns the larger wavelength of both the minimum wavelength for refractive indices and absorption coefficients.
maxWavelength	Returns the smaller wavelength of both the maximum wavelength for refractive indices and absorption coefficients.

◆ GetRealRefractiveIndex() [1/2]

double GetRealRefractiveIndex	(	double	vacuumWavelength,
		bool	checkForValidWavelengthRange,
		double	temperatureInDegrees,
		double	pressureInPascal
	)

Returns the absolutely defined (!) refractive index for the specified Wavelength. If there is no refractive index for this Wavelength given, an ArgumentException is thrown.

Parameters

vacuumWavelength	Vacuum wavelength the refractive index should be returned for.
checkForValidWavelengthRange	If `false`, no check is done whether the wavelength is valid. This option should ever be `true`, except for the case of calculating the vacuum wavelength, where a stack overflow has to be avoided.
temperatureInDegrees	The temperature in degrees Celsius to calculate the refractive index for.
pressureInPascal	The pressure in pascals to calculate the refractive index for.

Returns: Refractive index for this wavelength.

◆ GetRealRefractiveIndex() [2/2]

double GetRealRefractiveIndex	(	double	vacuumWavelength,
		double	temperatureInDegrees,
		double	pressureInPascal
	)

Returns the absolutely defined refractive index for the specified Wavelength. Is no refractive index for this Wavelength given, an ArgumentException is thrown.

Parameters

vacuumWavelength	Vacuum wavelength the refractive index should be returned for.
temperatureInDegrees	The temperature in degrees Celsius to calculate the refractive index for.
pressureInPascal	The pressure in pascals to calculate the refractive index for.

Returns: Refractive index for this wavelength.

◆ GetRealRefractiveIndexAsDefined()

abstract double GetRealRefractiveIndexAsDefined	(	double	wavelength,
		bool	checkForValidWavelengthRange = `true`,
		double	vacuumWavelengthIfKnown = `0`,
		double	temperatureInDegrees = `20`,
		double	pressureInPascal = `Globals.PascalsPerAtm`
	)

pure virtual

Returns the refractive index relative to air for the specified Wavelength. Is no refractive index for this Wavelength defined an ArgumentException is thrown.

Parameters

wavelength	Wavelength (as measured in reference material) for that the refractive index should be returned.
checkForValidWavelengthRange	If `false`, no check is done whether the wavelength is valid. This option should ever be `true`, except for the case of calculating the vacuum wavelength, where a stack overflow has to be avoided.
vacuumWavelengthIfKnown	If known and checkForValidWavelengthRange == true, the vacuum wavelength must not be calculated again for checking the valid wavelength range.
temperatureInDegrees	The temperature in degrees Celsius to calculate the refractive index for.
pressureInPascal	The pressure in pascals to calculate the refractive index for.

Returns: Refractive index for this wavelength.

◆ GetRealRefractiveIndexMinMaxWavelength()

abstract void GetRealRefractiveIndexMinMaxWavelength	(	out double	minWavelength,
		out double	maxWavelength,
		bool	giveVacuumWavelengths
	)

pure virtual

Returns wavelength range for that a refractive index is available. If giveVacuumWavelengths is true, the values are vacuum wavelengths, otherwise they refer to the reference material.

Parameters

minWavelength	Minimum Wavelength.
maxWavelength	Maximum Wavelength.
giveVacuumWavelengths	If true, the wavelength range of the reference material's refractive index will be considered, and vacuum wavelengths will be returned. If the material is defined absolutely, the parameter will be ignored.

◆ GetRealRefractiveIndexWavelengthRange()

PhysicalValueRange GetRealRefractiveIndexWavelengthRange ( bool giveVacuumWavelengths = true )

Gets the valid wavelength range for calculating real refractive indices.

Parameters

giveVacuumWavelengths If true, the wavelength range of the reference material's refractive index will be considered, and vacuum wavelengths will be returned. If the material is defined absolutely, the parameter will be ignored. This optional parameter is true by default.

Returns: The valid wavelength range of the medium.

◆ GetTemperatureInducedRefractiveIndexChange()

double GetTemperatureInducedRefractiveIndexChange	(	double	temperatureInDegrees,
		double	refractiveIndexAtStandardConditions,
		double	vacuumWavelength
	)

Method which calculates the change in the real refractive index which is caused by a temperature difference (between the application temperature and the measurement temperature).

Parameters

temperatureInDegrees	Application temperature in degrees Celsius.
refractiveIndexAtStandardConditions	The refractive index at standard (i.e. measurement) conditions.
vacuumWavelength	The vacuum wavelength to get the refractive index for.

Returns: The refractive index change.

◆ GetWavelengthRange()

PhysicalValueRange GetWavelengthRange ( )

Gets the allowed wavelength range which is the intersection of the allowed wavelength range for the real part of the refractive index and for the absorption index.

Returns: The allowed wavelength range of the material. Null if the two wavelength ranges do not overlap.

◆ IsConsistent()

virtual bool IsConsistent ( out ArrayList messageList )

virtual

Virtual method to check the consistency of the material

Parameters

messageList Array of ConsistenyErrorOrWarning objects

Returns: True if there is no error

◆ Load()

static Material Load ( string fileName )

static

Load constructor

Parameters

fileName

Property Documentation

◆ EditedWithin

EditedInType EditedWithin

getset

Gets and sets how to show the edit dialog of the interface. Must be set prior to calling the edit dialog.

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ Clone()

◆ Edit()

◆ Equals()

◆ FromResource()

◆ GetAbsorptionCoeff()

◆ GetAbsorptionCoefficient()

◆ GetAbsorptionMinMaxWavelength()

◆ GetComplexRefractiveIndex()

◆ GetMinMaxWavelength()

◆ GetRealRefractiveIndex() [1/2]

◆ GetRealRefractiveIndex() [2/2]

◆ GetRealRefractiveIndexAsDefined()

◆ GetRealRefractiveIndexMinMaxWavelength()

◆ GetRealRefractiveIndexWavelengthRange()

◆ GetTemperatureInducedRefractiveIndexChange()

◆ GetWavelengthRange()

◆ IsConsistent()

◆ Load()

Property Documentation

◆ EditedWithin