2.3.3.3.102. NXdispersive_material

Status:

application definition, extends NXobject

Description:

NXdispersion

Symbols:

No symbol table

Groups cited:

NXcite, NXdata, NXdispersion_function, NXdispersion_repeated_parameter, NXdispersion_single_parameter, NXdispersion_table, NXdispersion, NXentry, NXsample

Structure:

ENTRY: (required) NXentry

definition: (required) NX_CHAR ⤆

An application definition for a dispersive material. ...

An application definition for a dispersive material.

Obligatory value: NXdispersive_material

@version: (required) NX_CHAR ⤆

Version number to identify which definition of this application definition ...

Version number to identify which definition of this application definition was used for this entry/data.

@url: (required) NX_CHAR ⤆

URL where to find further material (documentation, examples) relevant to t ...

URL where to find further material (documentation, examples) relevant to the application definition

dispersion_type: (recommended) NX_CHAR

Denotes whether the dispersion is calculated or derived from an experiment ...

Denotes whether the dispersion is calculated or derived from an experiment

Any of these values: measured | simulated

sample: (required) NXsample ⤆

chemical_formula: (required) NX_CHAR ⤆

atom_types: (optional) NX_CHAR

List of comma-separated elements from the periodic table ...

List of comma-separated elements from the periodic table that are contained in the sample. If the sample substance has multiple components, all elements from each component must be included in atom_types.

colloquial_name: (optional) NX_CHAR

The colloquial name of the material, e.g. graphite or diamond for carbon.

material_phase: (optional) NX_CHAR

The phase of the material ...

The phase of the material

Any of these values: gas | liquid | solid | other

material_phase_comment: (optional) NX_CHAR

Additional information about the phase if the ...

Additional information about the phase if the material phase is other.

additional_phase_information: (recommended) NX_CHAR

This field may be used to denote additional phase information, ...

This field may be used to denote additional phase information, such as crystalin phase of a crystal (e.g. 4H or 6H for SiC) or if a measurement was done on a thin film or bulk material.

REFERENCES: (recommended) NXcite

text: (required) NX_CHAR

A text description of this reference, e.g. ...

A text description of this reference, e.g. E. Example et al, The mighty example, An example journal 50 (2023), 100

doi: (required) NX_CHAR ⤆

dispersion_x: (required) NXdispersion

The dispersion along the optical axis of the material. ...

The dispersion along the optical axis of the material. This should be the only dispersion available for isotropic materials. For uniaxial materials this denotes the ordinary axis. For biaxial materials this denotes the x axis or epsilon 11 tensor element of the diagionalized permittivity tensor.

model_name: (required) NX_CHAR ⤆

The name of this dispersion model.

DISPERSION_TABLE: (recommended) NXdispersion_table ⤆

model_name: (required) NX_CHAR ⤆

convention: (required) NX_CHAR ⤆

wavelength: (required) NX_NUMBER ⤆

dielectric_function: (recommended) NX_COMPLEX ⤆

refractive_index: (recommended) NX_COMPLEX ⤆

DISPERSION_FUNCTION: (recommended) NXdispersion_function ⤆

model_name: (required) NX_CHAR ⤆

formula: (required) NX_CHAR ⤆

convention: (required) NX_CHAR ⤆

energy_identifier: (recommended) NX_CHAR ⤆

energy_unit: (recommended) NX_NUMBER ⤆

wavelength_identifier: (recommended) NX_CHAR ⤆

wavelength_unit: (recommended) NX_NUMBER ⤆

representation: (required) NX_CHAR ⤆

DISPERSION_SINGLE_PARAMETER: (required) NXdispersion_single_parameter ⤆

name: (required) NX_CHAR ⤆

value: (required) NX_NUMBER ⤆

DISPERSION_REPEATED_PARAMETER: (required) NXdispersion_repeated_parameter ⤆

name: (required) NX_CHAR ⤆

values: (required) NX_NUMBER ⤆

plot: (recommended) NXdata

dispersion_y: (optional) NXdispersion

This should only be filled for biaxial materials. ...

This should only be filled for biaxial materials. It denotes the epsilon 22 direction of the diagionalized permittivity tensor.

model_name: (required) NX_CHAR ⤆

The name of this dispersion model.

DISPERSION_TABLE: (recommended) NXdispersion_table ⤆

model_name: (required) NX_CHAR ⤆

convention: (required) NX_CHAR ⤆

wavelength: (required) NX_NUMBER ⤆

dielectric_function: (recommended) NX_COMPLEX ⤆

refractive_index: (recommended) NX_COMPLEX ⤆

DISPERSION_FUNCTION: (recommended) NXdispersion_function ⤆

model_name: (required) NX_CHAR ⤆

formula: (required) NX_CHAR ⤆

convention: (required) NX_CHAR ⤆

energy_identifier: (recommended) NX_CHAR ⤆

energy_unit: (recommended) NX_NUMBER ⤆

wavelength_identifier: (recommended) NX_CHAR ⤆

wavelength_unit: (recommended) NX_NUMBER ⤆

representation: (required) NX_CHAR ⤆

DISPERSION_SINGLE_PARAMETER: (required) NXdispersion_single_parameter ⤆

name: (required) NX_CHAR ⤆

value: (required) NX_NUMBER ⤆

DISPERSION_REPEATED_PARAMETER: (required) NXdispersion_repeated_parameter ⤆

name: (required) NX_CHAR ⤆

values: (required) NX_NUMBER ⤆

plot: (recommended) NXdata

dispersion_z: (optional) NXdispersion

This should only be filled for uniaxial or biaxial materials. ...

This should only be filled for uniaxial or biaxial materials. For uniaxial materials this denotes the extraordinary axis. For biaxial materials this denotes the epsilon 33 tensor element of the diagionalized perimittivty tensor.

model_name: (required) NX_CHAR ⤆

The name of this dispersion model.

DISPERSION_TABLE: (recommended) NXdispersion_table ⤆

model_name: (required) NX_CHAR ⤆

convention: (required) NX_CHAR ⤆

wavelength: (required) NX_NUMBER ⤆

dielectric_function: (recommended) NX_COMPLEX ⤆

refractive_index: (recommended) NX_COMPLEX ⤆

DISPERSION_FUNCTION: (recommended) NXdispersion_function ⤆

model_name: (required) NX_CHAR ⤆

formula: (required) NX_CHAR ⤆

convention: (required) NX_CHAR ⤆

energy_identifier: (recommended) NX_CHAR ⤆

energy_unit: (recommended) NX_NUMBER ⤆

wavelength_identifier: (recommended) NX_CHAR ⤆

wavelength_unit: (recommended) NX_NUMBER ⤆

representation: (required) NX_CHAR ⤆

DISPERSION_SINGLE_PARAMETER: (required) NXdispersion_single_parameter ⤆

name: (required) NX_CHAR ⤆

value: (required) NX_NUMBER ⤆

DISPERSION_REPEATED_PARAMETER: (required) NXdispersion_repeated_parameter ⤆

name: (required) NX_CHAR ⤆

values: (required) NX_NUMBER ⤆

plot: (recommended) NXdata

Hypertext Anchors

List of hypertext anchors for all groups, fields, attributes, and links defined in this class.

NXDL Source:

https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXdispersive_material.nxdl.xml