[cig-commits] [commit] master: improve documentation (332ff5d)
cig_noreply at geodynamics.org
cig_noreply at geodynamics.org
Wed Jun 4 12:47:00 PDT 2014
Repository : https://github.com/geodynamics/aspect
On branch : master
Link : https://github.com/geodynamics/aspect/compare/dea94ae3fdac1f434e32718c384fe5ce83109802...db7eea299d721e7afa2dc72d8f42352dc88a9e16
>---------------------------------------------------------------
commit 332ff5d2688e5fc8c62df6ae4d6bbaef05c6df56
Author: Timo Heister <timo.heister at gmail.com>
Date: Sun Jun 1 14:32:47 2014 -0400
improve documentation
>---------------------------------------------------------------
332ff5d2688e5fc8c62df6ae4d6bbaef05c6df56
include/aspect/adiabatic_conditions/interface.h | 6 +++---
include/aspect/boundary_composition/box.h | 2 +-
include/aspect/boundary_composition/interface.h | 4 +++-
include/aspect/boundary_temperature/interface.h | 4 +++-
include/aspect/compositional_initial_conditions/interface.h | 4 +++-
include/aspect/geometry_model/interface.h | 4 +++-
include/aspect/gravity_model/interface.h | 4 +++-
include/aspect/heating_model/interface.h | 4 +++-
include/aspect/initial_conditions/interface.h | 7 +++----
include/aspect/material_model/interface.h | 4 +++-
include/aspect/mesh_refinement/interface.h | 4 +++-
include/aspect/termination_criteria/interface.h | 4 +++-
include/aspect/velocity_boundary_conditions/gplates.h | 3 +--
include/aspect/velocity_boundary_conditions/interface.h | 4 +++-
14 files changed, 38 insertions(+), 20 deletions(-)
diff --git a/include/aspect/adiabatic_conditions/interface.h b/include/aspect/adiabatic_conditions/interface.h
index 5c402cd..3150e00 100644
--- a/include/aspect/adiabatic_conditions/interface.h
+++ b/include/aspect/adiabatic_conditions/interface.h
@@ -61,9 +61,9 @@ namespace aspect
virtual ~Interface();
/**
- * Initialization function. Because this function is called after
- * initializing the SimulatorAccess, all of the necessary information
- * is available to calculate the adiabatic profile.
+ * Initialization function. This function is called once at the
+ * beginning of the program after parse_parameters is run and after the
+ * SimulatorAccess (if applicable) is initialized.
*/
virtual
void
diff --git a/include/aspect/boundary_composition/box.h b/include/aspect/boundary_composition/box.h
index 2085c25..170726b 100644
--- a/include/aspect/boundary_composition/box.h
+++ b/include/aspect/boundary_composition/box.h
@@ -77,7 +77,7 @@ namespace aspect
parse_parameters (ParameterHandler &prm);
/**
- * It performs some basic
+ * This function performs some basic
* sanity checks on the parameter values previously read from the
* input file.
*/
diff --git a/include/aspect/boundary_composition/interface.h b/include/aspect/boundary_composition/interface.h
index 73ff4e8..493796f 100644
--- a/include/aspect/boundary_composition/interface.h
+++ b/include/aspect/boundary_composition/interface.h
@@ -57,7 +57,9 @@ namespace aspect
virtual ~Interface();
/**
- * Initialize function.
+ * Initialization function. This function is called once at the
+ * beginning of the program after parse_parameters is run and after the
+ * SimulatorAccess (if applicable) is initialized.
*/
virtual void initialize ();
diff --git a/include/aspect/boundary_temperature/interface.h b/include/aspect/boundary_temperature/interface.h
index 2b9af9a..51941b0 100644
--- a/include/aspect/boundary_temperature/interface.h
+++ b/include/aspect/boundary_temperature/interface.h
@@ -57,7 +57,9 @@ namespace aspect
virtual ~Interface();
/**
- * Initialize function.
+ * Initialization function. This function is called once at the
+ * beginning of the program after parse_parameters is run and after the
+ * SimulatorAccess (if applicable) is initialized.
*/
virtual void initialize ();
diff --git a/include/aspect/compositional_initial_conditions/interface.h b/include/aspect/compositional_initial_conditions/interface.h
index 88111f5..1810d27 100644
--- a/include/aspect/compositional_initial_conditions/interface.h
+++ b/include/aspect/compositional_initial_conditions/interface.h
@@ -56,7 +56,9 @@ namespace aspect
virtual ~Interface();
/**
- * Initialization function.
+ * Initialization function. This function is called once at the
+ * beginning of the program after parse_parameters is run and after the
+ * SimulatorAccess (if applicable) is initialized.
*/
virtual
void
diff --git a/include/aspect/geometry_model/interface.h b/include/aspect/geometry_model/interface.h
index f72b3d2..4aa6606 100644
--- a/include/aspect/geometry_model/interface.h
+++ b/include/aspect/geometry_model/interface.h
@@ -63,7 +63,9 @@ namespace aspect
virtual ~Interface();
/**
- * Initialize function.
+ * Initialization function. This function is called once at the
+ * beginning of the program after parse_parameters is run and after the
+ * SimulatorAccess (if applicable) is initialized.
*/
virtual void initialize ();
diff --git a/include/aspect/gravity_model/interface.h b/include/aspect/gravity_model/interface.h
index fd95455..050f720 100644
--- a/include/aspect/gravity_model/interface.h
+++ b/include/aspect/gravity_model/interface.h
@@ -54,7 +54,9 @@ namespace aspect
virtual ~Interface();
/**
- * Initialize function.
+ * Initialization function. This function is called once at the
+ * beginning of the program after parse_parameters is run and after the
+ * SimulatorAccess (if applicable) is initialized.
*/
virtual void initialize ();
diff --git a/include/aspect/heating_model/interface.h b/include/aspect/heating_model/interface.h
index 3d156ac..a1c23a0 100644
--- a/include/aspect/heating_model/interface.h
+++ b/include/aspect/heating_model/interface.h
@@ -55,7 +55,9 @@ namespace aspect
virtual ~Interface();
/**
- * Initialization function.
+ * Initialization function. This function is called once at the
+ * beginning of the program after parse_parameters is run and after the
+ * SimulatorAccess (if applicable) is initialized.
*/
virtual
void
diff --git a/include/aspect/initial_conditions/interface.h b/include/aspect/initial_conditions/interface.h
index 8acbedb..ca6c879 100644
--- a/include/aspect/initial_conditions/interface.h
+++ b/include/aspect/initial_conditions/interface.h
@@ -55,10 +55,9 @@ namespace aspect
virtual ~Interface();
/**
- * Initialization function. Take references to the geometry model, the
- * object that describes the temperature boundary values, and the
- * adiabatic conditions and store them so that derived classes can
- * access them.
+ * Initialization function. This function is called once at the
+ * beginning of the program after parse_parameters is run and after the
+ * SimulatorAccess (if applicable) is initialized.
*/
virtual
void
diff --git a/include/aspect/material_model/interface.h b/include/aspect/material_model/interface.h
index 15d34e9..70f3997 100644
--- a/include/aspect/material_model/interface.h
+++ b/include/aspect/material_model/interface.h
@@ -141,7 +141,9 @@ namespace aspect
virtual ~Interface();
/**
- * Initialization function.
+ * Initialization function. This function is called once at the
+ * beginning of the program after parse_parameters is run and after the
+ * SimulatorAccess (if applicable) is initialized.
*/
virtual
void
diff --git a/include/aspect/mesh_refinement/interface.h b/include/aspect/mesh_refinement/interface.h
index 9a8bdc8..3d21924 100644
--- a/include/aspect/mesh_refinement/interface.h
+++ b/include/aspect/mesh_refinement/interface.h
@@ -80,7 +80,9 @@ namespace aspect
~Interface ();
/**
- * Initialize function.
+ * Initialization function. This function is called once at the
+ * beginning of the program after parse_parameters is run and after the
+ * SimulatorAccess (if applicable) is initialized.
*/
virtual void initialize ();
diff --git a/include/aspect/termination_criteria/interface.h b/include/aspect/termination_criteria/interface.h
index 82fefa9..6d34413 100644
--- a/include/aspect/termination_criteria/interface.h
+++ b/include/aspect/termination_criteria/interface.h
@@ -73,7 +73,9 @@ namespace aspect
~Interface ();
/**
- * Initialize function.
+ * Initialization function. This function is called once at the
+ * beginning of the program after parse_parameters is run and after the
+ * SimulatorAccess (if applicable) is initialized.
*/
virtual void initialize ();
diff --git a/include/aspect/velocity_boundary_conditions/gplates.h b/include/aspect/velocity_boundary_conditions/gplates.h
index fec494c..192548d 100644
--- a/include/aspect/velocity_boundary_conditions/gplates.h
+++ b/include/aspect/velocity_boundary_conditions/gplates.h
@@ -279,8 +279,7 @@ namespace aspect
/**
* Initialization function. This function is called once at the
- * beginning of the program. Parses the user input and checks for
- * valid geometry model.
+ * beginning of the program. Checks preconditions.
*/
virtual
void
diff --git a/include/aspect/velocity_boundary_conditions/interface.h b/include/aspect/velocity_boundary_conditions/interface.h
index 3724bbc..61f0325 100644
--- a/include/aspect/velocity_boundary_conditions/interface.h
+++ b/include/aspect/velocity_boundary_conditions/interface.h
@@ -56,7 +56,9 @@ namespace aspect
virtual ~Interface();
/**
- * Initialization function.
+ * Initialization function. This function is called once at the
+ * beginning of the program after parse_parameters is run and after the
+ * SimulatorAccess (if applicable) is initialized.
*/
virtual
void
More information about the CIG-COMMITS
mailing list