GRASS GIS 7 Programmer's Manual  7.5.svn(2017)-r71790
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
n_gwflow.c File Reference
#include <grass/N_gwflow.h>
Include dependency graph for n_gwflow.c:

Go to the source code of this file.

Functions

N_gwflow_data3dN_alloc_gwflow_data3d (int cols, int rows, int depths, int river, int drain)
 Alllocate memory for the groundwater calculation data structure in 3 dimensions. More...
 
void N_free_gwflow_data3d (N_gwflow_data3d *data)
 Release the memory of the groundwater flow data structure in three dimensions. More...
 
N_gwflow_data2dN_alloc_gwflow_data2d (int cols, int rows, int river, int drain)
 Alllocate memory for the groundwater calculation data structure in 2 dimensions. More...
 
void N_free_gwflow_data2d (N_gwflow_data2d *data)
 Release the memory of the groundwater flow data structure in two dimensions. More...
 
N_data_starN_callback_gwflow_3d (void *gwdata, N_geom_data *geom, int col, int row, int depth)
 This callback function creates the mass balance of a 7 point star. More...
 
void N_gwflow_3d_calc_water_budget (N_gwflow_data3d *data, N_geom_data *geom, N_array_3d *budget)
 This function computes the water budget of the entire groundwater. More...
 
N_data_starN_callback_gwflow_2d (void *gwdata, N_geom_data *geom, int col, int row)
 This callback function creates the mass balance of a 5 point star. More...
 
void N_gwflow_2d_calc_water_budget (N_gwflow_data2d *data, N_geom_data *geom, N_array_2d *budget)
 This function computes the water budget of the entire groundwater. More...
 

Function Documentation

N_gwflow_data2d* N_alloc_gwflow_data2d ( int  cols,
int  rows,
int  river,
int  drain 
)

Alllocate memory for the groundwater calculation data structure in 2 dimensions.

The groundwater calculation data structure will be allocated including all appendant 2d arrays. The offset for the 3d arrays is one to establish homogeneous Neumann boundary conditions at the calculation area border. This data structure is used to create a linear equation system based on the computation of groundwater flow in porous media with the finite volume method.

Parameters
colsint
rowsint
Returns
N_gwflow_data2d *

Definition at line 148 of file n_gwflow.c.

References N_gwflow_data2d::bottom, CELL_TYPE, DCELL_TYPE, N_gwflow_data2d::drain_bed, N_gwflow_data2d::drain_leak, N_gwflow_data2d::hc_x, N_gwflow_data2d::hc_y, N_alloc_array_2d(), N_gwflow_data2d::nf, NULL, N_gwflow_data2d::phead, N_gwflow_data2d::phead_start, N_gwflow_data2d::q, N_gwflow_data2d::r, N_gwflow_data2d::river_bed, N_gwflow_data2d::river_head, N_gwflow_data2d::river_leak, N_gwflow_data2d::s, N_gwflow_data2d::status, and N_gwflow_data2d::top.

N_gwflow_data3d* N_alloc_gwflow_data3d ( int  cols,
int  rows,
int  depths,
int  river,
int  drain 
)

Alllocate memory for the groundwater calculation data structure in 3 dimensions.

The groundwater calculation data structure will be allocated including all appendant 3d and 2d arrays. The offset for the 3d arrays is one to establish homogeneous Neumann boundary conditions at the calculation area border. This data structure is used to create a linear equation system based on the computation of groundwater flow in porous media with the finite volume method.

Parameters
colsint
rowsint
depthsint
Returns
N_gwflow_data3d *

Definition at line 38 of file n_gwflow.c.

References DCELL_TYPE, N_gwflow_data3d::drain_bed, N_gwflow_data3d::drain_leak, N_gwflow_data3d::hc_x, N_gwflow_data3d::hc_y, N_gwflow_data3d::hc_z, N_alloc_array_2d(), N_alloc_array_3d(), N_gwflow_data3d::nf, NULL, N_gwflow_data3d::phead, N_gwflow_data3d::phead_start, N_gwflow_data3d::q, N_gwflow_data3d::r, N_gwflow_data3d::river_bed, N_gwflow_data3d::river_head, N_gwflow_data3d::river_leak, N_gwflow_data3d::s, and N_gwflow_data3d::status.

N_data_star* N_callback_gwflow_2d ( void *  gwdata,
N_geom_data geom,
int  col,
int  row 
)
N_data_star* N_callback_gwflow_3d ( void *  gwdata,
N_geom_data geom,
int  col,
int  row,
int  depth 
)

This callback function creates the mass balance of a 7 point star.

The mass balance is based on the common groundwater flow equation:

\[Ss \frac{\partial h}{\partial t} = \nabla {\bf K} \nabla h + q \]

This equation is discretizised with the finite volume method in three dimensions.

Parameters
gwdataN_gwflow_data3d *
geomN_geom_data *
colint
rowint
depthint
Returns
N_data_star *

Definition at line 263 of file n_gwflow.c.

References N_geom_data::depths, N_gwflow_data3d::dt, N_geom_data::dx, N_geom_data::dy, N_geom_data::dz, G_debug(), N_gwflow_data3d::hc_x, N_gwflow_data3d::hc_y, N_gwflow_data3d::hc_z, N, N_calc_harmonic_mean(), N_create_7star(), N_get_array_2d_d_value(), N_get_array_3d_d_value(), N_get_geom_data_area_of_cell(), N_gwflow_data3d::nf, N_gwflow_data3d::phead_start, N_gwflow_data3d::q, r, N_gwflow_data3d::r, N_gwflow_data3d::s, and W.

Referenced by N_gwflow_3d_calc_water_budget().

void N_gwflow_2d_calc_water_budget ( N_gwflow_data2d data,
N_geom_data geom,
N_array_2d budget 
)

This function computes the water budget of the entire groundwater.

The water budget is calculated for each active and dirichlet cell from its surrounding neighbours. This is based on the 5 star mass balance computation of N_callback_gwflow_2d and the gradient of the water heights in the cells. The sum of the water budget of each active/dirichlet cell must be near zero due the effect of numerical inaccuracy of cpu's.

Parameters
gwdataN_gwflow_data2d *
geomN_geom_data *
budgetN_array_2d
Returns
void

Definition at line 659 of file n_gwflow.c.

References _, N_array_2d::cols, Cell_head::cols, DCELL_TYPE, N_data_star::E, G_free(), G_message(), G_percent(), G_warning(), N_data_star::N, N_callback_gwflow_2d(), N_CELL_INACTIVE, N_get_array_2d_c_value(), N_get_array_2d_d_value(), N_put_array_2d_d_value(), N_gwflow_data2d::phead, Rast_set_null_value(), N_array_2d::rows, Cell_head::rows, N_data_star::S, N_gwflow_data2d::status, N_data_star::W, and x.

void N_gwflow_3d_calc_water_budget ( N_gwflow_data3d data,
N_geom_data geom,
N_array_3d budget 
)

This function computes the water budget of the entire groundwater.

The water budget is calculated for each active and dirichlet cell from its surrounding neighbours. This is based on the 7 star mass balance computation of N_callback_gwflow_3d and the gradient of the water heights in the cells. The sum of the water budget of each active/dirichlet cell must be near zero due the effect of numerical inaccuracy of cpu's.

Parameters
gwdataN_gwflow_data3d *
geomN_geom_data *
budgetN_array_3d
Returns
void

Definition at line 371 of file n_gwflow.c.

References _, N_data_star::B, N_array_3d::cols, Cell_head::cols, DCELL_TYPE, N_array_3d::depths, Cell_head::depths, N_data_star::E, G_free(), G_message(), G_percent(), G_warning(), int, N_data_star::N, N_callback_gwflow_3d(), N_CELL_INACTIVE, N_get_array_3d_d_value(), N_put_array_3d_d_value(), N_gwflow_data3d::phead, Rast_set_null_value(), N_array_3d::rows, Cell_head::rows, N_data_star::S, N_gwflow_data3d::status, N_data_star::T, N_data_star::W, and x.