programmer's documentation
Functions
cs_cdovb_vecteq.h File Reference
#include "cs_base.h"
#include "cs_cdo_connect.h"
#include "cs_cdo_local.h"
#include "cs_cdo_quantities.h"
#include "cs_cdovb_priv.h"
#include "cs_equation_common.h"
#include "cs_equation_param.h"
#include "cs_field.h"
#include "cs_matrix.h"
#include "cs_mesh.h"
#include "cs_source_term.h"
#include "cs_time_step.h"
Include dependency graph for cs_cdovb_vecteq.h:

Go to the source code of this file.

Functions

bool cs_cdovb_vecteq_is_initialized (void)
 Check if the generic structures for building a CDO-Vb scheme are allocated. More...
 
void cs_cdovb_vecteq_init_common (const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step, const cs_matrix_structure_t *ms)
 Allocate work buffer and general structures related to CDO vertex-based schemes Set shared pointers. More...
 
void cs_cdovb_vecteq_get (cs_cell_sys_t **csys, cs_cell_builder_t **cb)
 Retrieve work buffers used for building a CDO system cellwise. More...
 
void cs_cdovb_vecteq_finalize_common (void)
 Free work buffer and general structure related to CDO vertex-based schemes. More...
 
void * cs_cdovb_vecteq_init_context (const cs_equation_param_t *eqp, cs_equation_builder_t *eqb)
 Initialize a cs_cdovb_vecteq_t structure storing data useful for managing such a scheme. More...
 
void * cs_cdovb_vecteq_free_context (void *builder)
 Destroy a cs_cdovb_vecteq_t structure. More...
 
void cs_cdovb_vecteq_compute_source (const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
 Compute the contributions of source terms (store inside builder) More...
 
void cs_cdovb_vecteq_initialize_system (const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_matrix_t **system_matrix, cs_real_t **system_rhs)
 Create the matrix of the current algebraic system. Allocate and initialize the right-hand side associated to the given builder structure. More...
 
void cs_cdovb_vecteq_build_system (const cs_mesh_t *mesh, const cs_real_t *field_val, double dt_cur, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_real_t *rhs, cs_matrix_t *matrix)
 Build the linear system arising from a scalar convection/diffusion equation with a CDO vertex-based scheme. One works cellwise and then process to the assembly. More...
 
void cs_cdovb_vecteq_update_field (const cs_real_t *solu, const cs_real_t *rhs, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_real_t *field_val)
 Store solution(s) of the linear system into a field structure Update extra-field values if required (for hybrid discretization) More...
 
void cs_cdovb_vecteq_compute_flux_across_plane (const cs_real_t normal[], const cs_real_t *pdi, int ml_id, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, double *d_flux, double *c_flux)
 Compute the diffusive and convective flux across a list of faces. More...
 
void cs_cdovb_vecteq_cellwise_diff_flux (const cs_real_t *values, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_flag_t location, cs_real_t *diff_flux)
 Cellwise computation of the diffusive flux. More...
 
void cs_cdovb_vecteq_extra_op (const char *eqname, const cs_field_t *field, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
 Predefined extra-operations related to this equation. More...
 

Function Documentation

◆ cs_cdovb_vecteq_build_system()

void cs_cdovb_vecteq_build_system ( const cs_mesh_t mesh,
const cs_real_t field_val,
double  dt_cur,
const cs_equation_param_t eqp,
cs_equation_builder_t eqb,
void *  data,
cs_real_t rhs,
cs_matrix_t matrix 
)

Build the linear system arising from a scalar convection/diffusion equation with a CDO vertex-based scheme. One works cellwise and then process to the assembly.

Parameters
[in]meshpointer to a cs_mesh_t structure
[in]field_valpointer to the current value of the vertex field
[in]dt_curcurrent value of the time step
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
[in,out]datapointer to cs_cdovcb_vecteq_t structure
[in,out]rhsright-hand side
[in,out]matrixpointer to cs_matrix_t structure to compute

◆ cs_cdovb_vecteq_cellwise_diff_flux()

void cs_cdovb_vecteq_cellwise_diff_flux ( const cs_real_t values,
const cs_equation_param_t eqp,
cs_equation_builder_t eqb,
void *  data,
cs_flag_t  location,
cs_real_t diff_flux 
)

Cellwise computation of the diffusive flux.

Parameters
[in]valuesdiscrete values for the potential
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
[in,out]datapointer to cs_cdovb_vecteq_t structure
[in,out]locationwhere the flux is defined
[in,out]diff_fluxvalue of the diffusive flux

◆ cs_cdovb_vecteq_compute_flux_across_plane()

void cs_cdovb_vecteq_compute_flux_across_plane ( const cs_real_t  normal[],
const cs_real_t pdi,
int  ml_id,
const cs_equation_param_t eqp,
cs_equation_builder_t eqb,
void *  data,
double *  d_flux,
double *  c_flux 
)

Compute the diffusive and convective flux across a list of faces.

Parameters
[in]normalindicate in which direction flux is > 0
[in]pdipointer to an array of field values
[in]ml_idid related to a cs_mesh_location_t struct.
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
[in,out]datapointer to data specific for this scheme
[in,out]d_fluxpointer to the value of the diffusive flux
[in,out]c_fluxpointer to the value of the convective flux

◆ cs_cdovb_vecteq_compute_source()

void cs_cdovb_vecteq_compute_source ( const cs_equation_param_t eqp,
cs_equation_builder_t eqb,
void *  data 
)

Compute the contributions of source terms (store inside builder)

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
[in,out]datapointer to cs_cdovb_vecteq_t structure

◆ cs_cdovb_vecteq_extra_op()

void cs_cdovb_vecteq_extra_op ( const char *  eqname,
const cs_field_t field,
const cs_equation_param_t eqp,
cs_equation_builder_t eqb,
void *  data 
)

Predefined extra-operations related to this equation.

Parameters
[in]eqnamename of the equation
[in]fieldpointer to a field structure
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
[in,out]datapointer to cs_cdovb_vecteq_t structure

◆ cs_cdovb_vecteq_finalize_common()

void cs_cdovb_vecteq_finalize_common ( void  )

Free work buffer and general structure related to CDO vertex-based schemes.

◆ cs_cdovb_vecteq_free_context()

void* cs_cdovb_vecteq_free_context ( void *  builder)

Destroy a cs_cdovb_vecteq_t structure.

Parameters
[in,out]builderpointer to a cs_cdovb_vecteq_t structure
Returns
a NULL pointer

◆ cs_cdovb_vecteq_get()

void cs_cdovb_vecteq_get ( cs_cell_sys_t **  csys,
cs_cell_builder_t **  cb 
)

Retrieve work buffers used for building a CDO system cellwise.

Parameters
[out]csyspointer to a pointer on a cs_cell_sys_t structure
[out]cbpointer to a pointer on a cs_cell_builder_t structure

◆ cs_cdovb_vecteq_init_common()

void cs_cdovb_vecteq_init_common ( const cs_cdo_quantities_t quant,
const cs_cdo_connect_t connect,
const cs_time_step_t time_step,
const cs_matrix_structure_t ms 
)

Allocate work buffer and general structures related to CDO vertex-based schemes Set shared pointers.

Parameters
[in]quantadditional mesh quantities struct.
[in]connectpointer to a cs_cdo_connect_t struct.
[in]time_steppointer to a time step structure
[in]mspointer to a cs_matrix_structure_t structure

◆ cs_cdovb_vecteq_init_context()

void* cs_cdovb_vecteq_init_context ( const cs_equation_param_t eqp,
cs_equation_builder_t eqb 
)

Initialize a cs_cdovb_vecteq_t structure storing data useful for managing such a scheme.

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
Returns
a pointer to a new allocated cs_cdovb_vecteq_t structure

◆ cs_cdovb_vecteq_initialize_system()

void cs_cdovb_vecteq_initialize_system ( const cs_equation_param_t eqp,
cs_equation_builder_t eqb,
void *  data,
cs_matrix_t **  system_matrix,
cs_real_t **  system_rhs 
)

Create the matrix of the current algebraic system. Allocate and initialize the right-hand side associated to the given builder structure.

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
[in,out]datapointer to cs_cdovb_vecteq_t structure
[in,out]system_matrixpointer of pointer to a cs_matrix_t struct.
[in,out]system_rhspointer of pointer to an array of double

◆ cs_cdovb_vecteq_is_initialized()

bool cs_cdovb_vecteq_is_initialized ( void  )

Check if the generic structures for building a CDO-Vb scheme are allocated.

Returns
true or false

◆ cs_cdovb_vecteq_update_field()

void cs_cdovb_vecteq_update_field ( const cs_real_t solu,
const cs_real_t rhs,
const cs_equation_param_t eqp,
cs_equation_builder_t eqb,
void *  data,
cs_real_t field_val 
)

Store solution(s) of the linear system into a field structure Update extra-field values if required (for hybrid discretization)

Parameters
[in]solusolution array
[in]rhsrhs associated to this solution array
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
[in,out]datapointer to cs_cdovb_vecteq_t structure
[in,out]field_valpointer to the current value of the field