Skip to content

Commit 8db9470

Browse files
danieldouglas92danieldouglas92
committed
Fix typos, minor doc improvements
1 parent e372f37 commit 8db9470

File tree

1 file changed

+28
-22
lines changed

1 file changed

+28
-22
lines changed

‎source/mesh_deformation/fastscape.cc‎

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1665,7 +1665,7 @@ namespace aspect
16651665
{
16661666
prm.declare_entry("Number of fastscape timesteps per aspect timestep", "5",
16671667
Patterns::Integer(),
1668-
"Initial number of fastscape time steps per ASPECT timestep, this value will double if"
1668+
"Initial number of fastscape time steps per ASPECT timestep, this value will double if "
16691669
"the FastScape timestep is above the maximum FastScape timestep.");
16701670
prm.declare_entry("Maximum timestep length", "10e3",
16711671
Patterns::Double(0),
@@ -1675,11 +1675,11 @@ namespace aspect
16751675
"Vertical exaggeration for FastScape's VTK file. -1 outputs topography, basement, and sealevel.");
16761676
prm.declare_entry("Additional fastscape refinement", "0",
16771677
Patterns::Integer(),
1678-
"How many levels above ASPECT FastScape should be refined.");
1678+
"How many levels above the ASPECT mesh the FastScape should be refined.");
16791679
prm.declare_entry ("Average out of plane surface topography in 2d", "true",
16801680
Patterns::Bool (),
16811681
"If this is set to false, then a 2D model will only consider the "
1682-
"center slice FastScape gives. If set to true, then ASPECT will"
1682+
"center slice FastScape gives. If set to true, then ASPECT will "
16831683
"average the mesh along Y excluding the ghost nodes.");
16841684
prm.declare_entry("Fastscape seed", "1000",
16851685
Patterns::Integer(),
@@ -1690,7 +1690,7 @@ namespace aspect
16901690
prm.declare_entry("Surface refinement difference", "0",
16911691
Patterns::Integer(),
16921692
"The difference between the lowest and highest refinement level at the surface. E.g., if three resolution "
1693-
"levels are expected, this would be set to 2.");
1693+
"levels are expected, this would be set to two.");
16941694
prm.declare_entry ("Use marine component", "false",
16951695
Patterns::Bool (),
16961696
"Flag to use the marine component of FastScape.");
@@ -1699,18 +1699,18 @@ namespace aspect
16991699
"FastScape Y extent when using a 2D ASPECT model. Units: $\\{m}$");
17001700
prm.declare_entry ("Use ghost nodes", "true",
17011701
Patterns::Bool (),
1702-
"Flag to use ghost nodes");
1702+
"Flag to use ghost nodes.");
17031703
prm.declare_entry ("Uplift and advect with fastscape", "true",
17041704
Patterns::Bool (),
17051705
"Flag to use FastScape advection and uplift.");
17061706
prm.declare_entry("Node tolerance", "0.001",
17071707
Patterns::Double(),
1708-
"Node tolerance for how close an ASPECT node must be to the FastScape node for the value to be transferred.");
1708+
"Node tolerance for how close an ASPECT node must be to a FastScape node for the value to be transferred.");
17091709
prm.declare_entry ("Sediment rain rates", "0,0",
17101710
Patterns::List (Patterns::Double(0)),
17111711
"Sediment rain rates given as a list 1 greater than the number of sediment rain time intervals. E.g, "
1712-
" If the time interval is given at 5 Myr, there will be one value for 0-5 Myr model time and a second value "
1713-
" for 5+ Myr. Units: $\\{m/yr}$");
1712+
"If the time interval is given at 5 Myr, there will be one value for 0-5 Myr model time and a second value "
1713+
"for 5+ Myr. Units: $\\{m/yr}$");
17141714
prm.declare_entry ("Sediment rain time intervals", "0",
17151715
Patterns::List (Patterns::Double(0)),
17161716
"A list of times to change the sediment rain rate. Units: $\\{yrs}$");
@@ -1719,7 +1719,7 @@ namespace aspect
17191719
"Maximum topography change from the initial noise. Units: $\\{m}$");
17201720
prm.declare_entry("Additional output variables", "river incision rate",
17211721
Patterns::Selection("river incision rate|deposition coefficient|uplift rate"),
1722-
"Select one type of Fastscape variable as output in Fastcape vtk."
1722+
"Select one additional Fastscape variable to output in the Fastcape vtk. "
17231723
"Output are in units of per year. "
17241724
);
17251725

@@ -1739,16 +1739,16 @@ namespace aspect
17391739
"Left boundary condition, where 1 is fixed and 0 is reflective.");
17401740
prm.declare_entry("Left mass flux", "0",
17411741
Patterns::Double(),
1742-
"Flux per unit length through left boundary. Units: $\\{m^2/yr}$ ");
1742+
"Flux per unit length through the left boundary. Units: $\\{m^2/yr}$ ");
17431743
prm.declare_entry("Right mass flux", "0",
17441744
Patterns::Double(),
1745-
"Flux per unit length through right boundary. Units: $\\{m^2/yr}$ ");
1745+
"Flux per unit length through the right boundary. Units: $\\{m^2/yr}$ ");
17461746
prm.declare_entry("Back mass flux", "0",
17471747
Patterns::Double(),
1748-
"Flux per unit length through back boundary. Units: $\\{m^2/yr}$ ");
1748+
"Flux per unit length through the back boundary. Units: $\\{m^2/yr}$ ");
17491749
prm.declare_entry("Front mass flux", "0",
17501750
Patterns::Double(),
1751-
"Flux per unit length through front boundary. Units: $\\{m^2/yr}$ ");
1751+
"Flux per unit length through the front boundary. Units: $\\{m^2/yr}$ ");
17521752
prm.declare_entry ("Back front ghost nodes periodic", "false",
17531753
Patterns::Bool (),
17541754
"Whether to set the ghost nodes at the FastScape back and front boundary "
@@ -1764,13 +1764,13 @@ namespace aspect
17641764
{
17651765
prm.declare_entry("Drainage area exponent", "0.4",
17661766
Patterns::Double(),
1767-
"Exponent for drainage area.");
1767+
"The drainage area exponent for the Stream Power Law (m).");
17681768
prm.declare_entry("Slope exponent", "1",
17691769
Patterns::Double(),
1770-
"The slope exponent for SPL (n). Generally m/n should equal approximately 0.4");
1770+
"The slope exponent for the Stream Power Law (n). Generally m/n should equal approximately 0.4");
17711771
prm.declare_entry("Multi-direction slope exponent", "1",
17721772
Patterns::Double(),
1773-
"Exponent to determine the distribution from the SPL to neighbor nodes, with"
1773+
"Exponent to determine the distribution from the SPL to neighbor nodes, with "
17741774
"10 being steepest decent and 1 being more varied.");
17751775
prm.declare_entry("Bedrock deposition coefficient", "1",
17761776
Patterns::Double(),
@@ -1785,15 +1785,19 @@ namespace aspect
17851785
"If false, a constant kf value will be used.");
17861786
prm.declare_entry("Bedrock river incision rate", "1e-5",
17871787
Patterns::Double(),
1788-
"River incision rate for bedrock in the Stream Power Law. Units: ${m^(1-2drainage_area_exponent)/yr}$ if ``Use years instead of seconds in output'' is true; otherwise, the units are ${m^(1-2drainage_area_exponent)/s}$");
1788+
"River incision rate for bedrock in the Stream Power Law. "
1789+
"Units: ${m^(1-2drainage_area_exponent)/yr}$ if ``Use years instead of seconds in output'' is true; "
1790+
"otherwise, the units are ${m^(1-2drainage_area_exponent)/s}$");
17891791
prm.enter_subsection ("kf distribution function");
17901792
{
17911793
Functions::ParsedFunction<2>::declare_parameters(prm, 2);
17921794
}
17931795
prm.leave_subsection();
17941796
prm.declare_entry("Sediment river incision rate", "-1",
17951797
Patterns::Double(),
1796-
"River incision rate for sediment in the Stream Power Law. -1 sets this to the bedrock river incision rate. Units: $m^(1-2drainage_area_exponent)/yr}$ if ``Use years instead of seconds in output'' is true; otherwise, the units are $m^(1-2drainage_area_exponent)/s}$");
1798+
"River incision rate for sediment in the Stream Power Law. -1 sets this to the bedrock river incision rate. "
1799+
"Units: $m^(1-2drainage_area_exponent)/yr}$ if ``Use years instead of seconds in output'' is true; "
1800+
"otherwise, the units are $m^(1-2drainage_area_exponent)/s}$");
17971801

17981802
// Define Bedrock transport coefficient (Kd) as a constant value of time dependent user-defined function
17991803
prm.declare_entry("Use kd distribution function", "false",
@@ -1802,7 +1806,8 @@ namespace aspect
18021806
"If false, a constant kd value will be used.");
18031807
prm.declare_entry("Bedrock diffusivity", "1e-2",
18041808
Patterns::Double(),
1805-
"Transport coefficient (diffusivity) for bedrock. Units: ${m^2/yr}$ if ``Use years instead of seconds in output'' is true; otherwise, the units are ${m^2/s}$.");
1809+
"Transport coefficient (diffusivity) for bedrock. Units: ${m^2/yr}$ if ``Use years instead of seconds in output'' "
1810+
"is true; otherwise, the units are ${m^2/s}$.");
18061811
prm.enter_subsection ("kd distribution function");
18071812
{
18081813
Functions::ParsedFunction<2>::declare_parameters(prm, 2);
@@ -1820,10 +1825,10 @@ namespace aspect
18201825
"When terrain reaches this height the wind barrier factor is applied. Units: $\\{m}$");
18211826
prm.declare_entry("Elevation factor", "1",
18221827
Patterns::Double(),
1823-
"Amount to multiply the bedrock river incision rate nad transport coefficient by past the given orographic elevation control.");
1828+
"Amount to multiply the bedrock river incision rate and transport coefficient by past the given orographic elevation control.");
18241829
prm.declare_entry("Wind barrier factor", "1",
18251830
Patterns::Double(),
1826-
"Amount to multiply the bedrock river incision rate nad transport coefficient by past given wind barrier height.");
1831+
"Amount to multiply the bedrock river incision rate and transport coefficient by past given wind barrier height.");
18271832
prm.declare_entry ("Stack orographic controls", "true",
18281833
Patterns::Bool (),
18291834
"Whether or not to apply both controls to a point, or only a maximum of one set as the wind barrier.");
@@ -1867,7 +1872,8 @@ namespace aspect
18671872

18681873
prm.declare_entry("Sea level", "0.0",
18691874
Patterns::Double(),
1870-
"Constant sea level relative to the ASPECT surface, where the maximum Z or Y extent in ASPECT is a sea level of zero. Units: $\\{m}$ ");
1875+
"Constant sea level relative to the ASPECT surface, where the maximum Z or Y extent in ASPECT is a sea level of zero. "
1876+
"Units: $\\{m}$ ");
18711877

18721878
prm.enter_subsection ("Sea level function");
18731879
{

0 commit comments

Comments
 (0)