programmer's documentation
Macros | Functions | Variables
cs_cdofb_scaleq.c File Reference
#include "cs_defs.h"
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
#include <float.h>
#include <assert.h>
#include <string.h>
#include "bft_mem.h"
#include "bft_printf.h"
#include "cs_cdo_bc.h"
#include "cs_equation_common.h"
#include "cs_hodge.h"
#include "cs_log.h"
#include "cs_math.h"
#include "cs_post.h"
#include "cs_quadrature.h"
#include "cs_search.h"
#include "cs_source_term.h"
#include "cs_cdofb_scaleq.h"
Include dependency graph for cs_cdofb_scaleq.c:

Macros

#define CDOFB_SCALEQ_DBG   0
 

Functions

static cs_sla_matrix_t_init_diffusion_matrix (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant)
 Allocate and initialize the matrix related to the diffusion op. Note: values are filled in a second step. More...
 
static cs_sla_matrix_t_build_diffusion_system (const cs_mesh_t *m, cs_real_t *rhs, cs_cdofb_scaleq_t *builder)
 Define the final (reduced) matrix for diffusion and its right hand side (RHS). RHS is the sum of three contributions. More...
 
void cs_cdofb_scaleq_set_shared_pointers (const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step)
 Set shared pointers from the main domain members. More...
 
void cs_cdofb_scaleq_initialize (void)
 Allocate work buffer and general structures related to CDO face-based schemes. More...
 
void cs_cdofb_scaleq_finalize (void)
 Free work buffer and general structure related to CDO face-based schemes. More...
 
void * cs_cdofb_scaleq_init (const cs_equation_param_t *eqp, const cs_mesh_t *mesh)
 Initialize a cs_cdofb_scaleq_t structure. More...
 
void * cs_cdofb_scaleq_free (void *builder)
 Destroy a cs_cdofb_scaleq_t structure. More...
 
void cs_cdofb_scaleq_free_sysmat (void *builder, cs_sla_matrix_t *matrix)
 Destroy a cs_sla_matrix_t related to the system to solve. More...
 
void cs_cdofb_scaleq_compute_source (void *builder)
 Compute the contributions of source terms (store inside builder) More...
 
void cs_cdofb_scaleq_build_system (const cs_mesh_t *mesh, const cs_real_t *field_val, double dt_cur, void *builder, cs_real_t **rhs, cs_sla_matrix_t **sla_mat)
 Build the linear system arising from a scalar convection/diffusion equation with a CDO face-based scheme. More...
 
void cs_cdofb_scaleq_update_field (const cs_real_t *solu, const cs_real_t *rhs, void *builder, 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_cdofb_scaleq_extra_op (const char *eqname, const cs_field_t *field, void *builder)
 Predefined extra-operations related to this equation. More...
 
double * cs_cdofb_scaleq_get_face_values (const void *builder)
 Get the computed values at each face. More...
 

Variables

static const cs_cdo_quantities_tcs_shared_quant
 
static const cs_cdo_connect_tcs_shared_connect
 
static const cs_time_step_tcs_shared_time_step
 

Macro Definition Documentation

◆ CDOFB_SCALEQ_DBG

#define CDOFB_SCALEQ_DBG   0

Function Documentation

◆ _build_diffusion_system()

static cs_sla_matrix_t* _build_diffusion_system ( const cs_mesh_t m,
cs_real_t rhs,
cs_cdofb_scaleq_t *  builder 
)
static

Define the final (reduced) matrix for diffusion and its right hand side (RHS). RHS is the sum of three contributions.

  • Source terms
  • Neumann boundary conditions
  • Dirichlet boundary conditions
Parameters
[in]mpointer to a cs_mesh_t structure
[in,out]rhsright-hand side
[in,out]builderpointer to a cs_cdofb_scaleq_t struct.
Returns
a pointer to the full stiffness matrix

◆ _init_diffusion_matrix()

static cs_sla_matrix_t* _init_diffusion_matrix ( const cs_cdo_connect_t connect,
const cs_cdo_quantities_t quant 
)
static

Allocate and initialize the matrix related to the diffusion op. Note: values are filled in a second step.

Parameters
[in]connectpointer to a cs_cdo_connect_t structure
[in]quantpointer to a cs_cdo_quantities_t structure
Returns
a pointer to a cs_sla_matrix_t structure

◆ cs_cdofb_scaleq_build_system()

void cs_cdofb_scaleq_build_system ( const cs_mesh_t mesh,
const cs_real_t field_val,
double  dt_cur,
void *  builder,
cs_real_t **  rhs,
cs_sla_matrix_t **  sla_mat 
)

Build the linear system arising from a scalar convection/diffusion equation with a CDO face-based scheme.

Parameters
[in]meshpointer to a cs_mesh_t structure
[in]field_valpointer to the current value of the field
[in]dt_curcurrent value of the time step
[in,out]builderpointer to cs_cdofb_scaleq_t structure
[in,out]rhspointer to a right-hand side array pointer
[in,out]sla_matpointer to cs_sla_matrix_t structure pointer

◆ cs_cdofb_scaleq_compute_source()

void cs_cdofb_scaleq_compute_source ( void *  builder)

Compute the contributions of source terms (store inside builder)

Parameters
[in,out]builderpointer to a cs_cdofb_scaleq_t structure

◆ cs_cdofb_scaleq_extra_op()

void cs_cdofb_scaleq_extra_op ( const char *  eqname,
const cs_field_t field,
void *  builder 
)

Predefined extra-operations related to this equation.

Parameters
[in]eqnamename of the equation
[in]fieldpointer to a field strufcture
[in,out]builderpointer to builder structure

◆ cs_cdofb_scaleq_finalize()

void cs_cdofb_scaleq_finalize ( void  )

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

◆ cs_cdofb_scaleq_free()

void* cs_cdofb_scaleq_free ( void *  builder)

Destroy a cs_cdofb_scaleq_t structure.

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

◆ cs_cdofb_scaleq_free_sysmat()

void cs_cdofb_scaleq_free_sysmat ( void *  builder,
cs_sla_matrix_t matrix 
)

Destroy a cs_sla_matrix_t related to the system to solve.

Parameters
[in,out]builderpointer to a builder structure
[in,out]matrixpointer to a cs_sla_matrix_t structure

◆ cs_cdofb_scaleq_get_face_values()

double* cs_cdofb_scaleq_get_face_values ( const void *  builder)

Get the computed values at each face.

Parameters
[in]builderpointer to a cs_cdofb_scaleq_t structure
Returns
a pointer to an array of double (size n_faces)

◆ cs_cdofb_scaleq_init()

void* cs_cdofb_scaleq_init ( const cs_equation_param_t eqp,
const cs_mesh_t mesh 
)

Initialize a cs_cdofb_scaleq_t structure.

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in]meshpointer to a cs_mesh_t structure
Returns
a pointer to a new allocated cs_cdofb_scaleq_t structure

◆ cs_cdofb_scaleq_initialize()

void cs_cdofb_scaleq_initialize ( void  )

Allocate work buffer and general structures related to CDO face-based schemes.

◆ cs_cdofb_scaleq_set_shared_pointers()

void cs_cdofb_scaleq_set_shared_pointers ( const cs_cdo_quantities_t quant,
const cs_cdo_connect_t connect,
const cs_time_step_t time_step 
)

Set shared pointers from the main domain members.

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

◆ cs_cdofb_scaleq_update_field()

void cs_cdofb_scaleq_update_field ( const cs_real_t solu,
const cs_real_t rhs,
void *  builder,
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,out]builderpointer to cs_cdovb_scaleq_t structure
[in,out]field_valpointer to the current value of the field

Variable Documentation

◆ cs_shared_connect

const cs_cdo_connect_t* cs_shared_connect
static

◆ cs_shared_quant

const cs_cdo_quantities_t* cs_shared_quant
static

◆ cs_shared_time_step

const cs_time_step_t* cs_shared_time_step
static