GRASS Programmer's Manual  6.5.svn(2014)-r66266
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Structures | Functions
N_solute_transport.h File Reference
#include "N_pde.h"
Include dependency graph for N_solute_transport.h:

Go to the source code of this file.

Data Structures

struct  N_solute_transport_data3d
 
struct  N_solute_transport_data2d
 

Functions

N_data_star * N_callback_solute_transport_3d (void *solutedata, N_geom_data *geom, int col, int row, int depth)
 This is just a placeholder. More...
 
N_data_star * N_callback_solute_transport_2d (void *solutedata, N_geom_data *geom, int col, int row)
 This callback function creates the mass balance of a 5 point star. More...
 
N_solute_transport_data3d * N_alloc_solute_transport_data3d (int cols, int rows, int depths)
 Alllocate memory for the solute transport data structure in three dimensions. More...
 
N_solute_transport_data2d * N_alloc_solute_transport_data2d (int cols, int rows)
 Alllocate memory for the solute transport data structure in two dimensions. More...
 
void N_free_solute_transport_data3d (N_solute_transport_data3d *data)
 Release the memory of the solute transport data structure in three dimensions. More...
 
void N_free_solute_transport_data2d (N_solute_transport_data2d *data)
 Release the memory of the solute transport data structure in two dimensions. More...
 
void N_calc_solute_transport_disptensor_2d (N_solute_transport_data2d *data)
 Compute the dispersivity tensor based on the solute transport data in 2d. More...
 
void N_calc_solute_transport_disptensor_3d (N_solute_transport_data3d *data)
 Compute the dispersivity tensor based on the solute transport data in 3d. More...
 
void N_calc_solute_transport_transmission_2d (N_solute_transport_data2d *data)
 Compute the transmission boundary condition in 2d. More...
 
void N_calc_solute_transport_transmission_3d (N_solute_transport_data3d *data)
 

Function Documentation

N_solute_transport_data2d* N_alloc_solute_transport_data2d ( int  cols,
int  rows 
)

Alllocate memory for the solute transport data structure in two dimensions.

The solute transport data structure will be allocated including all appendant 2d arrays. The offset for the 2d 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 solute transport in porous media with the finite volume method.

Parameters
colsint
rowsint
Returns
N_solute_transport_data2d *

Definition at line 491 of file N_solute_transport.c.

References N_solute_transport_data2d::bottom, N_solute_transport_data2d::c, N_solute_transport_data2d::c_start, N_solute_transport_data2d::cin, N_solute_transport_data2d::cs, menudata::data, N_solute_transport_data2d::diff_x, N_solute_transport_data2d::diff_y, N_solute_transport_data2d::disp_xx, N_solute_transport_data2d::disp_xy, N_solute_transport_data2d::disp_yy, N_solute_transport_data2d::grad, N_alloc_array_2d(), N_alloc_gradient_field_2d(), N_UPWIND_EXP, N_solute_transport_data2d::nf, NULL, N_solute_transport_data2d::q, N_solute_transport_data2d::R, N_solute_transport_data2d::stab, N_solute_transport_data2d::status, and N_solute_transport_data2d::top.

N_solute_transport_data3d* N_alloc_solute_transport_data3d ( int  cols,
int  rows,
int  depths 
)

Alllocate memory for the solute transport data structure in three dimensions.

The solute transport data structure will be allocated including all appendant 3d 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 solute transport in porous media with the finite volume method.

Parameters
colsint
rowsint
depthsint
Returns
N_solute_transport_data3d *

Definition at line 436 of file N_solute_transport.c.

References N_solute_transport_data3d::c, N_solute_transport_data3d::c_start, N_solute_transport_data3d::cin, N_solute_transport_data3d::cs, menudata::data, N_solute_transport_data3d::diff_x, N_solute_transport_data3d::diff_y, N_solute_transport_data3d::diff_z, N_solute_transport_data3d::disp_xx, N_solute_transport_data3d::disp_xy, N_solute_transport_data3d::disp_xz, N_solute_transport_data3d::disp_yy, N_solute_transport_data3d::disp_yz, N_solute_transport_data3d::disp_zz, N_solute_transport_data3d::grad, N_alloc_array_3d(), N_alloc_gradient_field_3d(), N_UPWIND_EXP, N_solute_transport_data3d::nf, NULL, N_solute_transport_data3d::q, N_solute_transport_data3d::R, N_solute_transport_data3d::stab, and N_solute_transport_data3d::status.

void N_calc_solute_transport_disptensor_2d ( N_solute_transport_data2d *  data)

Compute the dispersivity tensor based on the solute transport data in 2d.

The dispersivity tensor is stored in the data structure. To compute the dispersivity tensor, the dispersivity lentghs and the gradient field must be present.

This is just a simple tensor computation which should be extended.

Todo:
Change the tensor calculation to a mor realistic algorithm
Parameters
dataN_solute_transport_data2d *
Returns
void *

Definition at line 688 of file N_solute_transport.c.

References N_solute_transport_data2d::al, N_solute_transport_data2d::at, N_gradient_field_2d::cols, dialogs::cols, N_solute_transport_data2d::disp_xx, N_solute_transport_data2d::disp_xy, N_solute_transport_data2d::disp_yy, N_gradient_2d::EC, G_debug(), N_solute_transport_data2d::grad, N_get_gradient_2d(), N_put_array_2d_d_value(), N_gradient_2d::NC, N_gradient_field_2d::rows, N_gradient_2d::SC, and N_gradient_2d::WC.

void N_calc_solute_transport_disptensor_3d ( N_solute_transport_data3d *  data)

Compute the dispersivity tensor based on the solute transport data in 3d.

The dispersivity tensor is stored in the data structure. To compute the dispersivity tensor, the dispersivity lentghs and the gradient field must be present.

This is just a simple tensor computation which should be extended.

Todo:
Change the tensor calculation to a mor realistic algorithm
Parameters
dataN_solute_transport_data3d *
Returns
void *

Definition at line 751 of file N_solute_transport.c.

References N_solute_transport_data3d::al, N_solute_transport_data3d::at, N_gradient_3d::BC, N_gradient_field_3d::cols, dialogs::cols, N_gradient_field_3d::depths, N_solute_transport_data3d::disp_xx, N_solute_transport_data3d::disp_xy, N_solute_transport_data3d::disp_xz, N_solute_transport_data3d::disp_yy, N_solute_transport_data3d::disp_yz, N_solute_transport_data3d::disp_zz, N_gradient_3d::EC, G_debug(), N_solute_transport_data3d::grad, N_get_gradient_3d(), N_put_array_3d_d_value(), N_gradient_3d::NC, N_gradient_field_3d::rows, N_gradient_3d::SC, N_gradient_3d::TC, and N_gradient_3d::WC.

void N_calc_solute_transport_transmission_2d ( N_solute_transport_data2d *  data)

Compute the transmission boundary condition in 2d.

This function calculates the transmission boundary condition for each cell with status N_CELL_TRANSMISSION. The surrounding gradient field is used to verfiy the flow direction. If a flow goes into a cell, the concentration (data->c) from the neighbour cell is added to the transmission cell. If the flow from several neighbour cells goes into the cell, the concentration mean is calculated.

The new concentrations are written into the data->c_start array, so they can be handled by the matrix assembling function.

Parameters
dataN_solute_transport_data2d *
Returns
void *

Definition at line 612 of file N_solute_transport.c.

References N_solute_transport_data2d::c, N_solute_transport_data2d::c_start, N_gradient_field_2d::cols, dialogs::cols, count, N_gradient_2d::EC, G_debug(), N_solute_transport_data2d::grad, N_CELL_TRANSMISSION, N_get_array_2d_d_value(), N_get_gradient_2d(), N_is_array_2d_value_null(), N_put_array_2d_d_value(), N_gradient_2d::NC, N_gradient_field_2d::rows, N_gradient_2d::SC, N_solute_transport_data2d::status, and N_gradient_2d::WC.

void N_calc_solute_transport_transmission_3d ( N_solute_transport_data3d *  data)
N_data_star* N_callback_solute_transport_2d ( void *  solutedata,
N_geom_data *  geom,
int  col,
int  row 
)

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

The mass balance is based on the common solute transport equation:

\[\frac{\partial c_g}{\partial t} R = \nabla \cdot ({\bf D} \nabla c_g - {\bf u} c_g) + \sigma + \frac{q}{n_f}(c_g - c_in) \]

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

Parameters
solutedata* N_solute_transport_data2d - a void pointer to the data structure
geomN_geom_data *
colint
rowint
Returns
N_data_star * - a five point data star

Definition at line 198 of file N_solute_transport.c.

References N_solute_transport_data2d::bottom, C, N_solute_transport_data2d::c, N_solute_transport_data2d::c_start, N_solute_transport_data2d::cin, N_solute_transport_data2d::cs, menudata::data, N_solute_transport_data2d::diff_x, N_solute_transport_data2d::diff_y, N_solute_transport_data2d::disp_xx, N_solute_transport_data2d::disp_yy, N_solute_transport_data2d::dt, N_geom_data::dx, N_geom_data::dy, N_gradient_2d::EC, G_debug(), N_solute_transport_data2d::grad, N, N_calc_geom_mean(), N_calc_harmonic_mean(), N_CELL_TRANSMISSION, N_create_9star(), N_exp_upwinding(), N_full_upwinding(), N_get_array_2d_d_value(), N_get_geom_data_area_of_cell(), N_get_gradient_2d(), N_UPWIND_EXP, N_UPWIND_FULL, N_gradient_2d::NC, NE, N_solute_transport_data2d::nf, NULL, NW, N_solute_transport_data2d::q, forms::q, N_solute_transport_data2d::R, N_gradient_2d::SC, SE, N_solute_transport_data2d::stab, N_solute_transport_data2d::status, SW, N_solute_transport_data2d::top, and N_gradient_2d::WC.

N_data_star* N_callback_solute_transport_3d ( void *  solutedata,
N_geom_data *  geom,
int  col,
int  row,
int  depth 
)

This is just a placeholder.

Definition at line 28 of file N_solute_transport.c.

References N_gradient_3d::BC, C, N_solute_transport_data3d::c, N_solute_transport_data3d::c_start, N_solute_transport_data3d::cin, N_solute_transport_data3d::cs, menudata::data, N_solute_transport_data3d::diff_x, N_solute_transport_data3d::diff_y, N_solute_transport_data3d::diff_z, N_solute_transport_data3d::dt, N_geom_data::dx, N_geom_data::dy, N_geom_data::dz, N_gradient_3d::EC, G_debug(), N_solute_transport_data3d::grad, N, N_calc_harmonic_mean(), N_create_7star(), N_exp_upwinding(), N_get_array_3d_d_value(), N_get_geom_data_area_of_cell(), N_get_gradient_3d(), N_gradient_3d::NC, N_solute_transport_data3d::nf, NULL, N_solute_transport_data3d::q, forms::q, N_solute_transport_data3d::R, N_gradient_3d::SC, N_gradient_3d::TC, and N_gradient_3d::WC.

void N_free_solute_transport_data2d ( N_solute_transport_data2d *  data)

Release the memory of the solute transport data structure in two dimensions.

Parameters
dataN_solute_transport_data2d *
Returns
void *

Definition at line 570 of file N_solute_transport.c.

References N_solute_transport_data2d::bottom, N_solute_transport_data2d::c, N_solute_transport_data2d::c_start, N_solute_transport_data2d::cin, N_solute_transport_data2d::cs, N_solute_transport_data2d::diff_x, N_solute_transport_data2d::diff_y, N_solute_transport_data2d::disp_xx, N_solute_transport_data2d::disp_xy, N_solute_transport_data2d::disp_yy, G_free(), N_free_array_2d(), N_solute_transport_data2d::nf, NULL, N_solute_transport_data2d::q, N_solute_transport_data2d::R, N_solute_transport_data2d::status, and N_solute_transport_data2d::top.

void N_free_solute_transport_data3d ( N_solute_transport_data3d *  data)

Release the memory of the solute transport data structure in three dimensions.

Parameters
dataN_solute_transport_data2d *
Returns
void *

Definition at line 533 of file N_solute_transport.c.

References N_solute_transport_data3d::c, N_solute_transport_data3d::c_start, N_solute_transport_data3d::cin, N_solute_transport_data3d::cs, N_solute_transport_data3d::diff_x, N_solute_transport_data3d::diff_y, N_solute_transport_data3d::diff_z, N_solute_transport_data3d::disp_xx, N_solute_transport_data3d::disp_xy, N_solute_transport_data3d::disp_xz, N_solute_transport_data3d::disp_yy, N_solute_transport_data3d::disp_yz, N_solute_transport_data3d::disp_zz, G_free(), N_free_array_3d(), N_solute_transport_data3d::nf, NULL, N_solute_transport_data3d::q, N_solute_transport_data3d::R, and N_solute_transport_data3d::status.