![]() |
programmer's documentation
|
Set main parameters for the current simulation when the CDO kernel is used. More...
#include "cs_defs.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <bft_mem.h>
#include <bft_printf.h>
#include "cs_domain.h"
#include "cs_prototypes.h"
Functions | |
int | cs_user_cdo_activated (void) |
Activate or not the CDO module. More... | |
void | cs_user_cdo_add_mesh_locations (void) |
Specify additional mesh locations. More... | |
void | cs_user_cdo_init_setup (cs_domain_t *domain) |
Specify for the computational domain: – which type of boundaries closed the computational domain – the settings for the time step – activate predefined equations or modules – add user-defined properties and/or advection fields – add user-defined equations. More... | |
void | cs_user_cdo_setup_gwf (cs_domain_t *domain) |
Specify for each soil and tracer how is defined each term of the the tracer equation. Soils and tracer equations have to be added previously. More... | |
void | cs_user_cdo_finalize_setup (cs_domain_t *domain) |
| |
void | cs_user_gwf_get_soil_density (const cs_gwf_soil_t *soil, cs_real_t *density) |
Retrieve the bulk density related to a soil structure. More... | |
Set main parameters for the current simulation when the CDO kernel is used.
int cs_user_cdo_activated | ( | void | ) |
Activate or not the CDO module.
(end ignore by Doxygen)
void cs_user_cdo_add_mesh_locations | ( | void | ) |
Specify additional mesh locations.
void cs_user_cdo_finalize_setup | ( | cs_domain_t * | domain | ) |
After the first step: cs_user_cdo_init_setup(), this second step concludes the setup of properties, equations, source terms... At this step, mesh quantities and connectivities are build as well as the field arrays.
[in,out] | domain | pointer to a cs_domain_t structure |
void cs_user_cdo_init_setup | ( | cs_domain_t * | domain | ) |
Specify for the computational domain: – which type of boundaries closed the computational domain – the settings for the time step – activate predefined equations or modules – add user-defined properties and/or advection fields – add user-defined equations.
Start setting up the computational domain:
[in,out] | domain | pointer to a cs_domain_t structure |
void cs_user_cdo_setup_gwf | ( | cs_domain_t * | domain | ) |
Specify for each soil and tracer how is defined each term of the the tracer equation. Soils and tracer equations have to be added previously.
[in,out] | domain | pointer to a cs_domain_t structure |
void cs_user_gwf_get_soil_density | ( | const cs_gwf_soil_t * | soil, |
cs_real_t * | density | ||
) |
Retrieve the bulk density related to a soil structure.
[in] | soil | pointer to a cs_gwf_soil_t structure |
[out] | density | return value for the density |