add docx

docs/source/examples/color/steadyState.rst

@@ -11,51 +11,57 @@ For the case considered in ``example/DiscPack`` we specify the following informa
 
 .. code:: c
 
-	  Domain {
-	     Filename = "discs_3x128x128.raw.morphdrain.raw"
-	     ReadType = "8bit"    // data type
-	     N = 3, 128, 128       // size of original image
-	     nproc = 1, 2, 2       // process grid
-	     n = 3, 64, 64         // sub-domain size
-	     voxel_length = 1.0    // voxel length (in microns)
-	     ReadValues = 0, 1, 2  // labels within the original image
-	     WriteValues = 0, 1, 2 // associated labels to be used by LBPM
-	     BC = 0                // fully periodic BC
-	     Sw = 0.35             // target saturation for morphological tools
-	  }
+	Domain {
+	   Filename = "discs_3x128x128.raw.morphdrain.raw"
+	   ReadType = "8bit"    // data type
+	   N = 3, 128, 128       // size of original image
+	   nproc = 1, 2, 2       // process grid
+	   n = 3, 64, 64         // sub-domain size
+	   voxel_length = 1.0    // voxel length (in microns)
+	   ReadValues = 0, 1, 2  // labels within the original image
+	   WriteValues = 0, 1, 2 // associated labels to be used by LBPM
+	   BC = 0                // fully periodic BC
+	   Sw = 0.35             // target saturation for morphological tools
+	}
 
-	  Color {
-	     capillary_number = -1e-5           // capillary number for the displacement, positive="oil injection"
-	     timestepMax = 20000              // maximum timtestep
-	     alpha = 0.01                       // controls interfacial tension
-	     rhoA = 1.0                         // controls the density of fluid A
-	     rhoB = 1.0                         // controls the density of fluid B
-	     tauA = 0.7                         // controls the viscosity of fluid A
-	     tauB = 0.7                         // controls the viscosity of fluid B
-	     F = 0, 0, 1e-5                     // body force
-	     WettingConvention = "SCAL" 
-	     ComponentLabels = 0        // image labels for solid voxels
-	     ComponentAffinity = 0.9  // controls the wetting affinity for each label
-	     Restart = false
-	  }
-	  Analysis {
-	     analysis_interval = 1000           // logging interval for timelog.csv
-	     subphase_analysis_interval = 500000  // loggging interval for subphase.csv
-	     N_threads = 4                      // number of analysis threads (GPU version only)
-	     visualization_interval = 10000    // interval to write visualization files
-	     restart_interval = 10000000         // interval to write restart file
-	     restart_file = "Restart"           // base name of restart file
-	  }
-	  Visualization {
-	     format = "hdf5"
-	     write_silo = true        // write SILO databases with assigned variables
-	     save_8bit_raw = true      // write labeled 8-bit binary files with phase assignments
-	     save_phase_field = true  // save phase field within SILO database
-	     save_pressure = true     // save pressure field within SILO database
-	     save_velocity = false     // save velocity field within SILO database
-	  }
-	  FlowAdaptor {
-	  }
+	Color {
+	   protocol = "fractional flow"
+	   capillary_number = 1e-5            // capillary number for the displacement, positive="oil injection"
+	   timestepMax = 500000               // maximum timtestep
+	   alpha = 0.005                      // controls interfacial tension
+	   rhoA = 1.0                         // controls the density of fluid A
+	   rhoB = 1.0                         // controls the density of fluid B
+	   tauA = 0.7                         // controls the viscosity of fluid A
+	   tauB = 0.7                         // controls the viscosity of fluid B
+	   F = 0, 0, 1e-5                     // body force
+	   WettingConvention = "SCAL"
+	   ComponentLabels = 0        // image labels for solid voxels
+	   ComponentAffinity = 0.9  // controls the wetting affinity for each label
+	   Restart = false
+	}
+	Analysis {
+	   analysis_interval = 1000           // logging interval for timelog.csv
+	   subphase_analysis_interval = 500000  // loggging interval for subphase.csv
+	   N_threads = 4                      // number of analysis threads (GPU version only)
+	   visualization_interval = 1000000    // interval to write visualization files
+	   restart_interval = 10000000         // interval to write restart file
+	   restart_file = "Restart"           // base name of restart file
+	}
+	Visualization {
+	   format = "hdf5"
+	   write_silo = true        // write SILO databases with assigned variables
+	   save_8bit_raw = true      // write labeled 8-bit binary files with phase assignments
+	   save_phase_field = true  // save phase field within SILO database
+	   save_pressure = true     // save pressure field within SILO database
+	   save_velocity = false     // save velocity field within SILO database
+	}
+	FlowAdaptor {
+	   min_steady_timesteps = 250000       // minimum number of timesteps per steady point
+	   max_steady_timesteps = 300000       // maximum number of timesteps per steady point
+	   fractional_flow_increment = 0.1   // parameter that controls rate of mass seeding
+	   skip_timesteps = 10000             // number of timesteps to spend in flow adaptor
+	   endpoint_threshold = 0.1           // endpoint exit criterion
+	}
 
 	  
 Once this has been set, we launch ``lbpm_color_simulator`` in the same way as other parallel tools