OilfieldToolsNet/opm-core
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Split a few long lines in allocate_grid() documentation.

Browse Source
This commit is contained in:
Bård Skaflestad 2012-06-11 17:54:56 +02:00
parent 6f8dc0e0dc
commit bf0e469cf5
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
opm/core/grid.h
View File

@ -250,18 +250,20 @@ struct UnstructuredGrid *
create_grid_empty(void);
/**
Allocate and initialise an UnstructuredGrid where pointers are set to
location with correct size.
Allocate and initialise an UnstructuredGrid where pointers are set
to location with correct size.
\param[in] ndims Number of physical dimensions.
\param[in] ncells Number of cells.
\param[in] nfaces Number of faces.
\param[in] nfacenodes Size of mapping from faces to nodes.
\param[in] ncellfaces Size of mapping from cells to faces.(i.e Number of halffaces)
\param[in] nnodes Number of Nodes
\return Fully formed UnstructuredGrid with all fields allocated, but not filled with
usefull numbers.
<code>NULL</code> in case of allocation failure.
\param[in] ncellfaces Size of mapping from cells to faces.
(i.e., the number of `half-faces')
\param[in] nnodes Number of Nodes.
\return Fully formed UnstructuredGrid with all fields allocated,
but not filled with usefull numbers. <code>NULL</code> in case of
allocation failure.
*/
struct UnstructuredGrid *
allocate_grid(size_t ndims ,