Upload README.txt

README.txt

@@ -3,6 +3,110 @@
 
 	# # # PHASE-FIELD # # #
 
+	This repository contains simulation output data organizedi into compressed .tag.gz archives of HDF5 (.h5) files. The data is goruped under 5 different material directories and 2 boundary condition subdirectories containing a sequence of tarballs (e.g.):
+
+	PHASE-FIELD/
+	├── aluminum/
+	│   ├── combined_bc/
+	│      ├── xz_batch_000.tar.gz
+	│      ├── xz_batch_001.tar.gz
+	│   ├── horizontal_bc/
+	│      ├── z_batch_000.tar.gz
+	│      └── ...
+	├── pbx/
+	│   ├── combined_bc/
+	│   ├── horizontal_bc/
+	│      ├── z_batch_000.tar.gz
+	│      └── ...
+	└── shale/
+	│   ├── combined_bc/
+	│   ├── horizontal_bc/
+	│      ├── z_batch_000.tar.gz
+	│      └── ...
+	...
+
+	Each .tar.gz archive holds 1000 compressed HDF5 (.h5) files. The .h5 files are named using the following convention:
+
+	frac_pull_{bc}_{modnum}.h5
+
+	where {bc} represents the boundary condtion types [z,xz] (uniaxial,biaxial) {modnum} represents the simulation (or model) number.
+
+		# # Stucture of each .h5 file # #
+
+		Each HDF5 file contains fracture simulatio ndata and is orgnize by a consistent set of keys:
+
+			grid points
+		 dtype: int32
+		The number of gird points in the simulation.
+
+			model {modnum} break time
+		float
+		Represents the simulation time-to-failure.
+
+			model {modnum} fracture at time = {time}
+		numpy array of shape (128,128)
+		dtype: float32
+		Represents the phase-field scalar variable at each time across the model domain
+
+			model {modnum} fracture initial
+		numpy array of shape (128,128)
+		dtype: float32
+		The initial (unfractured) state of the model before any deformation.
+
+			model {modnum} fracture final
+		numpy array of shape (128,128)
+		dtype: float32
+		The final fracture configuration at the time-to-failure.
+
+			origin
+		dtype: int32
+		Represents the origin coordinate.
+
+			spacing
+		dtype: int32
+		Represents the simulation spacing.
+
+			# .h5 file keys example #
+
+			== Keys In File ==
+			grid points
+			model 100195 break time
+			model 100195 fracture at time = 1.0999999E-04
+			model 100195 fracture at time = 1.2000000E-04
+			model 100195 fracture at time = 1.3000000E-04
+			model 100195 fracture at time = 1.3999999E-04
+			model 100195 fracture at time = 1.4999999E-04
+			model 100195 fracture at time = 1.6000000E-04
+			model 100195 fracture at time = 1.7000000E-04
+			model 100195 fracture at time = 1.8000000E-04
+			model 100195 fracture at time = 1.8999999E-04
+			model 100195 fracture at time = 1.9999999E-04
+			model 100195 fracture at time = 1.9999999E-05
+			model 100195 fracture at time = 2.1000000E-04
+			model 100195 fracture at time = 2.1999999E-04
+			model 100195 fracture at time = 2.2999999E-04
+			model 100195 fracture at time = 2.3999999E-04
+			model 100195 fracture at time = 2.4999998E-04
+			model 100195 fracture at time = 2.6000000E-04
+			model 100195 fracture at time = 2.6999999E-04
+			model 100195 fracture at time = 2.7999998E-04
+			model 100195 fracture at time = 2.9000000E-04
+			model 100195 fracture at time = 2.9999999E-04
+			model 100195 fracture at time = 2.9999999E-05
+			model 100195 fracture at time = 3.1000000E-04
+			model 100195 fracture at time = 3.9999999E-05
+			model 100195 fracture at time = 4.9999999E-05
+			model 100195 fracture at time = 5.9999998E-05
+			model 100195 fracture at time = 6.9999995E-05
+			model 100195 fracture at time = 7.9999998E-05
+			model 100195 fracture at time = 9.0000001E-05
+			model 100195 fracture at time = 9.9999997E-05
+			model 100195 fracture at time = 9.9999997E-06
+			model 100195 fracture final
+			model 100195 fracture initial
+			origin
+			spacing
+
 	# # # HOSS # # #
 
 	This repository contains simulation output data organized into compressed .tar.gz archives of HDF5 (.h5) files. The data is grouped under three different material directories containing a sequence of tarballs (e.g.):