.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXmicrostructure_kanapy_results.nxdl.xml -- DO NOT EDIT .. index:: ! NXmicrostructure_kanapy_results (application definition) ! microstructure_kanapy_results (application definition) see: microstructure_kanapy_results (application definition); NXmicrostructure_kanapy_results .. _NXmicrostructure_kanapy_results: =============================== NXmicrostructure_kanapy_results =============================== **Status**: *application definition* (contribution), extends :ref:`NXobject` **Description**: .. collapse:: Application definition for the microstructure generator kanapy from ICAMS Bochum ... Application definition for the microstructure generator kanapy from ICAMS Bochum. * `A. Hartmeier et al. `_ A draft application definition to support discussion within the infrastructure use case IUC07 of the NFDI-MatWerk consortium of the German NFDI working on a data model for documenting simulations of spatiotemporal microstructure evolution with scientific software from this community. **Symbols**: **n_z**: Number of material points along the z axis of the domain. **n_y**: Number of material points along the y axis of the domain. **n_x**: Number of material points along the x axis of the domain. **c**: Number of crystals. **Groups cited**: :ref:`NXcg_grid`, :ref:`NXcollection`, :ref:`NXcs_profiling`, :ref:`NXdata`, :ref:`NXentry`, :ref:`NXmicrostructure_feature`, :ref:`NXmicrostructure`, :ref:`NXprogram`, :ref:`NXuser` .. index:: NXentry (base class); used in application definition, NXcs_profiling (base class); used in application definition, NXuser (base class); used in application definition, NXprogram (base class); used in application definition, NXcollection (base class); used in application definition, NXmicrostructure (base class); used in application definition, NXcg_grid (base class); used in application definition, NXdata (base class); used in application definition, NXmicrostructure_feature (base class); used in application definition **Structure**: .. _/NXmicrostructure_kanapy_results/ENTRY-group: :bolditalic:`ENTRY`: (required) :ref:`NXentry` .. _/NXmicrostructure_kanapy_results/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``NXmicrostructure_kanapy_results`` .. _/NXmicrostructure_kanapy_results/ENTRY/description-field: .. index:: description (field) **description**: (required) :ref:`NX_CHAR ` Discouraged free-text field to add further details to the computation. .. _/NXmicrostructure_kanapy_results/ENTRY/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/end_time-field: .. index:: end_time (field) **end_time**: (recommended) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/profiling-group: **profiling**: (optional) :ref:`NXcs_profiling` .. _/NXmicrostructure_kanapy_results/ENTRY/USER-group: :bolditalic:`USER`: (optional) :ref:`NXuser` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/program1-group: **program1**: (required) :ref:`NXprogram` .. _/NXmicrostructure_kanapy_results/ENTRY/program1/program-field: .. index:: program (field) **program**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/program1/program@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/program1/program@url-attribute: .. index:: url (field attribute) **@url**: (recommended) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/program2-group: **program2**: (required) :ref:`NXprogram` .. _/NXmicrostructure_kanapy_results/ENTRY/program2/program-field: .. index:: program (field) **program**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/program2/program@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/program2/program@url-attribute: .. index:: url (field attribute) **@url**: (recommended) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/environment-group: **environment**: (optional) :ref:`NXcollection` :ref:`⤆ ` Programs and libraries representing the computational environment .. _/NXmicrostructure_kanapy_results/ENTRY/environment/PROGRAM-group: :bolditalic:`PROGRAM`: (required) :ref:`NXprogram` .. _/NXmicrostructure_kanapy_results/ENTRY/environment/PROGRAM/program-field: .. index:: program (field) **program**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/environment/PROGRAM/program@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID-group: **microstructure**\ :bolditalic:`ID`: (required) :ref:`NXmicrostructure` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid-group: **grid**: (required) :ref:`NXcg_grid` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/extent-field: .. index:: extent (field) **extent**: (required) :ref:`NX_UINT ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/cell_dimensions-field: .. index:: cell_dimensions (field) **cell_dimensions**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/origin-field: .. index:: origin (field) **origin**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/symmetry-field: .. index:: symmetry (field) **symmetry**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure-group: **structure**: (required) :ref:`NXdata` :ref:`⤆ ` Default plot showing the grid. .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure@signal-attribute: .. index:: signal (group attribute) **@signal**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure@axes-attribute: .. index:: axes (group attribute) **@axes**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure@AXISNAME_indices-attribute: .. index:: AXISNAME_indices (group attribute) **@**\ :bolditalic:`AXISNAME`\ **_indices**: (required) :ref:`NX_UINT ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/title-field: .. index:: title (field) **title**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/indices_crystal-field: .. index:: indices_crystal (field) **indices_crystal**: (required) :ref:`NX_INT ` {units=\ :ref:`NX_UNITLESS `} Crystal identifier that was assigned to each material point. .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/z-field: .. index:: z (field) **z**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_y]) {units=\ :ref:`NX_LENGTH `} Material point barycenter coordinate along z direction. .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/z@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (required) :ref:`NX_CHAR ` Coordinate along z direction. .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/y-field: .. index:: y (field) **y**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_y]) {units=\ :ref:`NX_LENGTH `} Material point barycenter coordinate along y direction. .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/y@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (required) :ref:`NX_CHAR ` Coordinate along y direction. .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/x-field: .. index:: x (field) **x**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_x]) {units=\ :ref:`NX_LENGTH `} Material point barycenter coordinate along x direction. .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/x@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (required) :ref:`NX_CHAR ` Coordinate along x direction. .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals-group: **crystals**: (required) :ref:`NXmicrostructure_feature` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/reference-field: .. index:: reference (field) **reference**: (required) :ref:`NX_CHAR ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/number_of_crystals-field: .. index:: number_of_crystals (field) **number_of_crystals**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/number_of_phases-field: .. index:: number_of_phases (field) **number_of_phases**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/indices_crystal-field: .. index:: indices_crystal (field) **indices_crystal**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [c]) :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/indices_phase-field: .. index:: indices_phase (field) **indices_phase**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [c]) :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/area-field: .. index:: area (field) **area**: (recommended) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [c]) :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/volume-field: .. index:: volume (field) **volume**: (recommended) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [c]) :ref:`⤆ ` .. _/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/bunge_euler-field: .. index:: bunge_euler (field) **bunge_euler**: (required) :ref:`NX_FLOAT ` (Rank: 2, Dimensions: [c, 3]) {units=\ :ref:`NX_ANGLE `} Bunge-Euler angle orientation of each crystal. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXmicrostructure_kanapy_results/ENTRY-group ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/definition-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/description-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/end_time-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/environment-group ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/environment/PROGRAM-group ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/environment/PROGRAM/program-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/environment/PROGRAM/program@version-attribute ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID-group ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals-group ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/area-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/bunge_euler-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/indices_crystal-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/indices_phase-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/number_of_crystals-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/number_of_phases-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/reference-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/crystals/volume-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid-group ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/cell_dimensions-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/extent-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/origin-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure-group ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/indices_crystal-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/title-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/x-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/x@long_name-attribute ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/y-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/y@long_name-attribute ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/z-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure/z@long_name-attribute ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure@axes-attribute ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure@AXISNAME_indices-attribute ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/structure@signal-attribute ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/microstructureID/grid/symmetry-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/profiling-group ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/program1-group ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/program1/program-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/program1/program@url-attribute ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/program1/program@version-attribute ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/program2-group ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/program2/program-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/program2/program@url-attribute ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/program2/program@version-attribute ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/start_time-field ` * :ref:`/NXmicrostructure_kanapy_results/ENTRY/USER-group ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXmicrostructure_kanapy_results.nxdl.xml