From: Wolfgang Bangerth <bangerth@math.tamu.edu>
Date: Sun, 12 Jun 2016 23:17:36 +0000 (-0500)
Subject: Update readme.md.
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=14799ed0443e932459d8aa8a27fe53be69edc6e0;p=code-gallery.git

Update readme.md.
---

diff --git a/goal_oriented_elastoplasticity/readme.md b/goal_oriented_elastoplasticity/readme.md
index 488d015..1e28c83 100644
--- a/goal_oriented_elastoplasticity/readme.md
+++ b/goal_oriented_elastoplasticity/readme.md
@@ -12,3 +12,92 @@ The applied methodology and the solved numerical examples can be found in the fo
 >  Adaptivity in 3d Elastoplasticity Problems".
 > International Journal of Fracture. Accepted. 2016.
 
+
+### Running the code
+
+The code contains several examples consisting of the three examples presented in the aforementioned paper. To run each of them you can switch to them, e.g.
+```
+git checkout Thick_tube_internal_pressure
+
+git checkout  Perforated_strip_displacement_3d
+
+git checkout  Cantiliver_II_beam_3d
+```
+
+Then by compiling it using the following commands
+```
+cmake -DDEAL_II_DIR=/path/to/deal.II .
+make
+```
+you can run it by typing
+```
+./elastoplastic Thick_tube_internal_pressure.prm
+```
+or
+```
+./elastoplastic Perforated_strip_displacement_3d.prm
+```
+or
+```
+./elastoplastic Cantiliver_II_beam_3d.prm
+```
+ 
+The three named input files are already in the current directory, and
+have the following options:
+```
+set polynomial degree                [defines the polynomial order of
+                                      the (primal) problem]
+
+set number of initial refinements    [defines how many times the mesh
+                                      is globally refined to construct
+                                      the  initial mesh]
+
+set refinement strategy              [can be chosen as global for
+                                      global refinement or percentage
+                                      in order to mesh adaptation with
+                                      the assumption of refinement of
+                                      30% of the elements with higher
+                                      errors and coarsening of 3% of
+                                      element with the least errors
+                                      (these percentages can be
+                                      changed inside the code)]
+
+set error estimation strategy        [can be set kelly_error or
+                                      residual_error or
+                                      weighted_residual_error to apply
+                                      different error estimation
+                                      methods (see the paper for more
+                                      information)]
+
+set maximum relative error           [set a criterion value for
+                                      perfoming the mesh adaptivity] 
+
+set output directory                 [determine a directory to save
+                                      the output results] 
+
+set transfer solution                [by assuming true, the solution
+                                      variables at each step are
+                                      transferred to the next
+                                      load/displacement step] 
+
+set base mesh                        [determines the problem:
+                                      Timoshenko beam /
+                                      Thick_tube_internal_pressure /
+                                      Perforated_strip_tension /
+                                      Cantiliver_beam_3d]
+
+set elasticity modulus
+
+set Poissons ratio
+
+set yield stress
+
+set isotropic hardening parameter
+
+set show stresses                    [by setting true or false,
+                                      determines if the stress results
+                                      be saved or not (to save the
+                                      analysis time, we can set it as
+                                      false when we do not need to
+                                      illustrate them)]
+```