#include <F5Path.h>

Data Fields
ChartDomain_IDs *	myChart
ChartDomain_IDs *	FileIDs
char *	field_info
hid_t	field_enum_type_hid
hid_t	File_hid
hid_t	ContentsGroup_hid
hid_t	Slice_hid
hid_t	Grid_hid
hid_t	GlobalChart_hid
hid_t	Charts_hid
hid_t	Chart_hid
hid_t	Topology_hid
hid_t	Representation_hid
hid_t	Field_hid

Detailed Description

Field identifiers. This structure contains all HDF5 identifiers that describe a path in an HDF5 file towards a field structure. Each or all may be empty (null or negative) as well.

Examples: ADCIRCtoF5.cpp, FragmentedField.c, ObjtoF5.c, RegularReader.c, SchwarzschildF5.c, and mm5-nc2F5.c.

Definition at line 30 of file F5Path.h.

Field Documentation

◆ Chart_hid

hid_t F5Path::Chart_hid

ID of currently used chart that is valid for the field

Definition at line 56 of file F5Path.h.

Referenced by F5Bopen_coordinate_domain(), F5close(), F5iterate_grid_atlas(), F5iterate_topologies(), F5iterate_topology_fields(), and F5LTcreateV().

◆ Charts_hid

hid_t F5Path::Charts_hid

Group of all charts per grid

Definition at line 55 of file F5Path.h.

Referenced by F5Bopen_coordinate_domain(), F5close(), F5iterate_topologies(), F5iterate_topology_fields(), and F5LTcreateV().

◆ ContentsGroup_hid

hid_t F5Path::ContentsGroup_hid

The TableOfContents group ID

Definition at line 51 of file F5Path.h.

Referenced by F5Bopen_coordinate_domain(), F5close(), F5I_add_field(), F5I_add_grid(), F5LTcreateV(), and F5LTmake_enum_type().

◆ field_enum_type_hid

hid_t F5Path::field_enum_type_hid

The field enum type for this file. If none is defined here, then F5Ttransient_F5field_enum() is to be used, but on first write access to a file then F5Tsave_F5field_enum() is to be called. This field type may also refer to a type loaded from a disc, and may then contain versioning information about the field descriptions within this file.

Definition at line 48 of file F5Path.h.

Referenced by F5Bopen_coordinate_domain(), F5close(), F5LTcreateV(), and F5LTmake_enum_type().

◆ Field_hid

hid_t F5Path::Field_hid

ID of the field (can be group or dataset ID)

Definition at line 59 of file F5Path.h.

Referenced by F5close(), F5Fclose(), F5Fcreate(), F5Ffragment_is_group(), F5Fget_attribute(), F5Fget_attribute_byname(), F5Fget_attribute_nr_elements(), F5Fget_field_enum(), F5Fget_string_attribute(), F5Fget_type2(), F5Fgrab(), F5Fhas_attribute(), F5Fhas_fragment_attribute(), F5Fis_attribute_of_type(), F5Fis_group(), F5Fopen(), F5Fopen_group_or_dataset(), F5Fread_linear(), F5Fset_attribute(), F5Fset_attribute_byname(), F5Fset_fragment_attribute(), F5Fset_string_attribute(), F5FSwrite_fraction(), F5Fwrite_1D(), F5Fwrite_flexible(), F5Fwrite_fraction(), F5Fwrite_fraction_external(), F5Fwrite_fractionS(), F5Fwrite_linear(), F5Fwrite_linear_fraction(), F5Fwrite_linear_fraction_overlap(), F5FwriteIMAGE(), F5Fwrites(), F5FwriteX(), F5I_add_field(), F5iterate_field_fragments(), F5Rcreate_rectilinear(), F5Rcreate_uniform_sparse(), F5Tget_space(), F5write_particle_cartesian3Dv(), F5write_particle_cartesian3DvU(), and F5write_particle_double_cartesian3Dv().

◆ field_info

char* F5Path::field_info

A textual description from F5contents.h

Definition at line 37 of file F5Path.h.

◆ File_hid

hid_t F5Path::File_hid

Reference to file ID

Definition at line 50 of file F5Path.h.

Referenced by deleteF5Path(), F5Flink_triangular_surface(), and newF5Path().

◆ FileIDs

ChartDomain_IDs * F5Path::FileIDs

Chart domain ID's as they are committed in the file

Definition at line 35 of file F5Path.h.

Referenced by F5Bopen_coordinate_domain(), F5close(), F5Cwrite_regular_surface(), F5Cwrite_triangular_surface_vc(), F5file_type(), F5Flink_triangular_surface(), F5LTcreateV(), and F5write_particle_cartesian3DvU().

◆ GlobalChart_hid

hid_t F5Path::GlobalChart_hid

Global chart group

Definition at line 54 of file F5Path.h.

Referenced by F5Bopen_coordinate_domain(), F5close(), F5FB_read_global_chart(), F5file_type(), F5FwriteX(), F5LTcreateV(), and F5Tmake_precise_tensor().

◆ Grid_hid

hid_t F5Path::Grid_hid

◆ myChart

ChartDomain_IDs* F5Path::myChart

Chart domain ID's as they reside in memory

Definition at line 33 of file F5Path.h.

Referenced by F5Bopen_coordinate_domain(), F5close(), F5FB_read_global_chart(), F5Fcreate(), F5file_type(), F5LTcreateV(), F5Rcreate_rectilinear(), F5Rcreate_uniformd(), F5Rcreate_uniformf(), F5Tmake_precise_tensor(), and F5Tpermute_dimensions().

◆ Representation_hid

hid_t F5Path::Representation_hid

Representation group ID (the group containing all datasets)

Examples: ObjtoF5.c.

Definition at line 58 of file F5Path.h.

Referenced by F5Bopen_coordinate_domain(), F5close(), F5Cwrite_regular_surface(), F5Fcreate(), F5Fget_field_enum(), F5Fis_linear(), F5Flink_triangular_surface(), F5Fopen(), F5FSwrite_fraction(), F5Fwrite_1D(), F5Fwrite_flexible(), F5Fwrite_fraction(), F5Fwrite_fraction_external(), F5Fwrite_fractionS(), F5Fwrite_linear(), F5Fwrite_linear_fraction(), F5FwriteIMAGE(), F5Fwrites(), F5FwriteX(), F5iterate_fields(), F5iterate_representations(), F5iterate_topologies(), F5iterate_topology_fields(), F5LTcreateV(), F5Rcreate_relative_vertex_Irefinement3D(), F5Rcreate_relative_vertex_Qrefinement3D(), F5Rcreate_uniform_sparse(), F5write_particle_cartesian3Dv(), F5write_particle_cartesian3DvU(), and F5write_particle_double_cartesian3Dv().

◆ Slice_hid

hid_t F5Path::Slice_hid

HDF5 Slice Group (uppermost group)

Definition at line 52 of file F5Path.h.

Referenced by F5Bopen_coordinate_domain(), F5close(), F5iterate_grids(), and F5LTcreateV().

◆ Topology_hid

hid_t F5Path::Topology_hid

ID of the grid's topological space (e.g. refinement level)

Examples: ObjtoF5.c.

Definition at line 57 of file F5Path.h.

Referenced by F5Bopen_coordinate_domain(), F5close(), F5get_extension(), F5iterate_representations(), F5iterate_topologies(), F5iterate_topology_fields(), F5iterate_vertex_fields(), F5LTcreateV(), F5LTexpand_dataspace(), F5LTset_dataspace(), F5P_has_vertices(), F5P_is_curvilinear(), F5P_is_rectilinear(), F5P_is_uniform(), F5Tget_index_depth(), and F5Tget_space().

The documentation for this struct was generated from the following file:

F5Path.h

Data Fields