Skip to content

Commit

Permalink
HTML prettified
Browse files Browse the repository at this point in the history
git-svn-id: https://svn.osgeo.org/grass/grass/trunk@48279 15284696-431f-4ddb-bdfa-cd5b030d7da7
  • Loading branch information
neteler committed Sep 13, 2011
1 parent 4274464 commit 4ad8acf
Show file tree
Hide file tree
Showing 14 changed files with 254 additions and 232 deletions.
44 changes: 21 additions & 23 deletions raster3d/r3.cross.rast/r3.cross.rast.html
Original file line number Diff line number Diff line change
@@ -1,50 +1,47 @@
<H2>DESCRIPTION</H2>
<h2>DESCRIPTION</h2>

This module creates a cross section 2D map from one RASTER3D raster volume
map based on a 2D elevation map. It checks if the value of the
elevation map is located in the z-coordinate space of the 3D map. If
This module creates a cross section 2D map from one 3D raster volume
map based on a 2D elevation map. It checks if the value of the
elevation map is located in the z-coordinate space of the 3D map. If
so, the 3D voxel value for this position is transferred to the related
cross section output map cell, otherwise the NULL value is set.

<center>
<img src=r3.cross.rast.png border=0><BR>
<img src=r3.cross.rast.png border=0><br>
<table border=0 width=700>
<tr><td><center>
<i>How r3.cross.rast works</i>
</center></td></tr>
</table>
</center>


<br>
<br>
<p>
If the 2D and 3D region settings are different,
the 2D resolution will be adjust to the 3D resolution.


<H2>NOTES</H2>
<h2>NOTES</h2>

To create a cut plane elevation map use <em>r.mapcalc</em>. Some examples:
<ul>
<li>To create a cut plane elevation map in x direction type
<li>To create a cut plane elevation map in x direction type
<br><i>r.mapcalc "cutplane = col()*x"</i>,<br> x be the value for
the elevation. If the range of col() is 1 ... 10, the elevation map
has the range 1 ... 10 if x == 1 and if x == 10 the range 10
... 100</li>

<li>To create a cut plane elevation map in y direction type
<li>To create a cut plane elevation map in y direction type
<br><i>r.mapcalc "cutplane = row()*x"</i>,<br> x be the value for
the elevation. If the range of col() is 1 ... 10, the elevation map
has the range 1 ... 10 if x == 1 and if x == 10 the range 10
... 100</li>

<li>The user can also make a cut in y and x direction with <em>r.mapcalc</em> by
<li>The user can also make a cut in y and x direction with <em>r.mapcalc</em> by
using <br><i>r.mapcalc "cutplane = (row()+col())*x"</i></li>
</ul>

<H2>EXAMPLE</H2>
<h2>EXAMPLE</h2>

<H3>Simple Spearfish example</H3>
<h3>Simple Spearfish example</h3>

<div class="code"><pre>
g.region -d
Expand All @@ -60,15 +57,16 @@ <H3>Simple Spearfish example</H3>
r3.cross.rast input=map3d elevation=cutplane output=crosssection
</pre></div>

<h2>SEE ALSO</h2>

<H2>SEE ALSO</H2>

<EM><A HREF="g.region.html">g.region</A></EM><br>
<EM><A HREF="r.mapcalc.html">r.mapcalc</A></EM><br>
<EM><A HREF="r3.mapcalc.html">r3.mapcalc</A></EM><br>
<EM><A HREF="r3.to.rast.html">r3.to.rast</A></EM><br>
<em>
<a href="g.region.html">g.region</a>,
<a href="r.mapcalc.html">r.mapcalc</a>,
<a href="r3.mapcalc.html">r3.mapcalc</a>,
<a href="r3.to.rast.html">r3.to.rast</a>
</em>

<H2>AUTHOR</H2>
Soeren Gebbert
<h2>AUTHOR</h2>
S&ouml;ren Gebbert

<p><i>Last changed: $Date$</i>
74 changes: 40 additions & 34 deletions raster3d/r3.gwflow/r3.gwflow.html
Original file line number Diff line number Diff line change
@@ -1,30 +1,31 @@
<h2>DESCRIPTION</h2>

This numerical module calculates implicit transient and steady state,
confined groundwater flow in three dimensions based on volume maps
and the current 3D region settings.
All initial- and boundary-conditions must be provided as volume maps.
The unit in the location must be meters.
<br>
<p>
This module is sensitive to mask settings. All cells which are outside the mask
are ignored and handled as no flow boundaries.
This module is sensitive to mask settings. All cells which are outside
the mask are ignored and handled as no flow boundaries.
<p>
The module calculates the piezometric head and optionally the water balance for each cell
and the groundwater velocity field in 3 dimensions.
The module calculates the piezometric head and optionally the water
balance for each cell and the groundwater velocity field in 3 dimensions.
The vector components can be visualized with ParaView if they are exported
with <em>r3.out.vtk</em>.

<p>
The groundwater flow will always be calculated transient.
For steady state computation set the timestep
For steady state computation the user should set the timestep
to a large number (billions of seconds) or set the
specific yield raster map to zero.

<h2>NOTES</h2>

The groundwater flow calculation is based on Darcy's law and a numerical implicit
finite volume discretization. The discretization results in a symmetric and positive definit
linear equation system in form of <i>Ax = b</i>, which must be solved. The groundwater flow partial
The groundwater flow calculation is based on Darcy's law and a numerical
implicit finite volume discretization. The discretization results in a
symmetric and positive definit linear equation system in form of
<i>Ax = b</i>, which must be solved. The groundwater flow partial
differential equation is of the following form:

<p>
Expand All @@ -46,35 +47,39 @@ <h2>NOTES</h2>
</ul>

<p>
Two different boundary conditions are implemented,
the Dirichlet and Neumann conditions. By default the calculation area
is surrounded by homogeneous Neumann boundary conditions.
The calculation and boundary status of single cells can be set with the status map,
the following cell states are supportet:
Two different boundary conditions are implemented, the Dirichlet and
Neumann conditions. By default the calculation area is surrounded by
homogeneous Neumann boundary conditions. The calculation and boundary
status of single cells can be set with the status map, the following
cell states are supported:

<ul>
<li>0 == inactive - the cell with status 0 will not be calulated, active cells will have a no flow boundary to an inactive cell</li>
<li>1 == active - this cell is used for groundwater calculation, inner sources can be defined for those cells</li>
<li>2 == Dirichlet - cells of this type will have a fixed piezometric head value which do not change over time </li>
<li>0 == inactive - the cell with status 0 will not be calulated,
active cells will have a no flow boundary to an inactive cell</li>
<li>1 == active - this cell is used for groundwater calculation,
inner sources can be defined for those cells</li>
<li>2 == Dirichlet - cells of this type will have a fixed piezometric
head value which do not change over time </li>
</ul>

<p>
Note that all required raster maps are read into main memory. Additionally the
linear equation system will be allocated, so the memory consumption of this
module rapidely grow with the size of the input maps.
Note that all required raster maps are read into main memory. Additionally
the linear equation system will be allocated, so the memory consumption of
this module rapidely grow with the size of the input maps.

<p>
The resulting linear equation system <i>Ax = b</i> can be solved with several solvers.
An iterative solvers with sparse and quadratic matrices support is implemented.
The resulting linear equation system <i>Ax = b</i> can be solved with
several solvers. An iterative solvers with sparse and quadratic matrices
support is implemented.
The conjugate gradients method with (pcg) and without (cg) precondition.
Aditionally a direct Cholesky solver is available. This direct solver
only work with normal quadratic matrices, so be careful using them with large maps
(maps of size 10.000 cells will need more than one gigabyte of RAM).
Always prefer a sparse matrix solver.
only work with normal quadratic matrices, so be careful using them with
large maps (maps of size 10.000 cells will need more than one Gigabyte
of RAM). The user should always prefer to use a sparse matrix solver.

<h2>EXAMPLE 1</h2>
Use this small script to create a working groundwater flow area and
data. Make sure you are not in a lat/lon projection.
This small script creates a working groundwater flow area and
data. It cannot be run in a lat/lon location.

<div class="code"><pre>
# set the region accordingly
Expand All @@ -98,7 +103,7 @@ <h2>EXAMPLE 1</h2>
paraview --data=/tmp/gwdata3d.vtk
</pre></div>

<H2>EXAMPLE 2</H2>
<h2>EXAMPLE 2</h2>
This will create a nice 3D model with geological layer with different
hydraulic conductivities. Make sure you are not in a lat/lon projection.

Expand Down Expand Up @@ -129,16 +134,17 @@ <H2>EXAMPLE 2</H2>

<h2>SEE ALSO</h2>

<em><a href="r.gwflow.html">r.gwflow</a></em><br>
<em><a href="r.solute.transport.html">r.solute.transport</a></em><br>
<em><a href="r3.out.vtk.html">r3.out.vtk</a></em>
<em>
<a href="r.gwflow.html">r.gwflow</a>,
<a href="r.solute.transport.html">r.solute.transport</a>,
<a href="r3.out.vtk.html">r3.out.vtk</a>
</em>

<h2>AUTHOR</h2>
S&ouml;ren Gebbert
<p>
This work is based on the Diploma Thesis of S&ouml;ren Gebbert available
<a href="http://www.hydrogeologie.tu-berlin.de/fileadmin/fg66/_hydro/Diplomarbeiten/2007_Diplomarbeit_Soeren_Gebbert.pdf">here</a>
This work is based on the Diploma Thesis of S&ouml;ren Gebbert available
<a href="http://www.hydrogeologie.tu-berlin.de/fileadmin/fg66/_hydro/Diplomarbeiten/2007_Diplomarbeit_S&ouml;ren_Gebbert.pdf">here</a>
at Technical University Berlin, Germany.


<p><i>Last changed: $Date$</i>
16 changes: 8 additions & 8 deletions raster3d/r3.in.ascii/r3.in.ascii.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ <h2>DESCRIPTION</h2>

<h2>NOTES</h2>

The format for the ASCII file is:
<pre>
The format of the 3D ASCII file:
<div class="code"><pre>
version: <i>"grass7"</i>
order: <i>"nsbt" or "nstb" or "snbt" or "sntb"</i>
north: <i>floating point</i>
Expand All @@ -42,7 +42,7 @@ <h2>NOTES</h2>
rows: <i>integer</i>
cols: <i>integer</i>
levels: <i>integer</i>
</pre>
</pre></div>

The version and order option have been introduced in GRASS 7 in June 2011.
The version option is self explaining. The order option specifies the row
Expand All @@ -53,15 +53,14 @@ <h2>NOTES</h2>
<em>north -> south, west -> east, bottom -> top</em> order.
So dependent on the order information the data is automatically imported
into the correct internal coordinate system.
<P>
<p>
The version and order options are not mandatory. In case no version and
order option is specified, the default GRASS 6 ASCII format is assumed.
<P>
<p>
This header is followed by the cell values in <em>floating point</em> format
organized in rows with constant <em>col</em> and <em>level</em> coordinate.
The rows are organized by constant <em>level</em> coordinate. Individual cell
values are separated by <em>space</em> or <em>CR</em>.
<p>

<h2>EXAMPLES</h2>

Expand Down Expand Up @@ -89,15 +88,16 @@ <h2>EXAMPLES</h2>
x1,y3,z2 x2,y3,z2 x3,y3,z2 x4,y3,z2
</pre></div>

Note that unit tests for r3.in.ascii are implemented in the
Note that unit tests for <em>r3.in.ascii</em> are implemented in the
<em>test.r3.out.ascii.sh</em> script located in the
<em>r3.out.ascii</em> directory.

<h2>AUTHORS</h2>
Roman Waupotitsch, Michael Shapiro,
Helena Mitasova, Bill Brown, Lubos Mitas, Jaro Hofierka, Soeren Gebbert
Helena Mitasova, Bill Brown, Lubos Mitas, Jaro Hofierka, S&ouml;ren Gebbert

<h2>SEE ALSO</h2>

<em>
<a href="r.in.ascii.html">r.in.ascii</a>,
<a href="r3.out.ascii.html">r3.out.ascii</a>,
Expand Down
11 changes: 7 additions & 4 deletions raster3d/r3.in.v5d/r3.in.v5d.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<h2>DESCRIPTION</h2>

<em>r3.in.v5d</em> imports 3-dimensional files (i.e. the V5D file with one variable
and one time step). Otherwise, only first variable and timestep from 4/5D
V5D file will be imported.
<em>r3.in.v5d</em> imports 3-dimensional files (i.e. the V5D file with
one variable and one time step). Otherwise, only first variable and
timestep from 4/5D V5D file will be imported.

<p>
<a href="http://www.ssec.wisc.edu/~billh/vis5d.html">Vis5D</a> is a system
Expand All @@ -14,7 +14,10 @@ <h2>DESCRIPTION</h2>
support for interactive data analysis, etc.

<h2>SEE ALSO</h2>
<em><a href="r3.out.v5d.html">r3.out.v5d</a></em>

<em>
<a href="r3.out.v5d.html">r3.out.v5d</a>
</em>

<h2>AUTHOR</h2>
Jaro Hofierka, GeoModel s.r.o., Slovakia
Expand Down
13 changes: 8 additions & 5 deletions raster3d/r3.info/r3.info.html
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
<H2>DESCRIPTION</H2>
<h2>DESCRIPTION</h2>

<EM>r3.info</EM> reports metadata and range of 3D voxel maps.
<em>r3.info</em> reports metadata and range of 3D voxel maps.

<H2>SEE ALSO</H2>
<h2>SEE ALSO</h2>

<EM><A HREF="r.info.html">r.info</A></EM><br>
<em>
<a href="r.info.html">r.info</a>
</em>

<H2>AUTHORS</H2>
<h2>AUTHORS</h2>
Roman Waupotitsch, Michael Shapiro,
Helena Mitasova, Bill Brown, Lubos Mitas,
Jaro Hofierka

<p><i>Last changed: $Date$</i>
27 changes: 10 additions & 17 deletions raster3d/r3.mask/r3.mask.html
Original file line number Diff line number Diff line change
@@ -1,26 +1,19 @@
<H2>DESCRIPTION</H2>
<h2>DESCRIPTION</h2>

File <EM>map</EM> is used as reference file.
File <em>map</em> is used as reference file.
Cells in the mask are marked as "mask out" if the corresponding cell in
<EM>map</EM> contains a value in the range specified with <EM>maskvalues</EM>.
<P>
<em>map</em> contains a value in the range specified with <em>maskvalues</em>.
<p>
Before a new 3D-mask can be created the exisitng mask has to be removed
with <EM>g.remove</EM>.
with <em>g.remove</em>.

<H3>Parameters:</H3>
<DL>
<DT><B>maskvalues</B>
<DD>Values specified to be masked out
<h2>SEE ALSO</h2>

<DT><B>grid3d</B>
<DD>Name of RASTER3D-map that is used as the mask reference
</DL>
<em>
<a href="g.remove.html">g.remove</a>
</em>

<H2>SEE ALSO</H2>

<EM><A HREF="g.remove.html">g.remove</A></EM>

<H2>AUTHORS</H2>
<h2>AUTHORS</h2>
Roman Waupotitsch, Michael Shapiro,
Helena Mitasova, Bill Brown, Lubos Mitas,
Jaro Hofierka
Expand Down
13 changes: 8 additions & 5 deletions raster3d/r3.null/r3.null.html
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
<H2>DESCRIPTION</H2>
<h2>DESCRIPTION</h2>

Modifies the NULL values of a 3D raster map.

Modifies the NULL values of <EM>map</EM>.
<h2>SEE ALSO</h2>

<H2>SEE ALSO</H2>
<EM><A HREF="r.null.html">r.null</A></EM><br>
<em>
<a href="r.null.html">r.null</a>
</em>

<H2>AUTHORS</H2>
<h2>AUTHORS</h2>
Roman Waupotitsch, Michael Shapiro,
Helena Mitasova, Bill Brown, Lubos Mitas,
Jaro Hofierka

<p><i>Last changed: $Date$</i>
Loading

0 comments on commit 4ad8acf

Please sign in to comment.